|
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.server.request.SiteRequest
public class SiteRequest
Represents the context around an individual request to an OpenWCM Site. Holds the user identity, path, parameters and attributes required to execute the request.
Nested Class Summary | |
---|---|
static class |
SiteRequest.ContextType RESOURCES = root of the web path for resources (CSS, JS, etc.) SERVER = root of the web application hosting the sites SITE = root of the web site IDC = root of the Content Server IDC_CGI = root of the Content Server CGI interface |
static class |
SiteRequest.Mode Mode of the client issuing the request |
Field Summary | |
---|---|
static java.lang.String |
FLAG_PREVIEW_ID |
static java.lang.String |
FLAG_PREVIEW_MODE |
static java.lang.String |
FLAG_SHOW_PLACEHOLDER_PROPERTIES |
static java.lang.String |
FLAG_START_REQUEST_THREAD |
static java.lang.String |
PARAM_ALLOW_DESIGN_MODE |
static java.lang.String |
PARAM_DESIGN_MODE |
static java.lang.String |
PARAM_FORCE_CONTRIBUTOR |
Constructor Summary | |
---|---|
SiteRequest(SiteLocation location) Minimum needed to set the context |
Method Summary | ||
---|---|---|
void |
clearTransientObjects() |
|
static void |
copyRequest(SiteRequest source, SiteRequest destination) Copy the request information from the source request into the destination request. |
|
java.lang.String |
getFlag(java.lang.String name) Retrieve a flag |
|
java.util.Set<java.lang.String> |
getFlagNames() |
|
oracle.stellent.ridc.IdcContext |
getIdcContext() |
|
SiteLocation |
getLocation() |
|
SiteRequest.Mode |
getMode() |
|
RetrievalMode |
getRetrievalMode() |
|
ContentID.Revision |
getRevision() |
|
java.util.Map<java.lang.String,java.lang.String> |
getSiteParameters() |
|
|
getTransientObject(java.lang.String name) |
|
java.util.Map<UrlRequest.UrlRoot,java.lang.String> |
getUrlPatterns() |
|
boolean |
isConsumptionMode() Is this the consumption mode |
|
boolean |
isContributionOrDesignerMode() |
|
boolean |
isContributorMode() Is this the contributor mode? This checks only for contributor mode, not designer mode. |
|
boolean |
isDesignerMode() Is this is the designer mode |
|
void |
setFlag(java.lang.String name, java.lang.String value) Set a flag |
|
void |
setIdcContext(oracle.stellent.ridc.IdcContext idcContext) |
|
void |
setLocation(SiteLocation location) |
|
void |
setMode(SiteRequest.Mode mode) |
|
void |
setRetrievalMode(RetrievalMode retrievalMode) |
|
void |
setRevision(ContentID.Revision revision) |
|
void |
setTransientObject(java.lang.String name, java.lang.Object value) |
|
void |
setUrlPatterns(java.util.Map<UrlRequest.UrlRoot,java.lang.String> urlPatterns) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PARAM_FORCE_CONTRIBUTOR
public static final java.lang.String PARAM_DESIGN_MODE
public static final java.lang.String PARAM_ALLOW_DESIGN_MODE
public static final java.lang.String FLAG_PREVIEW_MODE
public static final java.lang.String FLAG_PREVIEW_ID
public static final java.lang.String FLAG_SHOW_PLACEHOLDER_PROPERTIES
public static final java.lang.String FLAG_START_REQUEST_THREAD
Constructor Detail |
---|
public SiteRequest(SiteLocation location)
location
- the site locationMethod Detail |
---|
public static void copyRequest(SiteRequest source, SiteRequest destination)
source
- the source requestdestination
- the request to copy the information intopublic SiteLocation getLocation()
public void setLocation(SiteLocation location)
public RetrievalMode getRetrievalMode()
public void setRetrievalMode(RetrievalMode retrievalMode)
public ContentID.Revision getRevision()
public void setRevision(ContentID.Revision revision)
public java.util.Map<java.lang.String,java.lang.String> getSiteParameters()
public oracle.stellent.ridc.IdcContext getIdcContext()
public void setIdcContext(oracle.stellent.ridc.IdcContext idcContext)
public java.lang.String getFlag(java.lang.String name)
name
- the flag namepublic void setFlag(java.lang.String name, java.lang.String value)
name
- the flag namevalue
- the flag valuepublic java.util.Set<java.lang.String> getFlagNames()
public <T> T getTransientObject(java.lang.String name)
public void setTransientObject(java.lang.String name, java.lang.Object value)
public void clearTransientObjects()
public SiteRequest.Mode getMode()
public void setMode(SiteRequest.Mode mode)
public boolean isContributionOrDesignerMode()
public boolean isDesignerMode()
public boolean isContributorMode()
public boolean isConsumptionMode()
public java.util.Map<UrlRequest.UrlRoot,java.lang.String> getUrlPatterns()
public void setUrlPatterns(java.util.Map<UrlRequest.UrlRoot,java.lang.String> urlPatterns)
|
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 |