|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.stellent.wcm.client.RequestContext
public abstract class RequestContext
Holds objects for the context in the application server.
Constructor Summary | |
---|---|
protected |
RequestContext() |
Method Summary | |
---|---|
protected abstract void |
executePath(java.lang.String path, boolean forward) Execute the path |
protected java.util.List<RequestAttribute> |
exposeObjects(java.util.Map<java.lang.String,java.lang.Object> objects) Expose the given objects into the request context |
void |
forward(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> objects) Forward a resource into the current request. |
abstract java.lang.Object |
getAttribute(java.lang.String name) Retrieve an attribute value |
abstract java.util.Set<java.lang.String> |
getAttributeNames() Retrieve the attribute names for the given scope |
abstract java.lang.String |
getContextPath() |
java.lang.String |
getParameter(java.lang.String name) Retrieve a parameter value by name |
abstract java.util.Map<java.lang.String,java.lang.String> |
getParameters() |
abstract java.lang.String |
getRequestPath() |
SiteContext |
getSiteContext() |
abstract java.security.Principal |
getUserPrincipal() |
abstract java.io.Writer |
getWriter() |
void |
include(java.lang.String path) Include a resource into the current request |
void |
include(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> objects) Include a resource into the current request. |
protected void |
process(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> objects, boolean forward) Forward a resource into the current request. |
protected void |
restoreObjects(java.util.List<RequestAttribute> existingObjects) Restore the existing objects back to their original state |
abstract void |
sendRedirect(java.lang.String path) Send a redirect |
abstract void |
setAttribute(java.lang.String name, java.lang.Object value) Set an attribute value by name |
abstract void |
setHeader(java.lang.String name, java.lang.String value) Set a response header |
void |
setSiteContext(SiteContext siteContext) Set the site context on this request |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected RequestContext()
Method Detail |
---|
public abstract java.io.Writer getWriter() throws java.io.IOException
java.io.IOException
public abstract void setAttribute(java.lang.String name, java.lang.Object value)
name
- the namevalue
- the value (null to remove)public abstract java.lang.Object getAttribute(java.lang.String name)
name
- the namepublic abstract java.util.Set<java.lang.String> getAttributeNames()
public abstract java.util.Map<java.lang.String,java.lang.String> getParameters()
public abstract java.lang.String getContextPath()
HttpServletRequest.getContextPath()
public abstract java.lang.String getRequestPath()
public abstract java.security.Principal getUserPrincipal()
public abstract void sendRedirect(java.lang.String path) throws java.io.IOException
path
- the path to redirectjava.io.IOException
public abstract void setHeader(java.lang.String name, java.lang.String value)
name
- the namevalue
- the valuepublic SiteContext getSiteContext()
public void setSiteContext(SiteContext siteContext)
siteContext
- the site contextpublic void include(java.lang.String path) throws ApplicationException, java.io.IOException
path
- the path to the resourceApplicationException
java.io.IOException
public void include(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> objects) throws ApplicationException, java.io.IOException
path
- the pathobjects
- the objects, may be nullApplicationException
java.io.IOException
public void forward(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> objects) throws ApplicationException, java.io.IOException
path
- the pathobjects
- the objects, may be nullApplicationException
java.io.IOException
public java.lang.String getParameter(java.lang.String name)
name
- the nameServletRequest.getParameter(String)
protected void process(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> objects, boolean forward) throws ApplicationException, java.io.IOException
path
- the pathobjects
- the objects, may be nullforward
- true to forward, false to includeApplicationException
java.io.IOException
protected java.util.List<RequestAttribute> exposeObjects(java.util.Map<java.lang.String,java.lang.Object> objects)
objects
- the objectsprotected void restoreObjects(java.util.List<RequestAttribute> existingObjects)
existingObjects
- the existing objectsprotected abstract void executePath(java.lang.String path, boolean forward) throws java.lang.Exception
path
- the web application pageforward
- true to forward, false to includejava.lang.Exception
|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |