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.core.filterchain.IoFilter.NextFilter;
23  import org.apache.mina.proxy.ProxyAuthException;
24  import org.apache.mina.proxy.handlers.ProxyRequest;
25  import org.apache.mina.proxy.session.ProxyIoSession;
26  import org.slf4j.Logger;
27  import org.slf4j.LoggerFactory;
28  
29  /**
30   * AbstractAuthLogicHandler.java - Abstract class that handles an authentication 
31   * mechanism logic.
32   * 
33   * @author The Apache MINA Project (dev@mina.apache.org)
34   * @version $Rev: 759663 $, $Date: 2009-03-29 12:46:40 +0200 (Sun, 29 Mar 2009) $
35   * @since MINA 2.0.0-M3
36   */
37  public abstract class AbstractAuthLogicHandler {
38      private final static Logger logger = LoggerFactory
39              .getLogger(AbstractAuthLogicHandler.class);
40  
41      /**
42       * The request to be handled by the proxy.
43       */
44      protected ProxyRequest request;
45  
46      /**
47       * Object that contains all the proxy authentication session informations.
48       */
49      protected ProxyIoSession proxyIoSession;
50  
51      /**
52       * The current handshake step.
53       */
54      protected int step = 0;
55  
56      /**
57       * Instantiates a handler for the given proxy session.
58       * 
59       * @param proxyIoSession the proxy session object
60       * @throws ProxyAuthException
61       */
62      protected AbstractAuthLogicHandler(final ProxyIoSession proxyIoSession)
63              throws ProxyAuthException {
64          this.proxyIoSession = proxyIoSession;
65          this.request = proxyIoSession.getRequest();
66      }
67  
68      /**
69       * Method called at each step of the handshaking process.
70       * 
71       * @param nextFilter the next filter
72       * @throws ProxyAuthException
73       */
74      public abstract void doHandshake(final NextFilter nextFilter)
75              throws ProxyAuthException;
76  
77      /**
78       * Handles a HTTP response from the proxy server.
79       * 
80       * @param response The HTTP response.
81       * @throws ProxyAuthException
82       */
83      public abstract void handleResponse(final HttpProxyResponse response)
84              throws ProxyAuthException;
85  
86      /**
87       * Sends an HTTP request.
88       * 
89       * @param nextFilter the next filter
90       * @param request the request to write
91       * @throws ProxyAuthException
92       */
93      protected void writeRequest(final NextFilter nextFilter,
94              final HttpProxyRequest request) throws ProxyAuthException {
95          logger.debug("  sending HTTP request");
96  
97          ((AbstractHttpLogicHandler) proxyIoSession.getHandler()).writeRequest(
98                  nextFilter, request);
99      }
100 }