Skip navigation links

oracle.stellent.wcm.client.invokers
Class RequestInvoker<T extends SiteRequest>

java.lang.Object
oracle.stellent.wcm.client.invokers.RequestInvoker<T>

Direct Known Subclasses:

ContributableInvoker, ContributorJSInvoker, DataFileInvoker, PageInvoker, VarInvoker

public class RequestInvoker<T extends SiteRequest>

extends java.lang.Object

Generic interface for invoking a particular request

Field Summary

protected ILog

m_log

Constructor Summary

RequestInvoker(RequestContext requestContext, ClientApplication clientApplication, java.lang.Class<T> type)

Method Summary

protected T	createSiteRequest() Create a new site request object
protected void	finishRequest() Cleanup after a request invocation
ClientApplication	getClientApplication()
RequestContext	getRequestContext()
ResponseHandler	getResponseHandler()
SiteContext	getSiteContext()
T	getSiteRequest() Retrieve the associated request, populated with default parameters
SiteResponse	getSiteResponse()
java.lang.Class<T>	getType()
protected void	handleResponse() Handle the response of the site request; by default uses a ResponseHandler to draw the output
void	invokeRequest() Invoke the associated site request
boolean	isPropagateResponseErrors()
void	setPropagateResponseErrors(boolean propagateResponseErrors)
void	setResponseHandler(ResponseHandler responseHandler) Set a custom response handler

Methods inherited from class java.lang.Object

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

Field Detail

m_log

protected ILog m_log

Constructor Detail

RequestInvoker

public RequestInvoker(RequestContext requestContext,
                      ClientApplication clientApplication,
                      java.lang.Class<T> type)
               throws ApplicationException

Throws:

ApplicationException

Method Detail

getResponseHandler

public ResponseHandler getResponseHandler()

setResponseHandler

public void setResponseHandler(ResponseHandler 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

getType

public java.lang.Class<T> getType()

Returns:

the type of request

getSiteRequest

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

isPropagateResponseErrors

public boolean isPropagateResponseErrors()

Returns:

true if the errors that occur while rendering the response are propagated; false if they are handled

setPropagateResponseErrors

public void setPropagateResponseErrors(boolean propagateResponseErrors)

invokeRequest

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

Invoke the associated site request

Throws:

ApplicationException

java.io.IOException

createSiteRequest

protected T createSiteRequest()

Create a new site request object

Returns:

the site request

finishRequest

protected void finishRequest()

Cleanup after a request invocation

handleResponse

protected void handleResponse()
                       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