Package org.faceless.publisher.web

Class AbstractHttpSession

java.lang.Object
org.faceless.publisher.web.AbstractHttpSession
public abstract class AbstractHttpSession extends Object
An abstraction of an HTTP request/response sesssion, such as one corresponding to the HttpServletRequest/Response pair passed inth an HttpServlet. Will be passed into an HttpController

  • Constructor Details

    • AbstractHttpSession

      public AbstractHttpSession()

  • Method Details

    • getRemoteAddress

      public abstract InetAddress getRemoteAddress()
      Return the remote address for the connection

    • getRequestInputStream

      public abstract InputStream getRequestInputStream() throws IOException
      Return the InputStream supplied with the POST request, or null otherwise
      Throws:
      IOException

    • getResponseOutputStream

      public abstract OutputStream getResponseOutputStream() throws IOException
      Return the OutputStream for the response
      Throws:
      IOException

    • getRequestHeaders

      public abstract Map<String,List<String>> getRequestHeaders() throws IOException
      Return the full set of request headers
      Throws:
      IOException

    • getRequestParameters

      public abstract Map<String,List<String>> getRequestParameters() throws IOException
      Return the full set of request parameters. Should only apply for GET or for application/x-www-form-urlencoded.
      Throws:
      IOException

    • getRequestMethod

      public abstract String getRequestMethod()
      Return the request method

    • getRequestPath

      public abstract String getRequestPath()
      Return the full path for the request, relative to the web-application root and beginning with a "/"

    • setResponseHeader

      public abstract void setResponseHeader(String key, String value) throws IOException
      Set a header for the response
      Throws:
      IOException

    • setResponseCode

      public abstract void setResponseCode(int code) throws IOException
      Set the code for the response
      Throws:
      IOException

    • beginAsync

      public abstract void beginAsync()
      Begin an "async" sequence - the thread can be freed

    • completeAsync

      public abstract void completeAsync()
      Complete an "async" sequence started earlier

    • log

      public abstract void log(String s, Throwable e)
      Log a message to the ServiceEngine
      Parameters:
      s - the message
      e - the optional throwable

    • getServiceEngine

      public abstract ServiceEngine getServiceEngine()
      Return the ServiceEngine that applies to this object

    • setResponseDateHeader

      public void setResponseDateHeader(String key, long value) throws IOException
      Set a header for the response
      Parameters:
      value - time in millis since epoch
      Throws:
      IOException

    • getRequestHeader

      public String getRequestHeader(String key) throws IOException
      Return a specific header from the request, or null if it wasn't specified
      Parameters:
      key - the case-insensitive header name
      Returns:
      the header value, or null if none applies
      Throws:
      IOException

    • getRequestParameter

      public String getRequestParameter(String key) throws IOException
      Return the specified parameter from the request URL, or null if it wasn't specified.
      Parameters:
      key - the parameter name
      Returns:
      the value of that parameter, or null if it doesn't exist
      Throws:
      IOException

    • getAuthorization

      public Authorization getAuthorization()
      Return the Autorization derived from the request

    • getType

      public String getType()
      Return the type, eg "store", "convert"