Package org.ametys.core.ui.dispatcher

Class DispatchGenerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.generation.AbstractGenerator

org.apache.cocoon.generation.ServiceableGenerator

org.ametys.core.ui.dispatcher.DispatchGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

Direct Known Subclasses:

DispatchGenerator

public class DispatchGenerator
extends ServiceableGenerator

This generator read the request incoming from the client org.ametys.servercomm.ServerComm component, then dispatch it to given url and aggregate the result

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DispatchGenerator.ResponseHandler	Wrap the handler ignore start and end document, but adding a response tag.

Field Summary

Fields

Modifier and Type	Field	Description
protected RequestAttributesHelper	_requestAttributesHelper	Request Attributes Helper

Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

Constructors

Constructor	Description
DispatchGenerator()

Method Summary

Modifier and Type	Method	Description
protected String	_createUrl(String pluginOrWorkspace, String relativeUrl, Map<String,Object> requestParameters)	Create url to call
protected String	_getUrlPrefix(String pluginOrWorkspace)	Get the url prefix
protected void	_setContextInRequestAttributes(Map<String,Object> contextAsMap)	Set the request attributes from the contextual parameters
void	generate()
void	service(ServiceManager smanager)
protected Map<String,Object>	transmitAttributes(Map<String,Object> attributes)	Filters attributes that should be transmitted to the dispatched request

Methods inherited from class org.apache.cocoon.generation.ServiceableGenerator

dispose

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle, setup

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Details

_requestAttributesHelper

protected RequestAttributesHelper _requestAttributesHelper

Request Attributes Helper

Constructor Details

DispatchGenerator

public DispatchGenerator()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

generate

public void generate()
              throws IOException,
SAXException,
ProcessingException

Throws:

IOException

SAXException

ProcessingException

transmitAttributes

protected Map<String,Object> transmitAttributes(Map<String,Object> attributes)

Filters attributes that should be transmitted to the dispatched request

Parameters:

attributes - The full list of attributes

Returns:

The attributes filtered

_setContextInRequestAttributes

protected void _setContextInRequestAttributes(Map<String,Object> contextAsMap)

Set the request attributes from the contextual parameters

Parameters:

contextAsMap - The contextual parameters

_createUrl

protected String _createUrl(String pluginOrWorkspace,
 String relativeUrl,
 Map<String,Object> requestParameters)

Create url to call

Parameters:

pluginOrWorkspace - the plugin or workspace name

relativeUrl - the relative url

requestParameters - the request parameters. Can not be null.

Returns:

the full url

_getUrlPrefix

protected String _getUrlPrefix(String pluginOrWorkspace)

Get the url prefix

Parameters:

pluginOrWorkspace - the plugin or workspace name

Returns:

the url prefix