Skip navigation links

oracle.stellent.wcm.client.invokers
Class SiteRequestInvoker<R extends SiteRequest>

java.lang.Object
oracle.stellent.wcm.client.invokers.SiteRequestInvoker<R>

Direct Known Subclasses:

ContributableInvoker, ContributorJSInvoker, DataFileInvoker, PageInvoker, VarInvoker

public class SiteRequestInvoker<R extends SiteRequest>

extends java.lang.Object

Generic interface for invoking a particular request

Constructor Summary

SiteRequestInvoker(RequestContext requestContext, ClientApplication clientApplication, java.lang.Class<R> siteRequestClass)

Method Summary

protected R	createSiteRequest() Create a new site request object
protected void	finishSiteRequest() Cleanup after a request invocation
ClientApplication	getClientApplication()
RequestContext	getRequestContext()
SiteContext	getSiteContext()
R	getSiteRequest() Retrieve the associated request, populated with default parameters
SiteResponse	getSiteResponse()
SiteResponseHandler	getSiteResponseHandler()
protected void	handleSiteResponse() Handle the response of the site request; by default uses a ResponseHandler to draw the output
void	invokeSiteRequest() Invoke the associated site request
void	setPropagateResponseErrors(boolean propagateResponseErrors)
void	setSiteResponseHandler(SiteResponseHandler responseHandler) Set a custom response handler

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteRequestInvoker

public SiteRequestInvoker(RequestContext requestContext,
                          ClientApplication clientApplication,
                          java.lang.Class<R> siteRequestClass)
                   throws ApplicationException

Throws:

ApplicationException

Method Detail

getSiteResponseHandler

public SiteResponseHandler getSiteResponseHandler()

setSiteResponseHandler

public void setSiteResponseHandler(SiteResponseHandler responseHandler)

Set a custom response handler

Parameters:

responseHandler - the response handler

getRequestContext

public RequestContext getRequestContext()

Returns:

the request context

getClientApplication

public ClientApplication getClientApplication()

Returns:

the wcm application

getSiteContext

public SiteContext getSiteContext()

Returns:

the site context associated with this request

getSiteRequest

public R getSiteRequest()

Retrieve the associated request, populated with default parameters

Returns:

the site request

getSiteResponse

public SiteResponse getSiteResponse()

Returns:

the site response (valid only after calling invokeSiteRequest())

setPropagateResponseErrors

public void setPropagateResponseErrors(boolean propagateResponseErrors)

invokeSiteRequest

public void invokeSiteRequest()
                       throws ApplicationException,
                              java.io.IOException

Invoke the associated site request

Throws:

ApplicationException

java.io.IOException

createSiteRequest

protected R createSiteRequest()

Create a new site request object

Returns:

the site request

finishSiteRequest

protected void finishSiteRequest()

Cleanup after a request invocation

handleSiteResponse

protected void handleSiteResponse()
                           throws ApplicationException,
                                  java.io.IOException

Handle the response of the site request; by default uses a ResponseHandler to draw the output

Throws:

ApplicationException

java.io.IOException

Skip navigation links