Skip navigation links

oracle.stellent.wcm.server.request
Class SiteRequest

java.lang.Object
oracle.stellent.wcm.server.request.SiteRequest

Direct Known Subclasses:

ContributorJSRequest, DataFileRequest, DynamicListRequest, IdcServiceRequest, MetadataRequest, PageRequest, UrlRequest

public class SiteRequest

extends java.lang.Object

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()
<T> T	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

PARAM_FORCE_CONTRIBUTOR

public static final java.lang.String PARAM_FORCE_CONTRIBUTOR

See Also:

Constant Field Values

PARAM_DESIGN_MODE

public static final java.lang.String PARAM_DESIGN_MODE

See Also:

Constant Field Values

PARAM_ALLOW_DESIGN_MODE

public static final java.lang.String PARAM_ALLOW_DESIGN_MODE

See Also:

Constant Field Values

FLAG_PREVIEW_MODE

public static final java.lang.String FLAG_PREVIEW_MODE

See Also:

Constant Field Values

FLAG_PREVIEW_ID

public static final java.lang.String FLAG_PREVIEW_ID

See Also:

Constant Field Values

FLAG_SHOW_PLACEHOLDER_PROPERTIES

public static final java.lang.String FLAG_SHOW_PLACEHOLDER_PROPERTIES

See Also:

Constant Field Values

FLAG_START_REQUEST_THREAD

public static final java.lang.String FLAG_START_REQUEST_THREAD

See Also:

Constant Field Values

Constructor Detail

SiteRequest

public SiteRequest(SiteLocation location)

Minimum needed to set the context

Parameters:

location - the site location

Method Detail

copyRequest

public static void copyRequest(SiteRequest source,
                               SiteRequest destination)

Copy the request information from the source request into the destination request.

Parameters:

source - the source request

destination - the request to copy the information into

getLocation

public SiteLocation getLocation()

setLocation

public void setLocation(SiteLocation location)

getRetrievalMode

public RetrievalMode getRetrievalMode()

Returns:

the retrieval mode to use for this request

setRetrievalMode

public void setRetrievalMode(RetrievalMode retrievalMode)

getRevision

public ContentID.Revision getRevision()

Returns:

the revision of the content to retrieve for this request

setRevision

public void setRevision(ContentID.Revision revision)

getSiteParameters

public java.util.Map<java.lang.String,java.lang.String> getSiteParameters()

getIdcContext

public oracle.stellent.ridc.IdcContext getIdcContext()

Returns:

the identity of the user executing the request

setIdcContext

public void setIdcContext(oracle.stellent.ridc.IdcContext idcContext)

getFlag

public java.lang.String getFlag(java.lang.String name)

Retrieve a flag

Parameters:

name - the flag name

Returns:

the flag value or null if not set

setFlag

public void setFlag(java.lang.String name,
                    java.lang.String value)

Set a flag

Parameters:

name - the flag name

value - the flag value

getFlagNames

public java.util.Set<java.lang.String> getFlagNames()

Returns:

the flag names

getTransientObject

public <T> T getTransientObject(java.lang.String name)

setTransientObject

public void setTransientObject(java.lang.String name,
                               java.lang.Object value)

clearTransientObjects

public void clearTransientObjects()

getMode

public SiteRequest.Mode getMode()

Returns:

the mode

setMode

public void setMode(SiteRequest.Mode mode)

isContributionOrDesignerMode

public boolean isContributionOrDesignerMode()

Returns:

true if this is a contributor or designer mode

isDesignerMode

public boolean isDesignerMode()

Is this is the designer mode

Returns:

true if this is a designer mode

isContributorMode

public boolean isContributorMode()

Is this the contributor mode? This checks only for contributor mode, not designer mode. Use isContributionOrDesignerMode() to check for both.

Returns:

true if this is in contribution mode

isConsumptionMode

public boolean isConsumptionMode()

Is this the consumption mode

Returns:

true if this is consumption mode

getUrlPatterns

public java.util.Map<UrlRequest.UrlRoot,java.lang.String> getUrlPatterns()

setUrlPatterns

public void setUrlPatterns(java.util.Map<UrlRequest.UrlRoot,java.lang.String> urlPatterns)

Skip navigation links