org.apache.pluto.services.information

Interface PortalContextProvider

public interface PortalContextProvider

Provide information about the calling portal.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getPortalInfo() Returns information about the portal like vendor, version, etc.
java.lang.String	getProperty(java.lang.String name) Returns the portal property with the given name, or a null if there is no property by that name.
java.util.Collection	getPropertyNames() Returns all portal property names as strings, or an empty Collection if there are no property names.
java.util.Collection	getSupportedPortletModes() Returns the portlet modes that the portal supports as javax.portlet.PortletMode objects.
java.util.Collection	getSupportedWindowStates() Returns the window states that the portal supports as javax.portlet.WindowState objects.

Method Detail

getProperty

java.lang.String getProperty(java.lang.String name)

Returns the portal property with the given name, or a null if there is no property by that name.

Parameters:

name - property name

Returns:

portal property with key name

Throws:

java.lang.IllegalArgumentException - if name is null.

getPropertyNames

java.util.Collection getPropertyNames()

Returns all portal property names as strings, or an empty Collection if there are no property names.

Returns:

portal property names

getSupportedPortletModes

java.util.Collection getSupportedPortletModes()

Returns the portlet modes that the portal supports as javax.portlet.PortletMode objects.

The portlet modes must at least include the standard portlet modes EDIT, HELP, VIEW.

Returns:

list of supported portlet modes

getSupportedWindowStates

java.util.Collection getSupportedWindowStates()

Returns the window states that the portal supports as javax.portlet.WindowState objects.

The window states must at least include the standard window states MINIMIZED, NORMAL, MAXIMIZED.

Returns:

list of supported window states

getPortalInfo

java.lang.String getPortalInfo()

Returns information about the portal like vendor, version, etc.

The returned string starts with
servername/versionnumber Other optional information follow the primary string in parentheses.

Returns:

a String containing at least the portal name and version number