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