Package org.ametys.plugins.workspaces.requests

Class HandleWorkspacesFoRequestGenerator

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.plugins.workspaces.requests.HandleWorkspacesFoRequestGenerator

All Implemented Interfaces:

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

public class HandleWorkspacesFoRequestGenerator
extends ServiceableGenerator

The purpose of this action is to handle front office requests. These requests are usually AJAX requests coming from services. The processing is loosely based on the DispatchGenerator

Field Summary

Fields

Modifier and Type	Field	Description
private CurrentUserProvider	_currentUserProvider
private DispatchProcessExtensionPoint	_dispatchProcessExtensionPoint	Dispatch process EP
private JSONUtils	_jsonUtils	JSON Utils

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
HandleWorkspacesFoRequestGenerator()

Method Summary

Modifier and Type	Method	Description
private StringBuilder	_buildQueryParameter(String key, Object value)
protected String	_createUrl(String pluginOrWorkspace, String relativeUrl, Map<String,Object> requestParameters)	Create url to call
private String	_escape(String value)
private Map<String,Object>	_extractFiles(Request request)
private String	_getRelativePath(String url)
protected String	_getUrlPrefix(String pluginOrWorkspace)	Get the url prefix
private void	_removeRequestAttributes()
private void	_restoreRequestAttributes(Request request, Map<String,Object> attributes)	Clean the requests attributes and add those in the map
private Map<String,Object>	_saveRequestAttributes(Request request)	Transforms the request attributes into a map and clean the attributes
private void	_setContextInRequestAttributes(Request request, Map<String,Object> reqContext)
private Map<String,Object>	_transmitAttributes(Map<String,Object> attributes)
private Throwable	_unroll(Throwable initial)
void	generate()
void	service(ServiceManager smanager)

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

_dispatchProcessExtensionPoint

private DispatchProcessExtensionPoint _dispatchProcessExtensionPoint

Dispatch process EP

_jsonUtils

private JSONUtils _jsonUtils

JSON Utils

_currentUserProvider

private CurrentUserProvider _currentUserProvider

Constructor Detail

HandleWorkspacesFoRequestGenerator

public HandleWorkspacesFoRequestGenerator()

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

_unroll

private Throwable _unroll(Throwable initial)

_extractFiles

private Map<String,Object> _extractFiles(Request request)

_setContextInRequestAttributes

private void _setContextInRequestAttributes(Request request,
                                            Map<String,Object> reqContext)

_transmitAttributes

private Map<String,Object> _transmitAttributes(Map<String,Object> attributes)

_saveRequestAttributes

private Map<String,Object> _saveRequestAttributes(Request request)

Transforms the request attributes into a map and clean the attributes

Parameters:

request - The request

Returns:

A copy of all the request attributes

_restoreRequestAttributes

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

Clean the requests attributes and add those in the map

Parameters:

request - The request

attributes - The attributes to restore

_removeRequestAttributes

private void _removeRequestAttributes()

_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

_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

_getRelativePath

private String _getRelativePath(String url)