Package sunlabs.brazil.filter

Class UrlSessionFilter

  • All Implemented Interfaces:
    Filter, Handler
    public class UrlSessionFilter
extends java.lang.Object
implements Filter
    Sample filter to use url's instead of cookies for sessions. When html files are delivered, all URL's back to this host are changed to add in the session information. When requests are made, the session info is stripped off the URL, which is passed to the rest of the handlers.

    Note: This fiter has been superceded by the SessionFilter. It is included for illustrative purposes only.

    Version:
    2.3
    Author:
    Stephen Uhler

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String session  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte[] filter​(Request request, MimeHeaders headers, byte[] content)
      Rewrite all the url's, adding the session id to the end
      boolean init​(Server server, java.lang.String propsPrefix)
      Initializes the handler.
      boolean respond​(Request request)
      Extract the cookie out of the URL, rewriting the url as needed.
      boolean shouldFilter​(Request request, MimeHeaders headers)
      We have the results, only filter if html

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • session

        public java.lang.String session

    • Constructor Detail

      • UrlSessionFilter

        public UrlSessionFilter()

    • Method Detail

      • init

        public boolean init​(Server server,
                    java.lang.String propsPrefix)
        Description copied from interface: Handler
        Initializes the handler.
        Specified by:
        init in interface Handler
        Parameters:
        server - The HTTP server that created this Handler. Typical Handlers will use Server.props to obtain run-time configuration information.
        propsPrefix - The handlers name. The string this Handler may prepend to all of the keys that it uses to extract configuration information from Server.props. This is set (by the Server and ChainHandler) to help avoid configuration parameter namespace collisions.
        Returns:
        true if this Handler initialized successfully, false otherwise. If false is returned, this Handler should not be used.

      • respond

        public boolean respond​(Request request)
        Extract the cookie out of the URL, rewriting the url as needed. Add the session info at the end of the url: /a/b.html -> /a/b.html$xxxx where xxx is the session This gets called before the original request is made.
        Specified by:
        respond in interface Handler
        Parameters:
        request - The Request object that represents the HTTP request.
        Returns:
        true if the request was handled. A request was handled if a response was supplied to the client, typically by calling Request.sendResponse() or Request.sendError.

      • shouldFilter

        public boolean shouldFilter​(Request request,
                            MimeHeaders headers)
        We have the results, only filter if html
        Specified by:
        shouldFilter in interface Filter
        Parameters:
        request - The in-progress HTTP request.
        headers - The MIME headers generated by the wrapped Handler.
        Returns:
        true if this filter would like to examine and possibly rewrite the content, false otherwise.

      • filter

        public byte[] filter​(Request request,
                     MimeHeaders headers,
                     byte[] content)
        Rewrite all the url's, adding the session id to the end
        Specified by:
        filter in interface Filter
        Parameters:
        request - The finished HTTP request.
        headers - The MIME headers generated by the Handler.
        content - The output from the Handler that this Filter may rewrite.
        Returns:
        The rewritten content. The Filter may return the original content unchanged. The Filter may return null to indicate that the FilterHandler should stop processing the request and should not return any content to the client.