org.exoplatform.services.portletcontainer.impl
Class PortletContainerServiceImpl

java.lang.Object
  org.exoplatform.services.portletcontainer.impl.PortletContainerServiceImpl

All Implemented Interfaces:

PortletContainerService, org.picocontainer.Startable

public class PortletContainerServiceImpl
extends Object
implements PortletContainerService, org.picocontainer.Startable

Created by the Exo Development team. Author : Mestrallet Benjamin benjamin.mestrallet@exoplatform.com

Constructor Summary

PortletContainerServiceImpl(org.exoplatform.container.ExoContainerContext context, PortletContainerConf config)

Method Summary

void	addPlugin(PortletContainerPlugin plugin) Overridden method.
protected PortletContainerPlugin	findPluginByPAPPName(String papp)
Map<String,PortletData>	getAllPortletMetaData() Get all portlet metadata.
Map<String,PortletData>	getAllPortletMetaData(boolean localPortlet) Get all portlet metadata with boolean option which indicate should we return local or remote portlets.
Map<String,PortletData>	getAllPortletMetaData(String pluginName) Get all portlet metadata with string option which indicate the plugin's prefix or the exact name.
ResourceBundle	getBundle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String portletAppName, String portletName, Locale locale) Overridden method.
String[]	getPortalManagedPortletModes(String portletAppName, String portletName) Get portal managed portlet modes.
PortletApp	getPortletApp(String portletAppName) Overridden method.
Collection<String>	getPortletAppNames() Get portlet app names.
Collection<String>	getPortletAppNames(boolean localPortlet) Get portlet app names with boolean option which indicate should we return local or remote portlets.
Collection<String>	getPortletAppNames(String pluginName) Get portlet app names with string option which indicate the plugin's prefix or the exact name.
Collection<javax.portlet.PortletMode>	getPortletModes(String portletAppName, String portletName, String markup) Overridden method.
Map<String,String[]>	getPortletPreference(Input input) Overridden method.
javax.portlet.PortletPreferences	getPortletPreferences(Input input)
Collection<javax.portlet.PortletMode>	getSupportedPortletModes() Overridden method.
Collection<javax.portlet.WindowState>	getSupportedWindowStates() Overridden method.
Collection<javax.portlet.WindowState>	getWindowStates(String portletAppName, String portletName, String markup) Overridden method.
boolean	isEventPayloadTypeMatches(String portletAppName, QName eventName, Serializable payload) Overridden method.
boolean	isModeSuported(String portletAppName, String portletName, String markup, javax.portlet.PortletMode mode) Overridden method.
boolean	isStateSupported(String portletAppName, String portletName, String markup, javax.portlet.WindowState state) Overridden method.
ActionOutput	processAction(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ActionInput input) Overridden method.
EventOutput	processEvent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, EventInput input) Overridden method.
RenderOutput	render(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, RenderInput input) Overridden method.
void	sendAttrs(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> attrs, String portletApplicationName) Overridden method.
ResourceOutput	serveResource(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ResourceInput input) Overridden method.
void	setDescription(String description) Overridden method.
void	setMajorVersion(int version) Overridden method.
void	setMinorVersion(int version) Overridden method.
void	setName(String name) Overridden method.
void	setPortletPreference(Input input, Map<String,String> preferences) Overridden method.
void	setPortletPreference2(Input input, Map<String,String[]> preferences)
void	setPortletPreferences(Input input, javax.portlet.PortletPreferences preferences)
void	setProperties(Map<String,String> properties) Overridden method.
void	start() Overridden method.
void	stop() Overridden method.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletContainerServiceImpl

public PortletContainerServiceImpl(org.exoplatform.container.ExoContainerContext context,
                                   PortletContainerConf config)

Parameters:

context - exo container context

Method Detail

addPlugin

public final void addPlugin(PortletContainerPlugin plugin)

Overridden method.

Specified by:

addPlugin in interface PortletContainerService

Parameters:

plugin - plugin

See Also:

PortletContainerService.addPlugin(org.exoplatform.services.portletcontainer.PortletContainerPlugin)

start

public final void start()

Overridden method.

Specified by:

start in interface org.picocontainer.Startable

See Also:

Startable.start()

stop

public final void stop()

Overridden method.

Specified by:

stop in interface org.picocontainer.Startable

See Also:

Startable.stop()

setName

public final void setName(String name)

Overridden method.

Specified by:

setName in interface PortletContainerService

Parameters:

name - name

See Also:

PortletContainerService.setName(java.lang.String)

setDescription

public final void setDescription(String description)

Overridden method.

Specified by:

setDescription in interface PortletContainerService

Parameters:

description - description

See Also:

PortletContainerService.setDescription(java.lang.String)

setMajorVersion

public final void setMajorVersion(int version)

Overridden method.

Specified by:

setMajorVersion in interface PortletContainerService

Parameters:

version - major

See Also:

PortletContainerService.setMajorVersion(int)

setMinorVersion

public final void setMinorVersion(int version)

