com.sssw.fw.api
Interface EbiRequest

All Known Subinterfaces:

EbiActionRequest, EbiHttpRequest, EbiPortletRequest, EbiRenderRequest

public interface EbiRequest

This interface provides a wrapper to one of three request implementations.

• ActionRequest
• RenderRequest
• HttpServletRequest

  The underlying request is indicated by EbiRequest.getType() The original request can be obtained by casting for example:

     EbiRequest req = ctxt.getEbiRequest();
     if (req instanceof EbiRenderRequest){
       javax.portlet.RenderRequest renderRequest = ((EbiRenderRequest)req).getRenderRequest();
     }
   

  See Also:

  EbiRenderRequest, EbiActionRequest, EbiHttpRequest

  Method Summary

  Object	getAttribute(String name) Returns an object from the request attribute map with the given name, null if the name does not exist
  Cookie[]	getCookies() Returns an Array of Cookie objects found on the wrapped request.
  String	getHeader(String header) Returns an request header value, associated with the passed parameter, from the EbiRequest's HttpServletRequest.
  HttpServletRequest	getHttpServletRequest() Deprecated.
  Locale	getLocale() Returns the locale of the underlying request object, for http this relates directly to the locale header.
  Enumeration	getLocales() Returns the locales of the underlying request object, for http this relates directly to the locale header.
  String	getParameter(String parameter) Returns an request parameter value, associated with the passed parameter, from the EbiRequest's wrapped HttpServletRequest, RenderRequest, or ActionRequest.
  Enumeration	getParameterNames() Retrieves an enumeration of names that are contained in the request params
  String[]	getParameterValues(String parameter) Returns an Array of request parameter values, associated with the passed parameter, from the EbiRequest's wrapped HttpServletRequest, RenderRequest, or ActionRequest.
  String	getPassword() Deprecated.
  String	getQueryString() Deprecated.
  String	getServer() Try and determine the server name from the request.
  HttpSession	getSession() Deprecated.
  String	getType() the type of request that is wrapped
  String	getUserID() Deprecated.
  Principal	getUserPrincipal() gets the principal from the wrapped request implementation
  String	getVersion() Deprecated.
  boolean	hasHttpServletRequest() Checks to see if this request has an HttpServletRequest.
  boolean	hasQueryString() Checks to see if the HttpServletRequest has a Query String.
  boolean	isHttpRequest() Checks to see if the wrapped request is an HttpServletRequest.
  boolean	isNewSession() True if the the session from the wrapped request is a new session.
  void	setAttribute(String name, Object obj) Stores an attribute in this request.

  Method Detail

  getLocale

  public Locale getLocale()

  Returns the locale of the underlying request object, for http this relates directly to the locale header.

  Returns:

  the locale from the wrapped request

  Since:

  v5.0

  getLocales

  public Enumeration getLocales()

  Returns the locales of the underlying request object, for http this relates directly to the locale header.

  Returns:

  the locales from the wrapped request

  Since:

  v5.0

  getHttpServletRequest

  public HttpServletRequest getHttpServletRequest()

  Deprecated.

  Returns the HttpServletRequest

  The wrapped request may not contain an http servlet request in which case java.lang.UnsupportedOperationException is thrown. This method is deprecated, use:

     EbiRequest req = ctxt.getEbiRequest();
     if (req instanceof EbiHttpRequest){
       HttpServletRequest req = ((EbiHttpRequest)req).getHttpServletRequest();
     }
   

  Returns:

  the actual javax.servlet.http.HttpSevletRequest

  getAttribute

  public Object getAttribute(String name)

  Returns an object from the request attribute map with the given name, null if the name does not exist

  Parameters:

  name - a String specifying the name of the attribute

  Returns:

  an Object containing the value of the attribute, or null if the attribute does not exist

  Since:

  v5.0

  setAttribute

  public void setAttribute(String name,
                           Object obj)

  Stores an attribute in this request. Attributes are reset between requests.

  Parameters:

  name - a String specifying the name of the attribute

  obj - the Object to be stored

  Since:

  v5.0

  getUserPrincipal

  public Principal getUserPrincipal()

  gets the principal from the wrapped request implementation

  Returns:

  the principal object bound to the request, null if no principal is bound

  Since:

  v5.0

  getType

  public String getType()

  the type of request that is wrapped

  This can be used to determine the underlying request type so that a cast can be made. For example EbiRequest#TYPE_RENDER can be cast to (@link com.sssw.fw.api.EbiRenderRequest) Types include: TYPE_RENDER, TYPE_ACTION, or TYPE_HTTP

  Returns:

  Since:

  v5.0

  getVersion

  public String getVersion()

  Deprecated.

  Returns the HttpServletRequest version Null may be returned if the version is unknown

  Returns:

  String representation of the HttpServletRequest version

  getCookies

  public Cookie[] getCookies()

  Returns an Array of Cookie objects found on the wrapped request. If the request does not have cookies null is returned

  Returns:

  Array of Cookie objects found on the EbiRequest.

  getHeader

  public String getHeader(String header)

  Returns an request header value, associated with the passed parameter, from the EbiRequest's HttpServletRequest. In the case that this request is wrapping a RendeRequest or ActionRequest the properties are returned. Null is returned if the underlying request does not support headers.

  Returns:

  request header value found on the EbiRequest's HttpServletRequest or property values found in the PortletRequest (Action or Render).

  getParameter

  public String getParameter(String parameter)

  Returns an request parameter value, associated with the passed parameter, from the EbiRequest's wrapped HttpServletRequest, RenderRequest, or ActionRequest.

  Returns:

  request parameter value found on the EbiRequest

  getParameterValues

  public String[] getParameterValues(String parameter)

  Returns an Array of request parameter values, associated with the passed parameter, from the EbiRequest's wrapped HttpServletRequest, RenderRequest, or ActionRequest.

  Returns:

  Array of request parameter values found on the EbiRequest

  getParameterNames

  public Enumeration getParameterNames()

  Retrieves an enumeration of names that are contained in the request params

  Returns:

  names of the the parameters contained on the request

  getPassword

  public String getPassword()

  Deprecated.

  Obtains the users password from the http base 64 encoded authentication header

  getQueryString

  public String getQueryString()

  Deprecated.

  Returns the query string from the EbiRequest's HttpServletRequest. If the request does not have a HttpServletRequest, null is returned.

  To get the query string from an http servlet request use:

     EbiRequest req = ctxt.getEbiRequest();
     if (req instanceof EbiHttpRequest){
       HttpServletRequest req = ((EbiHttpRequest)req).getHttpServletRequest();
       String query = req.getQueryString();
     }
   

  Returns:

  Query string from the EbiRequest's HttpServletRequest.

  getServer

  public String getServer()

  Try and determine the server name from the request. If this is not a http, renderRequest, or actionRequest then it is assumed that the server name is equal to that known by the environment.

  Returns:

  The application server name.

  getSession

  public HttpSession getSession()

  Deprecated.

  Returns the HttpSession from the EbiRequest's HttpServletRequest.

  If the wrapped request is not an HttpServletrequest java.lang.UnsupportedOperationException is thrown

  Use the EbiContext.getEbiWhiteboard() method and use the white board to set session attributes. This provides a level of abstraction over the session.

  If you absolutely need the underlying http session use:

     EbiRequest req = ctxt.getEbiRequest();
     if (req instanceof EbiHttpRequest){
       HttpServletRequest req = ((EbiHttpRequest)req).getHttpServletRequest();
       HttpSession session = req.getSession();
     }
   

  Returns:

  HttpSession from the EbiRequest's HttpServletRequest.

  See Also:

  EbiWhiteboard, EbiContext

  getUserID

  public String getUserID()

  Deprecated.

  Obtains the id that the user signed into http basic authentication with The ID is unencoded from the authentication header

  You can get the user ID from the framework by using the following example:

   EbiRealmUser user = EboDirectoryHelper.getEbiRealmUser(context);
   

  See Also:

  EbiRealmUser

  hasHttpServletRequest

  public boolean hasHttpServletRequest()

  Checks to see if this request has an HttpServletRequest.

  false is returned if isHttpRequest() is false or the httpRequest is null,

  Returns:

  true if this request has a valid HttpServletRequest.

  hasQueryString

  public boolean hasQueryString()

  Checks to see if the HttpServletRequest has a Query String. Meaningless for non HttpServletRequest in which case null is returned

  Returns:

  true if the HttpServletRequest, associated with this EbiRequest, has a Query String.

  isHttpRequest

  public boolean isHttpRequest()

  Checks to see if the wrapped request is an HttpServletRequest.

  Returns:

  true if this request is an HttpServletRequest.

  isNewSession

  public boolean isNewSession()

  True if the the session from the wrapped request is a new session.

  Returns:

  true if the session from the EbiRequest's wrapped request is a new session.