Class PublishHandler

  • All Implemented Interfaces:
    Handler

    public class PublishHandler
    extends java.lang.Object
    implements Handler
    Handler for supporting publishing from Communicator. Launches an authentication handler to protect the content from malicious users.

    Looks for PUT requests, and creates or modifies the content as indicated.

    The following request properties are used:

    prefix, suffix, glob, match
    Specify the URL that triggers this handler. (See MatchString).
    session
    The the name of request property holding the session information to provide the credentials for posting. The default is "SessionID".
    Version:
    2.2, 06/11/13
    Author:
    Stephen Uhler
    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String propsPrefix  
      java.lang.String session  
    • Constructor Summary

      Constructors 
      Constructor Description
      PublishHandler()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean init​(Server server, java.lang.String prefix)
      Start up the authentication handler.
      boolean respond​(Request request)
      Make sure this is one of our "PUT" requests.
      • 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
      • propsPrefix

        public java.lang.String propsPrefix
    • Constructor Detail

      • PublishHandler

        public PublishHandler()
    • Method Detail

      • init

        public boolean init​(Server server,
                            java.lang.String prefix)
        Start up the authentication 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.
        prefix - 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)
                        throws java.io.IOException
        Make sure this is one of our "PUT" requests. Look up the credentials for this request. If no credentials are found, prompt the user for them. IF OK, save file to proper spot.
        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.
        Throws:
        java.io.IOException - if there was an I/O error while sending the response to the client. Typically, in that case, the Server will (try to) send an error message to the client and then close the client's connection.

        The IOException should not be used to silently ignore problems such as being unable to access some server-side resource (for example getting a FileNotFoundException due to not being able to open a file). In that case, the Handler's duty is to turn that IOException into a HTTP response indicating, in this case, that a file could not be found.