Package org.pajes.servlet

Provides the base classes for interfacing with a client browser.

See:
Description

Class Summary

AuthenticatedPajeServlet	Base class for all servlets that utilise the PAJES servlet framework that require authentication services.
BlankPajeServlet	Returns an empty HTML document.
Browser	The Browser class is an abstraction of a Web browser.
DataAccessPajeServlet	Base class for all servlets that utilise the PAJES servlet framework that require data access services.
HttpServletRequestWrapper	The HttpServletRequestWrapper object extends the standard HttpServletRequest object to provide additional functionality such as the ability to automatically process file uploads, and the handling of encrypted query parameters.
Initialisation	Deprecated. Use PajesContext.
PajeCookie	The PajeCookie class adds to the functionality of the Cookie class by providing the facility to handle "sub-values".
PajesContext	Initialises the PAJES servlet framework.
PajesContextListener	PAJES implementation of javax.servlet.ServletContextListener that correctly initalises the PAJES servlet framework environment.
PajeServlet	Base class for all servlets that utilise the PAJES servlet framework, to provide automatic decoding of encrypted query string parameters, and transparent handling of multi-part requests (file uploads).
RequestRedirector	An object that receives requests from the client and redirects them to any resource (such as a servlet, HTML file, or JSP file) within this context.
StaticPajeServlet	Abstract super-class of classes that return static content that the web server would not usually have access to (for example, static content located within a JAR in the /WEB-INF/lib directory).
UploadedFile	A representation of a file which has been uploaded to the server.
UploadFileRequest	Handles a request stream that contains files to be uploaded.

Exception Summary

PajeServletException	Thrown when a servlet related exception occurs.
UploadFileRequestException	Thrown when an IO exception relating to a multi-part request occurs.
UploadFileRequestTooLargeException	Thrown when a file upload request exceeds the maximum posting size.

Package org.pajes.servlet Description

Provides the base classes for interfacing with a client browser.

paJes applications are based on sub-classes of PajeServlet, which provides facilities such as the transparent handling of multi-part requests (file uploads).

The DataAccessPajeServlet extends the functionality offered by PajeServlet to provide convenience methods for accessing the application ConnectionPools.

Finally, if security is not being implemented by the servlet container, the AuthenticatedPajeServlet extends the functionality offered by DataAccessPajeServlet to provide application level security through the AccessPermission object. Note that if authentication services are being provided by the servlet container, the AuthenticatedPajeServlet will recognise that the request has already been authenticated.

Default settings used by paJes are determined from <context-param> entries in the web application deployment descriptor. The following <context-param> entries are currently suported:

  <!-- Determines the default maximum number of bytes that can be uploaded to
       a servlet.
       See PajeServlet.setMaxFileUploadSize(int).
    -->
  <context-param>
      <param-name>org.pajes.servlet.Browser.maxFileUploadSize</param-name>
      <param-value>1048510</param-value>
  </context-param>

  <!-- Determines whether the document should be written back to the browser
       using compression if the browser supports it.
       See Browser.useCompression(boolean).
    -->
  <context-param>
      <param-name>org.pajes.servlet.Browser.useCompression</param-name>
      <param-value>false</param-value>
  </context-param>

  <!-- Determines whether query parameters in, for example, anchors should be
       encrypted before being returned to the browser.
       See Browser.useEncryptedQueryParameters(boolean).
    -->
  <context-param>
      <param-name>org.pajes.servlet.Browser.useEncryptedQueryParameters</param-name>
      <param-value>false</param-value>
  </context-param>

  <!-- Determines whether URLs should be automatically encoded using
       HttpServletResponse.encodeURL by those objects that
       contain or represent a URL, such as Anchor or Form.
       See Browser.useURLEncoding(boolean).
    -->
  <context-param>
      <param-name>org.pajes.servlet.Browser.useURLEncoding</param-name>
      <param-value>false</param-value>
  </context-param>

  <!-- Determines whether the document written back to the browser should be
       XHTML compliant or not.
       See Browser.useXHTML(boolean).
    -->
  <context-param>
      <param-name>org.pajes.servlet.Browser.useXHTML</param-name>
      <param-value>true</param-value>
  </context-param>