Milyn-Smooks Version 0.4

org.milyn.container
Interface ContainerRequest

All Superinterfaces:
BoundAttributeStore, HttpRequest, Request
All Known Implementing Classes:
HttpServletContainerRequest

public interface ContainerRequest
extends HttpRequest, BoundAttributeStore

Smooks container request interface definition.

Author:
tfennelly

Method Summary
 void clearElementLists()
          Clear the list of ElementLists from this request.
 ContainerContext getContext()
          Get the container context within which this request "lives".
 java.lang.String getContextPath()
          Returns the portion of the request URI that indicates the context of the request.
 ContentDeliveryConfig getDeliveryConfig()
          Get the content delivery configuration for the useragent attached to this request.
 ElementList getElementList(java.lang.String name)
          Request utility method for "hooking" elements of the same name together within the context of a request.
 java.util.Enumeration getParameterNames()
          Returns an Enumeration of String objects containing the names of the parameters contained in this request.
 java.lang.String[] getParameterValues(java.lang.String name)
          Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
 java.net.URI getRequestURI()
          Returns the full request URI made by the requesting device (including the query string).
 ContainerSession getSession()
          Get the container session within which this request "lives".
 UAContext getUseragentContext()
          Get the UAContext instance for the useragent attached to this request.
 
Methods inherited from interface org.milyn.device.request.HttpRequest
getHeader, getParameter
 
Methods inherited from interface org.milyn.container.BoundAttributeStore
getAttribute, removeAttribute, setAttribute
 

Method Detail

getContextPath

public java.lang.String getContextPath()
Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character.

Returns:
String specifying the portion of the request URI that indicates the context of the request.

getRequestURI

public java.net.URI getRequestURI()
Returns the full request URI made by the requesting device (including the query string).

Returns:
The full request URI made by the requesting device.

getParameterNames

public java.util.Enumeration getParameterNames()
Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

Returns:
an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)
Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.

If the parameter has a single value, the array has a length of 1.

Parameters:
name - String containing the name of the parameter whose value is requested.
Returns:
an array of String objects containing the parameter's values.

getContext

public ContainerContext getContext()
Get the container context within which this request "lives".

Returns:
The ContainerContext instance.

getSession

public ContainerSession getSession()
Get the container session within which this request "lives".

Returns:
The ContainerSession instance.

getUseragentContext

public UAContext getUseragentContext()
Get the UAContext instance for the useragent attached to this request.

Returns:
UAContext instance.

getDeliveryConfig

public ContentDeliveryConfig getDeliveryConfig()
Get the content delivery configuration for the useragent attached to this request.

Returns:
ContentDeliveryConfigImpl instance.

getElementList

public ElementList getElementList(java.lang.String name)
Request utility method for "hooking" elements of the same name together within the context of a request.

Implementations must create the ElementList instance for the element if it doesn't exist.

Parameters:
name - The name of the element whose ElementList is being requested.
Returns:
ElementList for the element specified by the name param.
See Also:
clearElementLists()

clearElementLists

public void clearElementLists()
Clear the list of ElementLists from this request.

See Also:
getElementList(String)

Milyn-Smooks Version 0.4