org.loom.servlet
Class LoomServletRequestImpl

java.lang.Object
  javax.servlet.ServletRequestWrapper
      javax.servlet.http.HttpServletRequestWrapper
          org.loom.servlet.LoomServletRequestImpl

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, LoomServletRequest

public class LoomServletRequestImpl
extends javax.servlet.http.HttpServletRequestWrapper
implements LoomServletRequest

The real request is always wrapped inside one of these. This objects wraps all the attributes required by Loom at any time, with special attention to:

• the source URL: this attributes keeps track of the URL that originated this request

  Field Summary

  Fields inherited from interface javax.servlet.http.HttpServletRequest

  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

  Method Summary

  void	addFileParameter(java.lang.String name, FileParameter value) Add an uploaded file parameter
  void	addStringParameter(java.lang.String name, java.lang.String value) Add a String parameter
  static void	clearThreadLocal() Clear the request bound to this Thread, to avoid memory leaks
  UrlBuilder	createUrl() Creates a new empty UrlBuilder
  UrlBuilder	createUrl(java.lang.Class<? extends Action> actionClass, java.lang.String event) Creates a new UrlBuilder pointing to the provided action and event
  UrlBuilder	createUrl(java.lang.String url) Creates a new UrlBuilder pointing to the provided raw url
  java.lang.String	generateId(java.lang.String prefix) Generates a valid HTML id starting with prefix.
  java.lang.String	generateIndex(java.lang.String name) Generate a correlative index for the field passed as argument, in the form: field[0], field[1], etc.
  ActionMappingRepository	getActionMappingRepository()
  boolean	getAttributeAsBoolean(java.lang.String attributeName)
  BrowserData	getBrowserData()
  javax.servlet.http.Cookie	getCookie(java.lang.String cookieName)
  FormTag	getCurrentForm() TODO: this method should be moved elsewhere
  FileParameter	getFileParameter(java.lang.String name)
  HttpMethod	getHttpMethod()
  java.util.Locale	getLocale()
  MessagesRepository	getMessagesRepository()
  java.lang.String	getMethod()
  FlashContext	getNextFlashContext(boolean create) Return the flash-scoped context with objects persisted for the NEXT browser request.
  java.lang.String	getParameter(java.lang.String name)
  java.util.Enumeration<java.lang.String>	getParameterNames()
  ParsedAction	getParsedAction()
  FlashContext	getPreviousFlashContext() Return the flash-scoped context with objects persisted from the PREVIOUS browser request.
  ServletRequestParameters	getRequestParameters()
  java.lang.String	getRequestUrlWithParameters() Returns the full url including query parameters, protocol, server and port.
  java.lang.Object	getScopedAttribute(java.lang.String name, Scope... scopes) Get a scoped attribute
  java.lang.String	getStringParameter(java.lang.String name)
  static LoomServletRequest	getThreadLocal() Note that this method does not come for free.
  boolean	isAjax() Return true if the current request has been launched using Ajax.
  void	removeScopedAttribute(java.lang.String name, Scope scope) Remove a scoped atribute
  void	setCurrentForm(FormTag currentForm)
  void	setLocale(java.util.Locale locale)
  protected void	setMessagesRepository(MessagesRepository messagesRepository)
  void	setParsedAction(ParsedAction parsedAction)
  void	setScopedAttribute(java.lang.String name, java.lang.Object value, Scope scope) Create a scoped atribute
  static void	setThreadLocalImpl(java.lang.ThreadLocal<LoomServletRequest> threadLocalImpl) Change the ThreadLocal implementation
  java.lang.String	toString() Do NOT rely on this class format to do anything important, since this format is very likely to change in the future
  UrlBuilder	toUrlBuilder() Create a UrlBuilder instance with the same action/event/rawUrl and all the parameters included in this request instance.

  Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

  getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole

  Methods inherited from class javax.servlet.ServletRequestWrapper

  getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocales, getLocalName, getLocalPort, getParameterMap, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest

  Methods inherited from class java.lang.Object

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

  Methods inherited from interface javax.servlet.http.HttpServletRequest

  getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole

  Methods inherited from interface javax.servlet.ServletRequest

  getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocales, getLocalName, getLocalPort, getParameterMap, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding

  Method Detail

  getMethod

  public java.lang.String getMethod()

  Specified by:

  getMethod in interface javax.servlet.http.HttpServletRequest

  Overrides:

  getMethod in class javax.servlet.http.HttpServletRequestWrapper

  getHttpMethod

  public HttpMethod getHttpMethod()

  Specified by:

  getHttpMethod in interface LoomServletRequest

  Returns:

  the HttpMethod of this request. Note that the method used by the browser could be overriden if this is a POST request and the _method parameter is present.

  getLocale

  public java.util.Locale getLocale()

  Specified by:

  getLocale in interface javax.servlet.ServletRequest

  Overrides:

  getLocale in class javax.servlet.ServletRequestWrapper

  getRequestParameters

  public ServletRequestParameters getRequestParameters()

  Specified by:

  getRequestParameters in interface LoomServletRequest

  Returns:

  a ServletRequestParameters instance with all file upload parameters and plain parameters in a single map.

  getStringParameter

  public java.lang.String getStringParameter(java.lang.String name)

  Specified by:

  getStringParameter in interface LoomServletRequest

  Returns:

  the GET/POST parameter value

  getFileParameter

  public FileParameter getFileParameter(java.lang.String name)

  Specified by:

  getFileParameter in interface LoomServletRequest

  Returns:

  the uploaded file

  getParameter

  public java.lang.String getParameter(java.lang.String name)

  Specified by:

  getParameter in interface javax.servlet.ServletRequest

  Overrides:

  getParameter in class javax.servlet.ServletRequestWrapper

  Returns:

  the parameter value as String, null if none

  getParameterNames

  public java.util.Enumeration<java.lang.String> getParameterNames()

  Specified by:

  getParameterNames in interface javax.servlet.ServletRequest

  Overrides:

  getParameterNames in class javax.servlet.ServletRequestWrapper

  Returns:

  the list of string parameter names

  clearThreadLocal

  public static void clearThreadLocal()

  Clear the request bound to this Thread, to avoid memory leaks

  getThreadLocal

  public static LoomServletRequest getThreadLocal()

  Note that this method does not come for free. If you can choose, you should get the request reference by some other means.

  Returns:

  the current request bound to this thread.

  setThreadLocalImpl

  public static void setThreadLocalImpl(java.lang.ThreadLocal<LoomServletRequest> threadLocalImpl)

  Change the ThreadLocal implementation

  Parameters:

  threadLocalImpl - one of ThreadLocal or InheritedThreadLocal

  addFileParameter

  public void addFileParameter(java.lang.String name,
                               FileParameter value)

  Description copied from interface: LoomServletRequest

  Add an uploaded file parameter

  Specified by:

  addFileParameter in interface LoomServletRequest

  Parameters:

  name - the file parameter name

  value - the uploaded file to add to this request

  addStringParameter

  public void addStringParameter(java.lang.String name,
                                 java.lang.String value)

  Description copied from interface: LoomServletRequest

  Add a String parameter

  Specified by:

  addStringParameter in interface LoomServletRequest

  Parameters:

  name - the name of the parameter

  value - the value of the parameter

  getMessagesRepository

  public MessagesRepository getMessagesRepository()

  Specified by:

  getMessagesRepository in interface LoomServletRequest

  Returns:

  the MessagesRepository corresponding to the this request

  getParsedAction

  public ParsedAction getParsedAction()

  Specified by:

  getParsedAction in interface LoomServletRequest

  Returns:

  the action that is handling this request, null if none

  setParsedAction

  public void setParsedAction(ParsedAction parsedAction)

  setMessagesRepository

  protected void setMessagesRepository(MessagesRepository messagesRepository)

  getCurrentForm

  public FormTag getCurrentForm()

  Description copied from interface: LoomServletRequest

  TODO: this method should be moved elsewhere

  Specified by:

  getCurrentForm in interface LoomServletRequest

  Returns:

  the current JSP form tag, null if none.

  setCurrentForm

  public void setCurrentForm(FormTag currentForm)

  Specified by:

  setCurrentForm in interface LoomServletRequest

  generateId

  public java.lang.String generateId(java.lang.String prefix)

  Description copied from interface: LoomServletRequest

  Generates a valid HTML id starting with prefix.

  Specified by:

  generateId in interface LoomServletRequest

  Parameters:

  prefix - the prefix to use to generate the id

  Returns:

  A generated correlative id starting at 0: prefix_0, prefix_1, etc.

  generateIndex

  public java.lang.String generateIndex(java.lang.String name)

  Description copied from interface: LoomServletRequest

  Generate a correlative index for the field passed as argument, in the form: field[0], field[1], etc. To generate HTML ID for an entire web page, see generateId

  Specified by:

  generateIndex in interface LoomServletRequest

  Returns:

  the generated field name, e.g.: "field[0]"

  getCookie

  public javax.servlet.http.Cookie getCookie(java.lang.String cookieName)

  Specified by:

  getCookie in interface LoomServletRequest

  Parameters:

  cookieName - the name of the cookie

  Returns:

  the cookie value, null if none

  getRequestUrlWithParameters

  public java.lang.String getRequestUrlWithParameters()

  Description copied from interface: LoomServletRequest

  Returns the full url including query parameters, protocol, server and port. This will convert a POST request into a GET one, if there are no uploaded files.

  Specified by:

  getRequestUrlWithParameters in interface LoomServletRequest

  toUrlBuilder

  public UrlBuilder toUrlBuilder()

  Description copied from interface: LoomServletRequest

  Create a UrlBuilder instance with the same action/event/rawUrl and all the parameters included in this request instance. Any file parameters will be lost.

  Specified by:

  toUrlBuilder in interface LoomServletRequest

  Returns:

  the craeted UrlBuilder instance.

  isAjax

  public boolean isAjax()

  Description copied from interface: LoomServletRequest

  Return true if the current request has been launched using Ajax. Actually, it looks for a 'X-Requested-With' HTTP header, that is added by JQuery and prototype.

  Specified by:

  isAjax in interface LoomServletRequest

  Returns:

  true if the request has been launched using XmlHttpRequest, false if this is a normal request.

  setLocale

  public void setLocale(java.util.Locale locale)

  getAttributeAsBoolean

  public boolean getAttributeAsBoolean(java.lang.String attributeName)

  Specified by:

  getAttributeAsBoolean in interface LoomServletRequest

  Returns:

  a request attribute, as a boolean. If null, returns false.

  setScopedAttribute

  public void setScopedAttribute(java.lang.String name,
                                 java.lang.Object value,
                                 Scope scope)

  Description copied from interface: LoomServletRequest

  Create a scoped atribute

  Specified by:

  setScopedAttribute in interface LoomServletRequest

  Parameters:

  name - the attribute name

  value - the value

  scope - the scope of the attribute. Scope.PAGE is not allowed.

  removeScopedAttribute

  public void removeScopedAttribute(java.lang.String name,
                                    Scope scope)

  Description copied from interface: LoomServletRequest

  Remove a scoped atribute

  Specified by:

  removeScopedAttribute in interface LoomServletRequest

  Parameters:

  name - the attribute name

  scope - the scope of the attribute. Scope.PAGE is not allowed.

  getScopedAttribute

  public java.lang.Object getScopedAttribute(java.lang.String name,
                                             Scope... scopes)

  Description copied from interface: LoomServletRequest

  Get a scoped attribute

  Specified by:

  getScopedAttribute in interface LoomServletRequest

  Parameters:

  name - the attribute name

  scopes - the list of scopes to inspect, null for all. Scope.PAGE is not allowed.

  getNextFlashContext

  public FlashContext getNextFlashContext(boolean create)

  Description copied from interface: LoomServletRequest

  Return the flash-scoped context with objects persisted for the NEXT browser request.

  Specified by:

  getNextFlashContext in interface LoomServletRequest

  Parameters:

  create - if true, create the flash context if it does not yet exist.

  getPreviousFlashContext

  public FlashContext getPreviousFlashContext()

  Description copied from interface: LoomServletRequest

  Return the flash-scoped context with objects persisted from the PREVIOUS browser request.

  Specified by:

  getPreviousFlashContext in interface LoomServletRequest

  toString

  public java.lang.String toString()

  Do NOT rely on this class format to do anything important, since this format is very likely to change in the future

  Overrides:

  toString in class java.lang.Object

  Returns:

  a String representation of this request: attributes, http headers, etc

  createUrl

  public UrlBuilder createUrl()

  Description copied from interface: LoomServletRequest

  Creates a new empty UrlBuilder

  Specified by:

  createUrl in interface LoomServletRequest

  createUrl

  public UrlBuilder createUrl(java.lang.Class<? extends Action> actionClass,
                              java.lang.String event)

  Description copied from interface: LoomServletRequest

  Creates a new UrlBuilder pointing to the provided action and event

  Specified by:

  createUrl in interface LoomServletRequest

  createUrl

  public UrlBuilder createUrl(java.lang.String url)

  Description copied from interface: LoomServletRequest

  Creates a new UrlBuilder pointing to the provided raw url

  Specified by:

  createUrl in interface LoomServletRequest

  getBrowserData

  public BrowserData getBrowserData()

  Specified by:

  getBrowserData in interface LoomServletRequest

  Returns:

  the data that can be sniffed from the browser.

  getActionMappingRepository

  public ActionMappingRepository getActionMappingRepository()

  Specified by:

  getActionMappingRepository in interface LoomServletRequest