org.exoplatform.services.portletcontainer
Interface PortletContainerService

All Known Implementing Classes:

PortletContainerServiceImpl

public interface PortletContainerService

Created by the Exo Development team. Author : Mestrallet Benjamin benjmestrallet@users.sourceforge.net Date: 10 nov. 2003 Time: 09:40:23

Method Summary

void	addPlugin(PortletContainerPlugin plugin) Add plugin.
Map<String,PortletData>	getAllPortletMetaData()
Map<String,PortletData>	getAllPortletMetaData(boolean localPortlet)
Map<String,PortletData>	getAllPortletMetaData(String pluginName)
ResourceBundle	getBundle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String portletAppName, String portletName, Locale locale)
String[]	getPortalManagedPortletModes(String portletAppName, String portletName) Get portal managed portlet modes.
PortletApp	getPortletApp(String portletAppName) Get portlet application with app name.
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) Get portlet modes.
Map<String,String[]>	getPortletPreference(Input input) Deprecated.
javax.portlet.PortletPreferences	getPortletPreferences(Input input)
Collection<javax.portlet.PortletMode>	getSupportedPortletModes()
Collection<javax.portlet.WindowState>	getSupportedWindowStates()
Collection<javax.portlet.WindowState>	getWindowStates(String portletAppName, String portletName, String markup)
boolean	isEventPayloadTypeMatches(String portletAppName, QName eventName, Serializable payload)
boolean	isModeSuported(String portletAppName, String portletName, String markup, javax.portlet.PortletMode mode)
boolean	isStateSupported(String portletAppName, String portletName, String markup, javax.portlet.WindowState state)
ActionOutput	processAction(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ActionInput input)
EventOutput	processEvent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, EventInput input)
RenderOutput	render(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, RenderInput input)
void	sendAttrs(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> attrs, String portletApplicationName)
ResourceOutput	serveResource(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ResourceInput input)
void	setDescription(String description) Set description.
void	setMajorVersion(int majorVersion) Set major version.
void	setMinorVersion(int minorVersion) Set minor version.
void	setName(String name) Set name.
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)
void	setProperties(Map<String,String> properties)

Method Detail

addPlugin

void addPlugin(PortletContainerPlugin plugin)

Add plugin.

Parameters:

plugin - plugin object

setName

void setName(String name)

Set name.

Parameters:

name - name

setDescription

void setDescription(String description)

Set description.

Parameters:

description - description

setMajorVersion

void setMajorVersion(int majorVersion)

Set major version.

Parameters:

majorVersion - major version

setMinorVersion

void setMinorVersion(int minorVersion)

Set minor version.

Parameters:

minorVersion - minor version

setProperties

void setProperties(Map<String,String> properties)

Parameters:

properties - properties

getSupportedPortletModes

Collection<javax.portlet.PortletMode> getSupportedPortletModes()

Returns:

portlet modes

getSupportedWindowStates

Collection<javax.portlet.WindowState> getSupportedWindowStates()

Returns:

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:

portlet modes

getPortalManagedPortletModes

String[] getPortalManagedPortletModes(String portletAppName,
                                      String portletName)

Get portal managed portlet modes.

Parameters:

portletAppName -

portletName -

Returns:

string array

isModeSuported

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

Parameters:

portletAppName - app name

portletName - portlet name

markup - markup

mode - mode

Returns:

either it is supported

getWindowStates

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

Parameters:

portletAppName - app name

portletName - portlet name

markup - markup

Returns:

window states

isStateSupported

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

Parameters:

portletAppName - app name

portletName - portlet name

markup - markup

state - state

Returns:

either it is supported

getAllPortletMetaData

Map<String,PortletData> getAllPortletMetaData()

Returns:

all portlet metadata

getAllPortletMetaData

Map<String,PortletData> getAllPortletMetaData(boolean localPortlet)

Returns:

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

getAllPortletMetaData

Map<String,PortletData> getAllPortletMetaData(String pluginName)

Returns:

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

getPortletAppNames

Collection<String> getPortletAppNames()

Get portlet app names.

Returns:

collection of string

getPortletAppNames

Collection<String> getPortletAppNames(boolean localPortlet)

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

Returns:

collection of string

getPortletAppNames

Collection<String> getPortletAppNames(String pluginName)

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

Returns:

collection of string

getPortletApp

PortletApp getPortletApp(String portletAppName)

Get portlet application with app name.

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

Parameters:

request - request

response - response

portletAppName - app name

portletName - portlet name

locale - locale

Returns:

bundle

Throws:

PortletContainerException - exception

setPortletPreference

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

Deprecated.

Parameters:

input - input

preferences - preferences

Throws:

PortletContainerException - exception

setPortletPreference2

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

Deprecated.

Parameters:

input - input

preferences - preferences

Throws:

PortletContainerException - exception

getPortletPreference

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

Deprecated.

Parameters:

input - input

Returns:

preferences map

setPortletPreferences

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

Parameters:

input - input

preferences - preferences

Throws:

PortletContainerException - exception

getPortletPreferences

javax.portlet.PortletPreferences getPortletPreferences(Input input)

Parameters:

input - input

Returns:

portlet preferences

processAction

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

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

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

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

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

Parameters:

request - request

response - response

attrs - attrs

portletApplicationName - app name

Throws:

PortletContainerException - exception

isEventPayloadTypeMatches

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

Parameters:

portletAppName - app name

eventName - event name

payload - payload

Returns:

either payload type matches

Throws:

PortletContainerException - exception