org.apache.axis2.transport.http.server
Class AuthRequestHandler

java.lang.Object
  extended byorg.apache.axis2.transport.http.server.AuthRequestHandler
All Implemented Interfaces:
HttpRequestHandler

public class AuthRequestHandler
extends Object
implements HttpRequestHandler

This request handler guards access to the http server when used in a request handler chain. It checks the headers for valid credentials and performs the authentication handshake if necessary.


Field Summary
static String AUTH_RESP
          The authenticate response header.
 
Constructor Summary
AuthRequestHandler(org.apache.commons.httpclient.Credentials creds)
           
AuthRequestHandler(org.apache.commons.httpclient.Credentials creds, String realm)
           
AuthRequestHandler(org.apache.commons.httpclient.Credentials creds, String realm, boolean keepalive)
          TODO replace creds parameter with a class specific to an auth scheme encapsulating all required information for a specific scheme
 
Method Summary
 boolean processRequest(SimpleHttpServerConnection conn, SimpleRequest request)
          The request handler is asked to process this request.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AUTH_RESP

public static final String AUTH_RESP
The authenticate response header.

See Also:
Constant Field Values
Constructor Detail

AuthRequestHandler

public AuthRequestHandler(org.apache.commons.httpclient.Credentials creds)

AuthRequestHandler

public AuthRequestHandler(org.apache.commons.httpclient.Credentials creds,
                          String realm)

AuthRequestHandler

public AuthRequestHandler(org.apache.commons.httpclient.Credentials creds,
                          String realm,
                          boolean keepalive)
TODO replace creds parameter with a class specific to an auth scheme encapsulating all required information for a specific scheme

Parameters:
creds -
Method Detail

processRequest

public boolean processRequest(SimpleHttpServerConnection conn,
                              SimpleRequest request)
                       throws IOException
Description copied from interface: HttpRequestHandler
The request handler is asked to process this request.

If it is not capable/interested in processing it, this call should be simply ignored.

Any modification of the output stream (via conn.getWriter()) by this request handler will stop the execution chain and return the output to the client.

The handler may also rewrite the request parameters (this is useful in HttpRequestHandlerChain structures).

Specified by:
processRequest in interface HttpRequestHandler
Parameters:
conn - The Connection object to which this request belongs to.
request - The request object.
Returns:
true if this handler handled the request and no other handlers in the chain should be called, false otherwise.
Throws:
IOException