View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.proxy.handlers.http;
21  
22  import org.apache.mina.proxy.ProxyAuthException;
23  import org.apache.mina.proxy.handlers.http.basic.HttpBasicAuthLogicHandler;
24  import org.apache.mina.proxy.handlers.http.basic.HttpNoAuthLogicHandler;
25  import org.apache.mina.proxy.handlers.http.digest.HttpDigestAuthLogicHandler;
26  import org.apache.mina.proxy.handlers.http.ntlm.HttpNTLMAuthLogicHandler;
27  import org.apache.mina.proxy.session.ProxyIoSession;
28  
29  /**
30   * HttpAuthenticationMethods.java - Enumerates all known http authentication methods.
31   * 
32   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
33   * @since MINA 2.0.0-M3
34   */
35  public enum HttpAuthenticationMethods {
36  
37      NO_AUTH(1), BASIC(2), NTLM(3), DIGEST(4);
38      
39      private final int id;
40      
41      private HttpAuthenticationMethods(int id) {
42          this.id = id;
43      }
44  
45      /**
46       * Returns the authentication mechanism id.
47       * @return the id
48       */
49      public int getId() {
50          return id;
51      }
52  
53      /**
54       * Creates an {@link AbstractAuthLogicHandler} to handle the authentication mechanism.
55       * 
56       * @param proxyIoSession the proxy session object
57       * @return a new logic handler 
58       */
59      public AbstractAuthLogicHandler getNewHandler(ProxyIoSession proxyIoSession)
60          throws ProxyAuthException {
61          return getNewHandler(this.id, proxyIoSession);
62      }
63  
64      /**
65       * Creates an {@link AbstractAuthLogicHandler} to handle the authentication mechanism.
66       * 
67       * @param method the authentication mechanism to use
68       * @param proxyIoSession the proxy session object
69       * @return a new logic handler 
70       */    
71      public static AbstractAuthLogicHandler getNewHandler(
72              int method, ProxyIoSession proxyIoSession)
73              throws ProxyAuthException {
74          
75          if (method == BASIC.id)
76              return new HttpBasicAuthLogicHandler(proxyIoSession);
77          else
78          if (method == DIGEST.id)
79              return new HttpDigestAuthLogicHandler(proxyIoSession);
80          else
81          if (method == NTLM.id)
82              return new HttpNTLMAuthLogicHandler(proxyIoSession);
83          else
84          if (method == NO_AUTH.id)
85              return new HttpNoAuthLogicHandler(proxyIoSession);
86          else
87              return null;
88      }
89  }