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 and 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 and Description
private DispatchProcessExtensionPoint	_dispatchProcessExtensionPoint
private JSONUtils	_jsonUtils
private SourceResolver	_resolver
private SAXParser	_saxParser

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 and Description
DispatchGenerator()

Method Summary

Modifier and Type	Method and Description
private StringBuilder	_buildQueryParameter(String key, Object value)
protected String	_createUrl(String pluginOrWorkspace, String relativeUrl, Map<String,Object> requestParameters) Create url to call
private void	_dispatching(Map<String,Object> parametersAsMap, Map<String,Object> contextAsMap)
private String	_escape(String value)
private String	_getRelativePath(String url)
private String	_getRequestBody()
private String	_getRequestContext()
protected String	_getUrlPrefix(String pluginOrWorkspace) Get the url prefix
private void	_removeRequestAttributes()
private void	_restoreRequestAttributes(Map<String,Object> attributes) Clean the requests attributes and add those in the map
private Map<String,Object>	_saveRequestAttributes() Transforms the request attributes into a map and clean the attributes
protected void	_setContextInRequestAttributes(Map<String,Object> contextAsMap) Set the request attributes from the contextual parameters
private Throwable	_unroll(Throwable initial)
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 Detail

_resolver

private SourceResolver _resolver

_saxParser

private SAXParser _saxParser

_dispatchProcessExtensionPoint

private DispatchProcessExtensionPoint _dispatchProcessExtensionPoint

_jsonUtils

private JSONUtils _jsonUtils

Constructor Detail

DispatchGenerator

public DispatchGenerator()

Method Detail

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

_getRequestBody

private String _getRequestBody()

_getRequestContext

private String _getRequestContext()

_dispatching

private void _dispatching(Map<String,Object> parametersAsMap,
                          Map<String,Object> contextAsMap)
                   throws SAXException

Throws:

SAXException

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

_unroll

private Throwable _unroll(Throwable initial)

_restoreRequestAttributes

private void _restoreRequestAttributes(Map<String,Object> attributes)

Clean the requests attributes and add those in the map

Parameters:

attributes - The attributes to restore

_removeRequestAttributes

private void _removeRequestAttributes()

_setContextInRequestAttributes

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

Set the request attributes from the contextual parameters

Parameters:

contextAsMap - The contextual parameters

_saveRequestAttributes

private Map<String,Object> _saveRequestAttributes()

Transforms the request attributes into a map and clean the attributes

Returns:

A copy of all the request attributes

_escape

private String _escape(String value)

_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

_getRelativePath

private String _getRelativePath(String url)

_buildQueryParameter

private StringBuilder _buildQueryParameter(String key,
                                           Object value)

_getUrlPrefix

protected String _getUrlPrefix(String pluginOrWorkspace)

Get the url prefix

Parameters:

pluginOrWorkspace - the plugin or workspace name

Returns:

the url prefix