org.springframework.extensions.webscripts

Class WebScriptProcessor

java.lang.Object

org.springframework.extensions.surf.render.AbstractProcessor

org.springframework.extensions.webscripts.WebScriptProcessor

All Implemented Interfaces:

Processor

public class WebScriptProcessor
extends AbstractProcessor

The WebScriptRenderer is an implementation of Renderable which describes a rendering engine that the Web Framework can use to execute a web script.

A WebScriptRenderer can be used to execute a web script for any purpose so long as an appropriate RendererContext instance is passed to it.

Most commonly, the RendererContext passed in will describe a Component.

The renderer supports "full page refresh" link backs to a webscript. The LocalWebScriptResponse object is responsible for encoding compatible links via the scripturl() template method.

Author:

muzquiano, kevinr

Field Summary

Fields

Modifier and Type	Field and Description
static String	WEBSCRIPT_SERVICE_SERVLET The WebScript service servlet path

Fields inherited from class org.springframework.extensions.surf.render.AbstractProcessor

processorModelHelper

Constructor Summary

Constructors

Constructor and Description
WebScriptProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	executeBody(ProcessorContext pc, ModelObject object) Executes the "body" of the processor output using the given processor context.
void	executeHeader(ProcessorContext pc, ModelObject object) Executes the "header" of the processor output using the given processor context.
boolean	exists(ProcessorContext pc, ModelObject object) Indicates whether the engine responsible for processing the body of the processor exists.
LocalWebScriptRuntimeContainer	getContainer() Gets the container bean.
org.springframework.extensions.webscripts.Registry	getRegistry() Gets the web scripts registry.
void	setConfigService(org.springframework.extensions.config.ConfigService configService)
void	setContainer(LocalWebScriptRuntimeContainer containerBean) Sets the container bean.

Methods inherited from class org.springframework.extensions.surf.render.AbstractProcessor

execute, getProperty, getRenderingDescriptor, setProcessorModelHelper

Methods inherited from class java.lang.Object

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

Field Detail

WEBSCRIPT_SERVICE_SERVLET

public static final String WEBSCRIPT_SERVICE_SERVLET

The WebScript service servlet path

See Also:

Constant Field Values

Constructor Detail

WebScriptProcessor

public WebScriptProcessor()

Method Detail

setConfigService

public void setConfigService(org.springframework.extensions.config.ConfigService configService)

getRegistry

public org.springframework.extensions.webscripts.Registry getRegistry()

Gets the web scripts registry.

Returns:

the registry

setContainer

public void setContainer(LocalWebScriptRuntimeContainer containerBean)

Sets the container bean.

Parameters:

containerBean - the new container bean

getContainer

public LocalWebScriptRuntimeContainer getContainer()

Gets the container bean.

Returns:

the container bean

executeHeader

public void executeHeader(ProcessorContext pc,
                 ModelObject object)
                   throws RendererExecutionException

Description copied from interface: Processor

Executes the "header" of the processor output using the given processor context.

Specified by:

executeHeader in interface Processor

Overrides:

executeHeader in class AbstractProcessor

Parameters:

pc - processorContext

Throws:

RendererExecutionException

executeBody

public void executeBody(ProcessorContext pc,
               ModelObject object)
                 throws RendererExecutionException

Description copied from interface: Processor

Executes the "body" of the processor output using the given processor context.

Specified by:

executeBody in interface Processor

Specified by:

executeBody in class AbstractProcessor

Parameters:

pc - processorContext

Throws:

RendererExecutionException

exists

public boolean exists(ProcessorContext pc,
             ModelObject object)

Description copied from interface: Processor

Indicates whether the engine responsible for processing the body of the processor exists.

Parameters:

pc - ProcessorContext

object - ModelObject

Returns:

boolean