|
Oracle® WebCenter Content Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.stellent.wcm.client.RequestContext
oracle.stellent.wcm.client.script.vm.VelocityRequestContext
public class VelocityRequestContext
Wrap the RequestContext and allow setting of attributes in current Velocity context instead of page context
Constructor Summary | |
---|---|
VelocityRequestContext(RequestContext requestContext) |
Method Summary | |
---|---|
boolean |
containsKey(java.lang.Object key) Indicates whether the specified key is in the context. |
java.lang.Object |
get(java.lang.String key) Gets the value corresponding to the provided key from the context. |
java.lang.Object |
getAttribute(java.lang.String name) Retrieve an attribute value |
java.util.Set<java.lang.String> |
getAttributeNames() Retrieve the attribute names for the given scope |
java.lang.String |
getContextPath() |
java.lang.Object[] |
getKeys() Get all the keys for the values in the context. |
java.util.Map<java.lang.String,java.lang.String> |
getParameters() |
java.lang.String |
getRequestPath() |
java.security.Principal |
getUserPrincipal() |
RequestContext |
getWrappedContext() |
java.io.Writer |
getWriter() |
protected void |
processImpl(java.lang.String path, boolean forward) Execute the path |
java.lang.Object |
put(java.lang.String key, java.lang.Object value) Adds a name/value pair to the context. |
java.lang.Object |
remove(java.lang.Object key) Removes the value associated with the specified key from the context. |
void |
sendRedirect(java.lang.String path) Send a redirect |
void |
setAttribute(java.lang.String name, java.lang.Object value) Set an attribute value by name |
void |
setHeader(java.lang.String name, java.lang.String value) Set a response header |
Methods inherited from class oracle.stellent.wcm.client.RequestContext |
---|
forward, getParameter, getSiteContext, include, process, setSiteContext, swapAttributes |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public VelocityRequestContext(RequestContext requestContext)
Method Detail |
---|
public RequestContext getWrappedContext()
public java.lang.Object put(java.lang.String key, java.lang.Object value)
put
in interface org.apache.velocity.context.Context
key
- The name to key the provided value with.value
- The corresponding value.public java.lang.Object get(java.lang.String key)
get
in interface org.apache.velocity.context.Context
key
- The name of the desired value.public boolean containsKey(java.lang.Object key)
containsKey
in interface org.apache.velocity.context.Context
key
- The key to look for.public java.lang.Object[] getKeys()
getKeys
in interface org.apache.velocity.context.Context
public java.lang.Object remove(java.lang.Object key)
remove
in interface org.apache.velocity.context.Context
key
- The name of the value to remove.null
if unmapped.public void setAttribute(java.lang.String name, java.lang.Object value)
setAttribute
in class RequestContext
name
- the namevalue
- the value (null to remove)public java.lang.Object getAttribute(java.lang.String name)
getAttribute
in class RequestContext
name
- the namepublic java.util.Map<java.lang.String,java.lang.String> getParameters()
getParameters
in class RequestContext
public java.lang.String getContextPath()
getContextPath
in class RequestContext
HttpServletRequest.getContextPath()
public java.lang.String getRequestPath()
getRequestPath
in class RequestContext
public java.security.Principal getUserPrincipal()
getUserPrincipal
in class RequestContext
public void sendRedirect(java.lang.String path) throws java.io.IOException
sendRedirect
in class RequestContext
path
- the path to redirectjava.io.IOException
public void setHeader(java.lang.String name, java.lang.String value)
setHeader
in class RequestContext
name
- the namevalue
- the valuepublic java.io.Writer getWriter() throws java.io.IOException
getWriter
in class RequestContext
java.io.IOException
public java.util.Set<java.lang.String> getAttributeNames()
getAttributeNames
in class RequestContext
protected void processImpl(java.lang.String path, boolean forward) throws java.lang.Exception
processImpl
in class RequestContext
path
- the web application pageforward
- true to forward, false to includejava.lang.Exception
|
Oracle® WebCenter Content Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |