org.inria.ns.reflex.modules.web
Class XRequest

java.lang.Object
  extended by org.inria.ns.reflex.xml.XComponent
      extended by org.inria.ns.reflex.modules.web.XRequest
All Implemented Interfaces:
NamedType, ChildItem, Renamable, Unwrappable, XOperable

public final class XRequest
extends XComponent
implements Unwrappable

XRequest (#web:x-request) wraps an HttpServletRequest and exposes it as an XComponent.

Author:
Philippe Poulard
See Also:
HttpServletRequest

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.inria.ns.reflex.structures.Unwrappable
Unwrappable.Unwrapper
 
Field Summary
 
Fields inherited from interface org.inria.ns.reflex.structures.Unwrappable
UNWRAPPER
 
Constructor Summary
XRequest(HttpServletRequest request)
          Create an XComponent of the type #web:x-request that wraps an HttpServletRequest.
 
Method Summary
 EntryMap getAttributes()
           
 List getChildren()
           
 Object getParent()
          Return the parent of this child.
 QName getQName()
           
 QName getTypeName()
          Return #web:x-request.
 XOperator getXOperator()
          Return the XOperator of this object.
 void rename(QName newName)
          Rename this object.
 void setAttributes(EntryMap attributes)
           
 void setMatchGroup(String[] groups)
          Set the string groups that were matched by the regular expression.
 void setTypeName(QName typeName)
          Set the type of this component.
 Object unwrap()
          Return the HTTP request.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XRequest

public XRequest(HttpServletRequest request)
Create an XComponent of the type #web:x-request that wraps an HttpServletRequest.

Parameters:
request - The HTTP request to wrap.
See Also:
HttpServletRequest
Method Detail

setMatchGroup

public void setMatchGroup(String[] groups)
Set the string groups that were matched by the regular expression.

Parameters:
groups - The group of matched strings.

getTypeName

public QName getTypeName()
Return #web:x-request.

Specified by:
getTypeName in interface NamedType
Returns:
web:x-request

unwrap

public Object unwrap()
Return the HTTP request. May be cast safely to HttpServletRequest.

Specified by:
unwrap in interface Unwrappable
Returns:
The HTTP request.
See Also:
Unwrappable.unwrap(), HttpServletRequest

getXOperator

public XOperator getXOperator()
Return the XOperator of this object.

Specified by:
getXOperator in interface XOperable
Returns:
The XOperator of this object.
See Also:
XOperable.getXOperator()

setAttributes

public void setAttributes(EntryMap attributes)
See Also:
Configurable.setAttributes(java.util.Map)

getAttributes

public EntryMap getAttributes()
See Also:
Configurable.getAttributes()

getChildren

public List getChildren()

rename

public void rename(QName newName)
Description copied from interface: Renamable
Rename this object.

Specified by:
rename in interface Renamable
Parameters:
newName - The new name of the object.

getQName

public QName getQName()

setTypeName

public void setTypeName(QName typeName)
Set the type of this component.

Parameters:
typeName - The name of the type.
Throws:
IllegalStateException - When the type has been already set.

getParent

public Object getParent()
Description copied from interface: ChildItem
Return the parent of this child.

Specified by:
getParent in interface ChildItem
Returns:
Its parent, that may be null for an orphan.