Overridden method.

Specified by:

setMinorVersion in interface PortletContainerService

Parameters:

version - minor

See Also:

PortletContainerService.setMinorVersion(int)

setProperties

public final void setProperties(Map<String,String> properties)

Overridden method.

Specified by:

setProperties in interface PortletContainerService

Parameters:

properties - properties

See Also:

PortletContainerService.setProperties(java.util.Map)

getSupportedPortletModes

public final Collection<javax.portlet.PortletMode> getSupportedPortletModes()

Overridden method.

Specified by:

getSupportedPortletModes in interface PortletContainerService

Returns:

supportlet window modes for all registered portlets

See Also:

PortletContainerService.getSupportedPortletModes()

getSupportedWindowStates

public final Collection<javax.portlet.WindowState> getSupportedWindowStates()

Overridden method.

Specified by:

getSupportedWindowStates in interface PortletContainerService

Returns:

supported windows states for all registered portlets

See Also:

PortletContainerService.getSupportedWindowStates()

getPortletModes

public final Collection<javax.portlet.PortletMode> getPortletModes(String portletAppName,
                                                                   String portletName,
                                                                   String markup)

Overridden method.

Specified by:

getPortletModes in interface PortletContainerService

Parameters:

portletAppName - app name

portletName - portlet name

markup - makrup type

Returns:

portlet modes that are supported by the specified portlet for the specified markup type

See Also:

PortletContainerService.getPortletModes(java.lang.String, java.lang.String, java.lang.String)

getPortalManagedPortletModes

public final String[] getPortalManagedPortletModes(String portletAppName,
                                                   String portletName)

Description copied from interface: PortletContainerService

Get portal managed portlet modes.

Specified by:

getPortalManagedPortletModes in interface PortletContainerService

Returns:

string array

isModeSuported

public final boolean isModeSuported(String portletAppName,
                                    String portletName,
                                    String markup,
                                    javax.portlet.PortletMode mode)

Overridden method.

Specified by:

isModeSuported in interface PortletContainerService

Parameters:

portletAppName - app name

portletName - portlet name

markup - markup type

mode - portlet mode

Returns:

either the specified mode is supported by the specified portlet for the specified markup type

See Also:

PortletContainerService.isModeSuported(java.lang.String, java.lang.String, java.lang.String, javax.portlet.PortletMode)

getWindowStates

public final Collection<javax.portlet.WindowState> getWindowStates(String portletAppName,
                                                                   String portletName,
                                                                   String markup)

Overridden method.

Specified by:

getWindowStates in interface PortletContainerService

Parameters:

portletAppName - app name

portletName - portlet name

markup - markup type

Returns:

window states that are supported by the specified portlet for the specified markup type

See Also:

PortletContainerService.getWindowStates(java.lang.String, java.lang.String, java.lang.String)

isStateSupported

public final boolean isStateSupported(String portletAppName,
                                      String portletName,
                                      String markup,
                                      javax.portlet.WindowState state)

Overridden method.

Specified by:

isStateSupported in interface PortletContainerService

Parameters:

portletAppName - app name

portletName - portlet name

markup - markup type (MIME type)

state - window state

Returns:

either the specified state is supported by the specified portlet for the specified markup type

See Also:

PortletContainerService.isStateSupported(java.lang.String, java.lang.String, java.lang.String, javax.portlet.WindowState)

getAllPortletMetaData

public final Map<String,PortletData> getAllPortletMetaData()

Get all portlet metadata.

Specified by:

getAllPortletMetaData in interface PortletContainerService

Returns:

all portlet metadata

See Also:

PortletContainerService.getAllPortletMetaData()

getAllPortletMetaData

public final Map<String,PortletData> getAllPortletMetaData(boolean localPortlet)

Get all portlet metadata with boolean option which indicate should we return local or remote portlets.

Specified by:

getAllPortletMetaData in interface PortletContainerService

Returns:

all portlet metadata

See Also:

PortletContainerService.getAllPortletMetaData()

getAllPortletMetaData

public final Map<String,PortletData> getAllPortletMetaData(String pluginName)

Get all portlet metadata with string option which indicate the plugin's prefix or the exact name.

Specified by:

getAllPortletMetaData in interface PortletContainerService

Returns:

all portlet metadata

See Also:

PortletContainerService.getAllPortletMetaData()

getPortletAppNames

public final Collection<String> getPortletAppNames()

Get portlet app names.

Specified by:

getPortletAppNames in interface PortletContainerService

Returns:

collection of string

getPortletAppNames

public final Collection<String> getPortletAppNames(String pluginName)

Get portlet app names with string option which indicate the plugin's prefix or the exact name.

Specified by:

getPortletAppNames in interface PortletContainerService

Returns:

collection of string

getPortletAppNames

public final Collection<String> getPortletAppNames(boolean localPortlet)

Get portlet app names with boolean option which indicate should we return local or remote portlets.

Specified by:

getPortletAppNames in interface PortletContainerService

Returns:

collection of string

getPortletApp

