Skip navigation links

oracle.stellent.wcm.client.invokers.impl
Class UrlInvoker

java.lang.Object
oracle.stellent.wcm.client.invokers.SiteRequestInvoker<T>
oracle.stellent.wcm.client.invokers.impl.VarInvoker<UrlRequest>
oracle.stellent.wcm.client.invokers.impl.UrlInvoker

public class UrlInvoker

extends VarInvoker<UrlRequest>

Handle invocation of the UrlRequest

Nested Class Summary

static class

UrlInvoker.WcmUrl Handles controlling the output of the URL to optionally include the context path

Constructor Summary

UrlInvoker(RequestContext requestContext, ClientApplication clientApplication)

Method Summary

protected UrlRequest	createSiteRequest() Create a new site request object
java.lang.Object	getVarObject()
protected void	handleSiteResponse() Handle the response of the site request; by default uses a ResponseHandler to draw the output
boolean	isIncludeContext()
boolean	isPropagateErrors()
void	setIncludeContext(boolean includeContext)
void	setPropagateErrors(boolean propagateErrors)

Methods inherited from class oracle.stellent.wcm.client.invokers.impl.VarInvoker

getVarName, setVarName

Methods inherited from class oracle.stellent.wcm.client.invokers.SiteRequestInvoker

finishSiteRequest, getClientApplication, getRequestContext, getSiteContext, getSiteRequest, getSiteResponse, getSiteResponseHandler, invokeSiteRequest, setPropagateResponseErrors, setSiteResponseHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlInvoker

public UrlInvoker(RequestContext requestContext,
                  ClientApplication clientApplication)
           throws ApplicationException

Throws:

ApplicationException

Method Detail

isIncludeContext

public boolean isIncludeContext()

Returns:

if true, include the context by default

setIncludeContext

public void setIncludeContext(boolean includeContext)

isPropagateErrors

public boolean isPropagateErrors()

Returns:

true to propagate any errors; this is false by default so the URL handler does not affect the page render

setPropagateErrors

public void setPropagateErrors(boolean propagateErrors)

createSiteRequest

protected UrlRequest createSiteRequest()

Create a new site request object

Overrides:

createSiteRequest in class SiteRequestInvoker<UrlRequest>

Returns:

the site request

handleSiteResponse

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

Description copied from class: VarInvoker

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

Overrides:

handleSiteResponse in class VarInvoker<UrlRequest>

Throws:

ApplicationException

java.io.IOException

getVarObject

public java.lang.Object getVarObject()
                              throws ApplicationException

Specified by:

getVarObject in class VarInvoker<UrlRequest>

Returns:

the object to expose

Throws:

ApplicationException

Skip navigation links