View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.mail2.jakarta.resolver;
18  
19  import org.apache.commons.mail2.jakarta.DataSourceResolver;
20  
21  /**
22   * Abstract class for resolvers.
23   *
24   * @since 1.3
25   */
26  public abstract class DataSourceBaseResolver implements DataSourceResolver {
27  
28      /** Whether to ignore resources not found or complain with an exception. */
29      private final boolean lenient;
30  
31      /**
32       * Constructs a new instance.
33       */
34      public DataSourceBaseResolver() {
35          this.lenient = false;
36      }
37  
38      /**
39       * Constructs a new instance.
40       *
41       * @param lenient shall we ignore resources not found or throw an exception?
42       */
43      public DataSourceBaseResolver(final boolean lenient) {
44          this.lenient = lenient;
45      }
46  
47      /**
48       * Tests whether the argument is a content id.
49       *
50       * @param resourceLocation the resource location to test.
51       * @return true if it is a CID.
52       */
53      protected boolean isCid(final String resourceLocation) {
54          return resourceLocation.startsWith("cid:");
55      }
56  
57      /**
58       * Tests whether this a file URL.
59       *
60       * @param urlString the URL string.
61       * @return true if it is a file URL.
62       */
63      protected boolean isFileUrl(final String urlString) {
64          return urlString.startsWith("file:/");
65      }
66  
67      /**
68       * Tests whether this a HTTP or HTTPS URL.
69       *
70       * @param urlString the URL string to test.
71       * @return true if it is a HTTP or HTTPS URL.
72       */
73      protected boolean isHttpUrl(final String urlString) {
74          return urlString.startsWith("http://") || urlString.startsWith("https://");
75      }
76  
77      /**
78       * Tests whether to ignore resources not found or throw an exception.
79       *
80       * @return the lenient flag.
81       */
82      public boolean isLenient() {
83          return lenient;
84      }
85  }