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.javax;
18  
19  import java.io.IOException;
20  
21  import javax.activation.DataSource;
22  
23  /**
24   * Creates a {@code DataSource} based on an URL.
25   *
26   * @since 1.3
27   */
28  public interface DataSourceResolver {
29  
30      /**
31       * Resolves the given resource location to a {@code DataSource}.
32       *
33       * @param resourceLocation the location of the resource
34       * @return the {@code DataSource}
35       * @throws IOException the resource was not found
36       */
37      DataSource resolve(String resourceLocation) throws IOException;
38  
39      /**
40       * Resolves the given resource location to a {@code DataSource}.
41       *
42       * @param resourceLocation the location of the resource
43       * @param isLenient        shall we ignore resources not found or complain with an exception?
44       * @return the data source containing the resource or null if the resource was not found in lenient mode
45       * @throws IOException resolving the resource failed
46       */
47      DataSource resolve(String resourceLocation, boolean isLenient) throws IOException;
48  }