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 mechanism logic.
31   * 
32   * @author The Apache MINA Project (dev@mina.apache.org)
33   * @version $Rev: 685703 $, $Date: 2008-08-14 00:14:47 +0200 (Thu, 14 Aug 2008) $
34   * @since MINA 2.0.0-M3
35   */
36  public abstract class AbstractAuthLogicHandler {
37      private final static Logger logger = LoggerFactory
38              .getLogger(AbstractAuthLogicHandler.class);
39  
40      /**
41       * The request the proxy has to handle.
42       */
43      protected ProxyRequest request;
44  
45      /**
46       * Object that contains all the proxy authentication session informations.
47       */
48      protected ProxyIoSession proxyIoSession;
49  
50      /**
51       * The current step in the handshake.
52       */
53      protected int step = 0;
54  
55      protected AbstractAuthLogicHandler(final ProxyIoSession proxyIoSession)
56              throws ProxyAuthException {
57          this.proxyIoSession = proxyIoSession;
58          this.request = proxyIoSession.getRequest();
59      }
60  
61      /**
62       * Called on each step of the handshaking process.
63       */
64      public abstract void doHandshake(final NextFilter nextFilter)
65              throws ProxyAuthException;
66  
67      /**
68       * Handles a HTTP response from the proxy server.
69       * 
70       * @param response The response.
71       */
72      public abstract void handleResponse(final HttpProxyResponse response)
73              throws ProxyAuthException;
74  
75      protected void writeRequest(final NextFilter nextFilter,
76              final HttpProxyRequest request) throws ProxyAuthException {
77          logger.debug("  sending HTTP request");
78  
79          ((AbstractHttpLogicHandler) proxyIoSession.getHandler()).writeRequest(
80                  nextFilter, request);
81      }
82  }