org.aselect.server.request.handler
Interface IRequestHandler

All Known Implementing Classes:
AbstractRequestHandler, ASelectAuthenticationProfile, ASelectAuthenticationProfile, ASelectRestartRequestHandler, AttributeProcessorProceeder, CookieMonsterHandler, SAML11ArtifactRequestHandler, SAML11QueryRequestHandler, SAML11RequestHandler, SFSIdpQueryHandler, ShibbolethAuthenticationProfile, ShibbolethWAYFProfile, SSONotifcationServiceHandler, SSOServiceHandler

public interface IRequestHandler

Interface for request handlers.

Description:
Interface that describes the methods that a RequestHandler object must implement

Concurrency issues:
-

Author:
Alfa & Ariss

Method Summary
 void destroy()
          Removes the class objects from memory.
 java.lang.String getID()
          Returns the RequestHandler unique ID.
 java.util.regex.Pattern getPattern()
          Returns the regular expression configured for this ReuqestHandler.
 void init(javax.servlet.ServletConfig oServletConfig, java.lang.Object oConfig)
          Initializes the Request Handler.
 RequestState process(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Processes the request.
 

Method Detail

init

void init(javax.servlet.ServletConfig oServletConfig,
          java.lang.Object oConfig)
          throws ASelectException
Initializes the Request Handler.

Description:
Reads the Request Handler configuration

Concurrency issues:
-

Preconditions:
  • oServletConfig != null
  • oConfig != null


  • Postconditions:
    -

    Parameters:
    oServletConfig - Servlet Config of the Parent servlet
    oConfig - Object containing the RequestHandler configuration
    Throws:
    ASelectException - if initalization fails

    process

    RequestState process(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                         throws ASelectException
    Processes the request.

    Description:
    Processes the request from the HttpServletRequest and sends the response to the HttpServletResponse

    Concurrency issues:
    -

    Preconditions:
  • request != null
  • response != null


  • Postconditions:
    -

    Parameters:
    request - HttpServletRequest containing the request
    response - HttpServletResponse containing the response
    Returns:
    RequestState containing the request handling state
    Throws:
    ASelectException - if the request couldn't be processed

    getID

    java.lang.String getID()
    Returns the RequestHandler unique ID.

    Returns:
    String continaing the requesthandler

    getPattern

    java.util.regex.Pattern getPattern()
    Returns the regular expression configured for this ReuqestHandler.

    Description:
    The regular expression

    Concurrency issues:
    -

    Preconditions:
    -

    Postconditions:
    -

    Returns:
    Pattern that contains the regular expression that will handle the request

    destroy

    void destroy()
    Removes the class objects from memory.



    Copyright © 2008 SURFnet BV. All Rights Reserved.