org.jahia.services.applications

Class DispatchingService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.applications.DispatchingService

Direct Known Subclasses:

DispatchingServiceImpl

public abstract class DispatchingService
extends JahiaService

This service generates the dispatching and aggregation on an application. This functionality is central to the portal behavior of Jahia, allowing it to display multiple applications on a web page and interact with them simultaneously.

Version:

1.0

Author:

Serge Huber, Eric Vassalli

Field Summary

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
DispatchingService()

Method Summary

Modifier and Type	Method and Description
abstract String	getAppOutput(int fieldID, String entryPointIDStr, JahiaUser jahiaUser, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, javax.servlet.ServletContext servletContext, String workspaceName) Dispatches processing to an application, and retrieves it's output for Jahia to aggregate

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

DispatchingService

public DispatchingService()

Method Detail

getAppOutput

public abstract String getAppOutput(int fieldID,
                                    String entryPointIDStr,
                                    JahiaUser jahiaUser,
                                    javax.servlet.http.HttpServletRequest httpServletRequest,
                                    javax.servlet.http.HttpServletResponse httpServletResponse,
                                    javax.servlet.ServletContext servletContext,
                                    String workspaceName)
                             throws JahiaException

Dispatches processing to an application, and retrieves it's output for Jahia to aggregate

Parameters:

fieldID - identifier of Jahia's field

entryPointIDStr - application identifier passed as a String (converted from an integer)

jahiaUser - the Jahia user that will be passed to the portlet when dispatching

httpServletRequest - the request object that will be passed to the portlet

httpServletResponse -

servletContext -

workspaceName - the workspace name against which to check for mode and various other permissions

Returns:

String containing the output of the application

Throws:

JahiaException - generated if there was a problem dispatching, during processing of the application, or when recuperating the application's output.