ConnectionFactory.java

/*
 * Copyright 2008 Alin Dreghiciu.
 *
 * Licensed  under the  Apache License,  Version 2.0  (the "License");
 * you may not use  this file  except in  compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed  under the  License is distributed on an "AS IS" BASIS,
 * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
 * implied.
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ops4j.pax.url.commons.handler;

import java.io.IOException;
import java.net.URL;
import java.net.URLConnection;

import org.ops4j.util.property.PropertyResolver;
import org.osgi.framework.BundleContext;

/**
 * URL connection factory.
 *
 * @author Alin Dreghiciu
 * @since 0.1.0, January 13, 2008
 */
public interface ConnectionFactory<T>
{

    /**
     * Creates a handler specific connection.
     *
     * @param bundleContext bundle context
     * @param url           url to be handled
     * @param config        protocol specific configuration
     *
     * @return URLConnection protocol specific connection
     *
     * @throws IOException if a malformed url is encountered. Protocol specific.
     */
    URLConnection createConnection( BundleContext bundleContext, URL url, T config )
        throws IOException;

    /**
     * Creates a handler specific configuration. Returns null if there is
     * insufficient configuration information in the resolver.
     *
     * @param propertyResolver configuration propertyResolver
     *
     * @return T protocol specific configuration or null
     */
    T createConfiguration( PropertyResolver propertyResolver );

}