001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.mail;
018
019import javax.activation.DataSource;
020import java.io.IOException;
021
022/**
023 * Creates a <code>DataSource</code> based on an URL.
024 *
025 * @since 1.3
026 * @version $Id: DataSourceResolver.html 952467 2015-05-23 18:45:36Z tn $
027 */
028public interface DataSourceResolver
029{
030    /**
031     * Resolves the given resource location to a <code>DataSource</code>.
032     *
033     * @param resourceLocation the location of the resource
034     * @return the <code>DataSource</code>
035     * @throws IOException the resource was not found
036     */
037    DataSource resolve(final String resourceLocation) throws IOException;
038
039    /**
040     * Resolves the given resource location to a <code>DataSource</code>.
041     *
042     * @param resourceLocation the location of the resource
043     * @param isLenient shall we ignore resources not found or complain with an exception?
044     * @return the data source containing the resource or null if the resource was not found in lenient mode
045     * @throws IOException resolving the resource failed
046     */
047    DataSource resolve(final String resourceLocation, final boolean isLenient)
048        throws IOException;
049}