Skip navigation links

oracle.stellent.wcm.server.request
Class SiteRequestLogic<R extends SiteRequest>

java.lang.Object
oracle.stellent.wcm.server.request.SiteRequestLogic<R>

Direct Known Subclasses:

ContributorJSLogic, DataFileLogic, DynamicListLogic, ElementLogic, IdcServiceLogic, PageLogic, UrlLogic

public class SiteRequestLogic<R extends SiteRequest>

extends java.lang.Object

Base logic for all command objects

Constructor Summary

SiteRequestLogic(ClientApplication clientApplication)

Method Summary

boolean	checkSecurity(R request, LazyLoadingContent content) Check the security of this content item.
boolean	checkSecurity(R pageRequest, SectionNode section) Determine if the user has access rights to the given section
ClientApplication	getClientApplication()
ProjectFile	getProject(SiteRequest siteRequest) Retrieve the project associated with this site request.
ProjectFile	getProject(SiteRequest siteRequest, boolean errorIfNotFound) Retrieve the project associated with this site request.
SectionNode	getSection(SiteRequest siteRequest)
SectionNode	getSection(SiteRequest siteRequest, boolean errorIfNotFound)
SectionTree	getStructure(SiteRequest siteRequest)
boolean	isSectionAvailable(R pageRequest, SectionNode section) Determine if the section is available to the user
void	setRequestSiteID(R siteRequest, java.lang.String siteID) Reset the siteID for this request.
void	validateSiteRequest(R siteRequest) Verify the request parameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiteRequestLogic

public SiteRequestLogic(ClientApplication clientApplication)

Method Detail

getClientApplication

public ClientApplication getClientApplication()

Returns:

the server application

validateSiteRequest

public void validateSiteRequest(R siteRequest)
                         throws SiteRequestException

Verify the request parameters

Parameters:

siteRequest - the request

Throws:

SiteRequestException - if the parameters are not valid

setRequestSiteID

public void setRequestSiteID(R siteRequest,
                             java.lang.String siteID)
                      throws SiteRequestException

Reset the siteID for this request. Ensures the given siteID is valid and all current request-level caches are cleared.

Parameters:

siteRequest - the current request

siteID - the site ID to verify

Throws:

SiteRequestException - thrown if the site ID is invalid

getSection

public SectionNode getSection(SiteRequest siteRequest)
                       throws SiteRequestException

Parameters:

siteRequest - the site request

Returns:

the section associated with this request

Throws:

SiteRequestException

getSection

public SectionNode getSection(SiteRequest siteRequest,
                              boolean errorIfNotFound)
                       throws SiteRequestException

Parameters:

siteRequest - the site request

errorIfNotFound - true to throw an error if not found

Returns:

the section associated with this request

Throws:

SiteRequestException

getStructure

public SectionTree getStructure(SiteRequest siteRequest)
                         throws SiteRequestException

Parameters:

siteRequest - the request

Returns:

the structure associated with this request

Throws:

SiteRequestException

getProject

public ProjectFile getProject(SiteRequest siteRequest)
                       throws SiteRequestException

Retrieve the project associated with this site request.

Parameters:

siteRequest - the site request

Returns:

the project associated with this request

Throws:

SiteRequestException

getProject

public ProjectFile getProject(SiteRequest siteRequest,
                              boolean errorIfNotFound)
                       throws SiteRequestException

Retrieve the project associated with this site request.

Parameters:

siteRequest - the site request

errorIfNotFound - true to throw an error if not found

Returns:

the project associated with this request

Throws:

SiteRequestException

isSectionAvailable

public boolean isSectionAvailable(R pageRequest,
                                  SectionNode section)

Determine if the section is available to the user

Parameters:

pageRequest - the page request

section - the section to verify

Returns:

true if the user can see the requested section

checkSecurity

public boolean checkSecurity(R pageRequest,
                             SectionNode section)
                      throws SiteRequestException

Determine if the user has access rights to the given section

Parameters:

pageRequest - the page request

section - the section to verify

Returns:

true if the user can see the requested section

Throws:

SiteRequestException - if an error occurs while executing the security check

checkSecurity

public boolean checkSecurity(R request,
                             LazyLoadingContent content)
                      throws SiteRequestException

Check the security of this content item.

Parameters:

request - the request

content - the content

Returns:

true if the user has access

Throws:

SiteRequestException

Skip navigation links