org.aselect.server.request.handler.aselect.authentication
Class AbstractBrowserRequestHandler

java.lang.Object
  extended by org.aselect.server.request.handler.aselect.authentication.AbstractBrowserRequestHandler
All Implemented Interfaces:
IRequestHandler
Direct Known Subclasses:
ApplicationBrowserHandler, ASelectBrowserHandler, AuthSPBrowserHandler

public abstract class AbstractBrowserRequestHandler
extends java.lang.Object
implements IRequestHandler

Abstract browser request handler.

Description:
This class can be used as a base class for request handlers which handle browser requests. The AbstractBrowserRequestHandler also contains the helper functions used by the different request handlers

Concurrency issues:
Use one AbstractBrowserRequestHandler implementation for a single request.

Author:
Alfa & Ariss

Field Summary
protected  ASelectConfigManager _configManager
          The configuration.
protected  javax.servlet.http.HttpServletRequest _servletRequest
          The request.
protected  javax.servlet.http.HttpServletResponse _servletResponse
          The response.
protected  SessionManager _sessionManager
          The session manager.
protected  java.lang.String _sModule
          The module name.
protected  java.lang.String _sMyOrg
          The organization
protected  java.lang.String _sMyServerId
          The server ID
protected  ASelectSystemLogger _systemLogger
          The system logger.
protected  TGTManager _tgtManager
          The TGT manager.
 
Constructor Summary
AbstractBrowserRequestHandler(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, java.lang.String sMyServerId, java.lang.String sMyOrg)
          Construct an instance.
 
Method Summary
protected  java.util.Hashtable getASelectCredentials(javax.servlet.http.HttpServletRequest servletRequest)
          Retrieve A-Select credentials.
protected abstract  void processBrowserRequest(java.util.Hashtable htServiceRequest, javax.servlet.http.HttpServletResponse servletResponse, java.io.PrintWriter pwOut)
          Processes the API request.
 void processRequest()
          This function processes browser requests

protected  void showErrorPage(java.lang.String sErrorCode, java.util.Hashtable htServiceRequest, java.io.PrintWriter pwOut)
          Shows the main A-Select Error page with the appropriate errors.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_sModule

protected java.lang.String _sModule
The module name. Can be overwritten in sub classes


_systemLogger

protected ASelectSystemLogger _systemLogger
The system logger.


_configManager

protected ASelectConfigManager _configManager
The configuration.


_sessionManager

protected SessionManager _sessionManager
The session manager.


_tgtManager

protected TGTManager _tgtManager
The TGT manager.


_servletRequest

protected javax.servlet.http.HttpServletRequest _servletRequest
The request.


_servletResponse

protected javax.servlet.http.HttpServletResponse _servletResponse
The response.


_sMyServerId

protected java.lang.String _sMyServerId
The server ID


_sMyOrg

protected java.lang.String _sMyOrg
The organization

Constructor Detail

AbstractBrowserRequestHandler

public AbstractBrowserRequestHandler(javax.servlet.http.HttpServletRequest servletRequest,
                                     javax.servlet.http.HttpServletResponse servletResponse,
                                     java.lang.String sMyServerId,
                                     java.lang.String sMyOrg)
Construct an instance.

Description:
Handles are obtained to relevant managers.

Parameters:
servletRequest - The request.
servletResponse - The response.
sMyServerId - The A-Select Server ID.
sMyOrg - The A-Select Server organization.
Method Detail

processRequest

public void processRequest()
                    throws ASelectException
This function processes browser requests

Specified by:
processRequest in interface IRequestHandler
Throws:
ASelectException
See Also:
IRequestHandler.processRequest()

processBrowserRequest

protected abstract void processBrowserRequest(java.util.Hashtable htServiceRequest,
                                              javax.servlet.http.HttpServletResponse servletResponse,
                                              java.io.PrintWriter pwOut)
                                       throws ASelectException
Processes the API request.

Parameters:
htServiceRequest - Hashtable containing request parameters
servletResponse - Used to send information (HTTP) back to the user
pwOut - Used to send information back to the user (HTML)
Throws:
ASelectException - If processing fails and no response is send to the client.

showErrorPage

protected void showErrorPage(java.lang.String sErrorCode,
                             java.util.Hashtable htServiceRequest,
                             java.io.PrintWriter pwOut)
Shows the main A-Select Error page with the appropriate errors.

Parameters:
sErrorCode -
htServiceRequest -
pwOut -

getASelectCredentials

protected java.util.Hashtable getASelectCredentials(javax.servlet.http.HttpServletRequest servletRequest)
Retrieve A-Select credentials.

Description:
Reads the A-Select credentials from a Cookie and put them into a Hashtable.

Concurrency issues:
-

Preconditions:
servletRequest != null

Postconditions:
-

Parameters:
servletRequest - The Request which should contain the Cookie.
Returns:
The A-Select credentials in a Hashtable.


Copyright © 2008 SURFnet BV. All Rights Reserved.