public final PortletApp getPortletApp(String portletAppName)

Overridden method.

Specified by:

getPortletApp in interface PortletContainerService

Parameters:

portletAppName - app name

Returns:

PortletApp object

See Also:

PortletContainerService.getPortletApp(java.lang.String)

getBundle

public final ResourceBundle getBundle(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      String portletAppName,
                                      String portletName,
                                      Locale locale)
                               throws PortletContainerException

Overridden method.

Specified by:

getBundle in interface PortletContainerService

Parameters:

request - request

response - response

portletAppName - app name

portletName - portlet name

locale - locale

Returns:

resource bundle

Throws:

PortletContainerException - exception

See Also:

PortletContainerService.getBundle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, java.lang.String, java.util.Locale)

findPluginByPAPPName

protected final PortletContainerPlugin findPluginByPAPPName(String papp)

Parameters:

papp - portlet app

Returns:

plugin object

setPortletPreference

public final void setPortletPreference(Input input,
                                       Map<String,String> preferences)
                                throws PortletContainerException

Overridden method.

Specified by:

setPortletPreference in interface PortletContainerService

Parameters:

input - input

preferences - preferences

Throws:

PortletContainerException - exception

See Also:

PortletContainerService.setPortletPreference(org.exoplatform.services.portletcontainer.pci.Input, java.util.Map)

setPortletPreference2

public final void setPortletPreference2(Input input,
                                        Map<String,String[]> preferences)
                                 throws PortletContainerException

Specified by:

setPortletPreference2 in interface PortletContainerService

Parameters:

input - input

preferences - preferences

Throws:

PortletContainerException - exception

getPortletPreference

public final Map<String,String[]> getPortletPreference(Input input)

Overridden method.

Specified by:

getPortletPreference in interface PortletContainerService

Parameters:

input - input

Returns:

preferences map

See Also:

PortletContainerService.getPortletPreference(org.exoplatform.services.portletcontainer.pci.Input)

setPortletPreferences

public final void setPortletPreferences(Input input,
                                        javax.portlet.PortletPreferences preferences)
                                 throws PortletContainerException

Specified by:

setPortletPreferences in interface PortletContainerService

Parameters:

input - input

preferences - preferences

Throws:

PortletContainerException - exception

getPortletPreferences

public final javax.portlet.PortletPreferences getPortletPreferences(Input input)

Specified by:

getPortletPreferences in interface PortletContainerService

Parameters:

input - input

Returns:

portlet preferences

processAction

public final ActionOutput processAction(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        ActionInput input)
                                 throws PortletContainerException

Overridden method.

Specified by:

processAction in interface PortletContainerService

Parameters:

request - request

response - response

input - input

Returns:

output

Throws:

PortletContainerException - exception

See Also:

PortletContainerService.processAction(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.exoplatform.services.portletcontainer.pci.ActionInput)

processEvent

public final EventOutput processEvent(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      EventInput input)
                               throws PortletContainerException

Overridden method.

Specified by:

processEvent in interface PortletContainerService

Parameters:

request - request

response - response

input - input

Returns:

output

Throws:

PortletContainerException - exception

See Also:

PortletContainerService.processEvent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.exoplatform.services.portletcontainer.pci.EventInput)

serveResource

public final ResourceOutput serveResource(javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response,
                                          ResourceInput input)
                                   throws PortletContainerException

Overridden method.

Specified by:

serveResource in interface PortletContainerService

Parameters:

request - request

response - response

input - input

Returns:

output

Throws:

PortletContainerException - exception

See Also:

PortletContainerService.serveResource(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.exoplatform.services.portletcontainer.pci.ResourceInput)

render

public final RenderOutput render(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 RenderInput input)
                          throws PortletContainerException

Overridden method.

Specified by:

render in interface PortletContainerService

Parameters:

request - request

response - response

input - input

Returns:

output

Throws:

PortletContainerException - exception

See Also:

PortletContainerService.render(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.exoplatform.services.portletcontainer.pci.RenderInput)

sendAttrs

public final void sendAttrs(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            Map<String,Object> attrs,
                            String portletApplicationName)
                     throws PortletContainerException

Overridden method.

Specified by:

sendAttrs in interface PortletContainerService

Parameters:

request - request

response - response

attrs - attrs

portletApplicationName - app name

Throws:

PortletContainerException - exception

See Also:

PortletContainerService.sendAttrs(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map, java.lang.String)

isEventPayloadTypeMatches

public final boolean isEventPayloadTypeMatches(String portletAppName,
                                               QName eventName,
                                               Serializable payload)
                                        throws PortletContainerException

Overridden method.

Specified by:

isEventPayloadTypeMatches in interface PortletContainerService

Parameters:

portletAppName - app name

eventName - event name

payload - payload

Returns:

do the types match

Throws:

PortletContainerException - exception

See Also:

org.exoplatform.services.portletcontainer.PortletContainerService#isEventPayloadTypeMatches(java.lang.String, Serializable, java.lang.Object)