org.apache.ace.agent/src/org/apache/ace/agent/ConnectionHandler.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.ace.agent;

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

import org.osgi.annotation.versioning.ConsumerType;

/**
 * Agent context delegate interface that is responsible for opening connection.
 */
@ConsumerType
public interface ConnectionHandler {

    /**
     * Supported authentication types.
     */
    enum Types {
        NONE, BASIC, CLIENTCERT;

        public static Types parseType(String name) {
            if (name == null) {
                return Types.NONE;
            }
            try {
                return Types.valueOf(name.toUpperCase().trim());
            }
            catch (Exception e) {
                return Types.NONE;
            }
        }
    }

    /**
     * Return a connection for the specified url.
     *
     * @param url The URL
     * @return The connection
     * @throws IOException If opening the connection fails
     */
    URLConnection getConnection(URL url) throws IOException;
}