Package com.zfabrik.util.microweb

Class MicroWebConstants

java.lang.Object
com.zfabrik.util.microweb.MicroWebConstants
public final class MicroWebConstants extends Object
The MicroWeb web utility stores several pieces of processing information on the current request object. These can be accessed as attributes using the constants below.

  • Field Details

    • MICROWEB_CONTEXT_PATH

      public static final String MICROWEB_CONTEXT_PATH
      The actual context path that was used on the client request. This will not be overwritten in case of internal forwarding. It may be different than the request's context path also in reverse proxy situations. In order to generate client urls, this context path is the choice.
      Note: Reverse proxies should take care of paths in headers and cookies (body content is a different story). Use the request's context path for headers and cookis. Use the microweb context path for body urls.
      Note, this path is constructed so that it can always be concatenated with a following path that has a leading slash. In particular, this path may be "" for the server's root path.
      Note furthermore that forwarding with namespace translation extends this path as fits, so that it can always be used to consistently compute paths to local resources that will follow the same forwarding scheme.
      See Also:
      Constant Field Values

    • MICROWEB_APPLICATION_PATH

      public static final String MICROWEB_APPLICATION_PATH
      The application path is the path used within the microweb application (regardless of includes) used to determine actions. It is close in meaning to the request URI.
      Note: This path always has a leading slash.
      See Also:
      Constant Field Values

    • MICROWEB_LOCALE

      public static final String MICROWEB_LOCALE
      The requested Locale as far as Microweb is concerned. May be null
      See Also:
      Constant Field Values

    • MICROWEB_PATH_INFO

      public static final String MICROWEB_PATH_INFO
      The microweb path info, is the equivalent of a servlet's path info for microweb actions. It is the path trailing the the part of the URI that was used to determine the current action.
      See Also:
      Constant Field Values

    • MICROWEB_INTERNAL_DISPATCH

      public static final String MICROWEB_INTERNAL_DISPATCH
      Used to indicate internal wrapping of actions. If this attribute is set other than null, the action will be handled liks an internal dispatch, in particular there will be no security checking.
      See Also:
      Constant Field Values

    • PROXY_CONTEXT_PATH

      public static final String PROXY_CONTEXT_PATH
      header field to specify context path used by the client request. This is to be set by reverse proxies to help the backend translate good urls.
      See Also:
      Constant Field Values