Package org.oa4mp.client.api.servlet

Class ClientServlet

  • All Implemented Interfaces:
    edu.uiuc.ncsa.security.core.Logable, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
    Direct Known Subclasses:
    SimpleReadyServlet, SimpleStartRequest
    public abstract class ClientServlet
extends edu.uiuc.ncsa.security.servlet.AbstractServlet
    Basic Client servlet. it has the machinery in it for reading in a configuration file, setting up the ClientEnvironment and making the OA4MPService instance. It also includes a utility call for getting a cookie with the identifier (stored with the key "oa4mp_client_req_id" in the users browser).

    Look at the two sample uses of this in SimpleStartRequest and SimpleReadyServlet to see how to extend and use it.

    Created by Jeff Gaynor
    on 2/10/12 at 12:51 PM

    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ACTION_KEY  
      static String ACTION_REDIRECT_VALUE  
      static edu.uiuc.ncsa.security.core.cache.Cleanup<edu.uiuc.ncsa.security.core.Identifier,​Asset> assetCleanup  
      static String OA4MP_CLIENT_REQUEST_ID
      If a client specifically requests a response with debugging information then this will be returned ONLY in cases of an error on the server.
      static String REDIR  

      • Fields inherited from class edu.uiuc.ncsa.security.servlet.AbstractServlet

        environment, initialization, IP_HEADERS, PING_PARAMETER

    • Constructor Summary

      Constructors 
      Constructor Description
      ClientServlet()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected String clearCookie​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Clear the CILogon client cookie.
      void destroy()  
      protected HashMap<String,​Asset> getAssetCache()  
      ClientEnvironment getCE()
      Convenience for client servlets.
      OA4MPService getOA4MPService()  
      void loadEnvironment()  
      protected void shutdownCleanup​(edu.uiuc.ncsa.security.core.cache.Cleanup c)  

      • Methods inherited from class edu.uiuc.ncsa.security.servlet.AbstractServlet

        checkContentType, CONST, debug, doGet, doIt, doPing, doPost, error, error, getConfigurationLoader, getEnvironment, getExceptionHandler, getInitialization, getMyLogger, getRequestIPAddress, handleException, info, init, isDebugOn, logOK, logOK, printAllParameters, printAllParameters, resetState, setConfigurationLoader, setDebugOn, setEnvironment, setExceptionHandler, setInitialization, warn

      • Methods inherited from class javax.servlet.http.HttpServlet

        doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

      • Methods inherited from class javax.servlet.GenericServlet

        getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

    • Field Detail

      • OA4MP_CLIENT_REQUEST_ID

        public static final String OA4MP_CLIENT_REQUEST_ID
        If a client specifically requests a response with debugging information then this will be returned ONLY in cases of an error on the server. It is up to the client to unpack this. To use this, add the key to the request with a value of true.
        See Also:
        Constant Field Values

      • assetCleanup

        public static edu.uiuc.ncsa.security.core.cache.Cleanup<edu.uiuc.ncsa.security.core.Identifier,​Asset> assetCleanup

    • Constructor Detail

      • ClientServlet

        public ClientServlet()

    • Method Detail

      • getCE

        public ClientEnvironment getCE()
        Convenience for client servlets. Does the cast automatically
        Returns:

      • loadEnvironment

        public void loadEnvironment()
                     throws IOException
        Specified by:
        loadEnvironment in class edu.uiuc.ncsa.security.servlet.AbstractServlet
        Throws:
        IOException

      • destroy

        public void destroy()
        Specified by:
        destroy in interface javax.servlet.Servlet
        Overrides:
        destroy in class javax.servlet.GenericServlet

      • shutdownCleanup

        protected void shutdownCleanup​(edu.uiuc.ncsa.security.core.cache.Cleanup c)

      • clearCookie

        protected String clearCookie​(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
        Clear the CILogon client cookie. This way if there is an error the user won't get a stale one with a possible server-side exception later.

        This clears the client request id cookie ("oa4mp_client_req_id") and returns the currently set value for it. This
        Parameters:
        request -
        response -