org.exoplatform.services.portletcontainer
Interface PortletContainerPlugin

All Superinterfaces:

org.exoplatform.container.component.ComponentPlugin

All Known Implementing Classes:

PortletContainerDispatcher, WSRPConsumerPlugin, WSRPConsumerPlugin

public interface PortletContainerPlugin
extends org.exoplatform.container.component.ComponentPlugin

Created by The eXo Platform SAS. Author : Roman Pedchenko roman.pedchenko@exoplatform.com.ua

Method Summary

Map<String,PortletData>	getAllPortletMetaData() Get all portlet metadata.
ResourceBundle	getBundle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String portletAppName, String portletName, Locale locale) Get bundle.
String[]	getPortalManagedPortletModes(String portletAppName, String portletName) Get portal managed portlet modes.
PortletApp	getPortletApp(String portletAppName) Get portlet app.
Collection<String>	getPortletAppNames() Get portlet app names.
Collection<javax.portlet.PortletMode>	getPortletModes(String portletAppName, String portletName, String markup) Get portlet modes.
Map<String,String[]>	getPortletPreference(Input input) Deprecated.
javax.portlet.PortletPreferences	getPortletPreferences(Input input) Get portlet preferences.
Collection<javax.portlet.PortletMode>	getSupportedPortletModes() Get supported portlet modes.
Collection<javax.portlet.WindowState>	getSupportedWindowStates() Get supported window states.
Collection<javax.portlet.WindowState>	getWindowStates(String portletAppName, String portletName, String markup) Get window states.
boolean	isEventPayloadTypeMatches(String portletAppName, QName eventName, Serializable payload) Is event payload type matches.
boolean	isModeSuported(String portletAppName, String portletName, String markup, javax.portlet.PortletMode mode) Is mode suported.
boolean	isStateSupported(String portletAppName, String portletName, String markup, javax.portlet.WindowState state) Is state supported.
ActionOutput	processAction(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ActionInput input) Process action.
EventOutput	processEvent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, EventInput input) Process event.
RenderOutput	render(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, RenderInput input) Render.
void	sendAttrs(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> attrs, String portletApplicationName) Send attrs.
ResourceOutput	serveResource(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ResourceInput input) Serve resource.
void	setDescription(String description) Overridden method.
void	setMajorVersion(int majorVersion) Set major version.
void	setMinorVersion(int minorVersion) Set minor version.
void	setName(String name) Overridden method.
void	setPortletPreference(Input input, Map<String,String> preferences) Deprecated.
void	setPortletPreference2(Input input, Map<String,String[]> preferences) Deprecated.
void	setPortletPreferences(Input input, javax.portlet.PortletPreferences preferences) Set portlet preferences.
void	setProperties(Map<String,String> properties) Set properties.

Methods inherited from interface org.exoplatform.container.component.ComponentPlugin

getDescription, getName

Method Detail

setName

void setName(String name)

Overridden method.

Specified by:

setName in interface org.exoplatform.container.component.ComponentPlugin

Parameters:

name - name

See Also:

ComponentPlugin.setName(java.lang.String)

setDescription

void setDescription(String description)

Overridden method.

Specified by:

setDescription in interface org.exoplatform.container.component.ComponentPlugin

Parameters:

description - description

See Also:

ComponentPlugin.setDescription(java.lang.String)

setMajorVersion

void setMajorVersion(int majorVersion)

Set major version.

Parameters:

majorVersion - major version

setMinorVersion

void setMinorVersion(int minorVersion)

Set minor version.

Parameters:

minorVersion - minor vesrion

setProperties

void setProperties(Map<String,String> properties)

Set properties.

Parameters:

properties - properties

getSupportedPortletModes

Collection<javax.portlet.PortletMode> getSupportedPortletModes()

Get supported portlet modes.

Returns:

app supported portlet modes

getSupportedWindowStates

Collection<javax.portlet.WindowState> getSupportedWindowStates()

Get supported window states.

Returns:

all supported window states

getPortletModes

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

Get portlet modes.

Parameters:

portletAppName - app name

portletName - portlet name

markup - markup

Returns:

supported portlet modes

isModeSuported

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

Is mode suported.

Parameters:

portletAppName - app name

portletName - portlet name

markup - markup

mode - portlet mode

Returns:

either the mode supported

getPortalManagedPortletModes

String[] getPortalManagedPortletModes(String portletAppName,
                                      String portletName)

Get portal managed portlet modes.

Parameters:

portletAppName -

portletName -

Returns:

getWindowStates

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

Get window states.

Parameters:

portletAppName - app name

portletName - portlet name

markup - markup

Returns:

supported window states

isStateSupported

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

Is state supported.

Parameters:

portletAppName - app name

portletName - portlet name

markup - markup

state - window state

Returns:

either the state supported

getAllPortletMetaData

Map<String,PortletData> getAllPortletMetaData()

Get all portlet metadata.

Returns:

all portlet metadata

getPortletApp

PortletApp getPortletApp(String portletAppName)

Get portlet app.

Parameters:

portletAppName - app name

Returns:

app object

getBundle

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

Get bundle.

Parameters:

request - request

response - response

portletAppName - app name

portletName - portlet name

locale - locale

Returns:

resource bundle

Throws:

PortletContainerException - exception

setPortletPreference

@Deprecated
void setPortletPreference(Input input,
                                     Map<String,String> preferences)
                          throws PortletContainerException

Deprecated.

Set portlet preference.

Parameters:

input - input

preferences - preferences

Throws:

PortletContainerException - exception

setPortletPreference2

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

Deprecated.

Set portlet preference with string array.

Parameters:

input - input

preferences - preferences

Throws:

PortletContainerException - exception

getPortletPreference

@Deprecated
Map<String,String[]> getPortletPreference(Input input)

Deprecated.

Get portlet preference.

Parameters:

input - input

Returns:

portlet preferences

setPortletPreferences

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

Set portlet preferences.

Parameters:

input - input

preferences - preferences

Throws:

PortletContainerException - exception

getPortletPreferences

javax.portlet.PortletPreferences getPortletPreferences(Input input)

Get portlet preferences.

Parameters:

input - input

Returns:

portlet preferences

processAction

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

Process action.

Parameters:

request - request

response - response

input - input

Returns:

output

Throws:

PortletContainerException - exception

processEvent

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

Process event.

Parameters:

request - request

response - response

input - input

Returns:

output

Throws:

PortletContainerException - exception

serveResource

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

Serve resource.

Parameters:

request - request

response - response

input - input

Returns:

output

Throws:

PortletContainerException - exception

render

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

Render.

Parameters:

request - request

response - response

input - input

Returns:

output

Throws:

PortletContainerException - exception

sendAttrs

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

Send attrs.

Parameters:

request - request

response - response

attrs - attrs

portletApplicationName - app name

Throws:

PortletContainerException - exception

isEventPayloadTypeMatches

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

Is event payload type matches.

Parameters:

portletAppName - app name

eventName - event name

payload - payload

Returns:

either payload is of correct type

Throws:

PortletContainerException - exception

getPortletAppNames

Collection<String> getPortletAppNames()

Get portlet app names.

Returns:

Collection of string