org.apache.mina.proxy.handlers.http.HttpAuthenticationMethods Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mina-core Show documentation
There is a newer version: 3.0.0-M2
/*
 *  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.mina.proxy.handlers.http;

import org.apache.mina.proxy.ProxyAuthException;
import org.apache.mina.proxy.handlers.http.basic.HttpBasicAuthLogicHandler;
import org.apache.mina.proxy.handlers.http.basic.HttpNoAuthLogicHandler;
import org.apache.mina.proxy.handlers.http.digest.HttpDigestAuthLogicHandler;
import org.apache.mina.proxy.handlers.http.ntlm.HttpNTLMAuthLogicHandler;
import org.apache.mina.proxy.session.ProxyIoSession;

/**
 * HttpAuthenticationMethods.java - Enumerates all known http authentication methods.
 * 
 * @author Apache MINA Project
 * @since MINA 2.0.0-M3
 */
public enum HttpAuthenticationMethods {
    /** No authentication */
    NO_AUTH(1), 
    
    /** Basic authentication */
    BASIC(2), 
    
    /** NTLM (Microsoft) authentication */
    NTLM(3), 
    
    /** Digest authentication */
    DIGEST(4);

    private final int id;

    private HttpAuthenticationMethods(int id) {
        this.id = id;
    }

    /**
     * @return the authentication mechanism id.
     */
    public int getId() {
        return id;
    }

    /**
     * Creates an {@link AbstractAuthLogicHandler} to handle the authentication mechanism.
     * 
     * @param proxyIoSession the proxy session object
     * @return a new logic handler 
     * @throws ProxyAuthException If we get an error during the proxy authentication
     */
    public AbstractAuthLogicHandler getNewHandler(ProxyIoSession proxyIoSession) throws ProxyAuthException {
        return getNewHandler(this.id, proxyIoSession);
    }

    /**
     * Creates an {@link AbstractAuthLogicHandler} to handle the authentication mechanism.
     * 
     * @param method the authentication mechanism to use
     * @param proxyIoSession the proxy session object
     * @return a new logic handler 
     * @throws ProxyAuthException If we get an error during the proxy authentication
     */
    public static AbstractAuthLogicHandler getNewHandler(int method, ProxyIoSession proxyIoSession)
            throws ProxyAuthException {

        if (method == BASIC.id)
            return new HttpBasicAuthLogicHandler(proxyIoSession);
        else if (method == DIGEST.id)
            return new HttpDigestAuthLogicHandler(proxyIoSession);
        else if (method == NTLM.id)
            return new HttpNTLMAuthLogicHandler(proxyIoSession);
        else if (method == NO_AUTH.id)
            return new HttpNoAuthLogicHandler(proxyIoSession);
        else
            return null;
    }
}