Java Portlet API V3.0 3.0.1 · javax.portlet.PortletConfig

Method Summary

Modifier and Type	Method and Description
public Map<String, String[]>	Returns: an immutable `Map` containing portlet container runtime options names as keys and the container runtime values as map values, or an empty `Map` if no portlet container runtime options are set in the `portlet.xml` or supported by this portlet container. The keys in the map are of type String. The values in the map are of type String array (`String[]`). getContainerRuntimeOptions() Returns the container runtime options and values for this portlet.
public String	Returns: the default namespace defined in the portlet deployment descriptor, or `XMLConstants.NULL_NS_URI` is non is defined. getDefaultNamespace() Returns the default namespace for events and public render parameters.
public String	Returns: a `String` containing the value of the initialization parameter getInitParameter(String a `String` specifying the name of the initialization parameter name) Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
public Enumeration<String>	Returns: an `Enumeration` of `String` objects containing the names of the portlet initialization parameters, or an empty `Enumeration` if the portlet has no initialization parameters. getInitParameterNames() Returns the names of the portlet initialization parameters as an `Enumeration` of String objects, or an empty `Enumeration` if the portlet has no initialization parameters.
public PortletContext	Returns: a `PortletContext` object, used by the caller to interact with its portlet container getPortletContext() Returns the `PortletContext` of the portlet application the portlet is in.
public Enumeration<PortletMode>	Returns: an `Enumeration` of `PortletMode` objects containing the defined and supported portlet modes. getPortletModes(String MIME type mimeType) Returns an `Enumeration` of PortletMode objects that are defined for the portlet for the given MIME type.
public String	Returns: the portlet name getPortletName() Returns the name of the portlet.
public Enumeration<QName>	Returns: an `Enumeration` of `QName` objects containing the names of the processing events, or an empty `Enumeration` if the portlet has not defined any support for processing events in the deployment descriptor. getProcessingEventQNames() Returns the QNames of the processing events supported by the portlet as an `Enumeration` of `QName` objects, or an empty `Enumeration` if the portlet has not defined any processing events.
public Map<String, QName>	Returns: an `Map` of `String` to `QName` getPublicRenderParameterDefinitions() Returns a Map of public render parameter names to their qualified names.
public Enumeration<String>	Returns: an `Enumeration` of `String` objects containing the names of the public render parameters, or an empty `Enumeration` if the portlet has not defined support for any public render parameters in the portlet deployment descriptor. getPublicRenderParameterNames() Returns the names of the public render parameters supported by the portlet as an `Enumeration` of `String` objects, or an empty `Enumeration` if the portlet has not defined public render parameters.
public Enumeration<QName>	Returns: an `Enumeration` of `QName` objects containing the names of the publishing events, or an empty `Enumeration` if the portlet has not defined any support for publishing events in the deployment descriptor. getPublishingEventQNames() Returns the QNames of the publishing events supported by the portlet as an `Enumeration` of `QName` objects, or an empty `Enumeration` if the portlet has not defined any publishing events.
public ResourceBundle	Returns: the resource bundle for the given locale getResourceBundle(Locale the locale for which to retrieve the resource bundle locale) Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor with `resource-bundle` tag or the inlined resources defined in the deployment descriptor.
public Enumeration<Locale>	Returns: an `Enumeration` of `Locale` objects containing the supported locales, or an empty `Enumeration` if the portlet has not defined any supported locales in the deployment descriptor. getSupportedLocales() Returns the locales supported by the portlet as an `Enumeration` of `Locale` objects, or an empty `Enumeration` if the portlet has not defined any supported locales.
public Enumeration<WindowState>	Returns: an `Enumeration` of `WindowState` objects containing the defined and supported window states. getWindowStates(String MIME type mimeType) Returns an `Enumeration` of WindowState objects that are defined for the portlet for the given MIME type.

Method Detail

getContainerRuntimeOptions back to summary

getContainerRuntimeOptions	back to summary
public Map<String, String[]> getContainerRuntimeOptions() Returns the container runtime options and values for this portlet. The portlet can set container runtime options in the `portlet.xml` via the `container-runtime-option` element with a name and a value on the application and portlet level. If a container runtime option is set on the portlet application level and on the portlet level with the same name the setting on the portlet level takes precedence and overwrites the one set on the portal application level. The map returned from this method will provide the subset the portlet container supports of the options the portlet has specified in the `portlet.xml`. Options that the portlet container does not support will not be returned in this map. The map will contain name of the runtime option as key of type String and the runtime options as values of type String array (`String[]`) with the values specified in the `portlet.xml` deployment descriptor. Returns:Map<String, String[]> an immutable `Map` containing portlet container runtime options names as keys and the container runtime values as map values, or an empty `Map` if no portlet container runtime options are set in the `portlet.xml` or supported by this portlet container. The keys in the map are of type String. The values in the map are of type String array (`String[]`). Since 2.0

public Map<String, String[]> getContainerRuntimeOptions()

Returns the container runtime options and values for this portlet.

The portlet can set container runtime options in the portlet.xml via the container-runtime-option element with a name and a value on the application and portlet level.
If a container runtime option is set on the portlet application level and on the portlet level with the same name the setting on the portlet level takes precedence and overwrites the one set on the portal application level.

The map returned from this method will provide the subset the portlet container supports of the options the portlet has specified in the portlet.xml. Options that the portlet container does not support will not be returned in this map.

The map will contain name of the runtime option as key of type String and the runtime options as values of type String array (String[]) with the values specified in the portlet.xml deployment descriptor.

Returns:Map<String, String[]>: an immutable Map containing portlet container runtime options names as keys and the container runtime values as map values, or an empty Map if no portlet container runtime options are set in the portlet.xml or supported by this portlet container. The keys in the map are of type String. The values in the map are of type String array (String[]).
Since: 2.0

getDefaultNamespace back to summary

getDefaultNamespace	back to summary
public String getDefaultNamespace() Returns the default namespace for events and public render parameters. This namespace is defined in the portlet deployment descriptor with the `default-namespace` element. If no default namespace is defined in the portlet deployment descriptor this methods returns the XML default namespace `XMLConstants.NULL_NS_URI`. Returns:String the default namespace defined in the portlet deployment descriptor, or `XMLConstants.NULL_NS_URI` is non is defined. Since 2.0

public String getDefaultNamespace()

Returns the default namespace for events and public render parameters. This namespace is defined in the portlet deployment descriptor with the default-namespace element.

If no default namespace is defined in the portlet deployment descriptor this methods returns the XML default namespace XMLConstants.NULL_NS_URI.

Returns:String: the default namespace defined in the portlet deployment descriptor, or XMLConstants.NULL_NS_URI is non is defined.
Since: 2.0

getInitParameter back to summary

getInitParameter	back to summary
public String getInitParameter(String name) Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist. Parameters name:String a `String` specifying the name of the initialization parameter Returns:String a `String` containing the value of the initialization parameter Exceptions IllegalArgumentException: if name is `null`.

public String getInitParameter(String name)

Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.

Parameters

name:String: a String specifying the name of the initialization parameter

Returns:String

a String containing the value of the initialization parameter

Exceptions

IllegalArgumentException:: if name is null.

getInitParameterNames back to summary

getInitParameterNames	back to summary
public Enumeration<String> getInitParameterNames() Returns the names of the portlet initialization parameters as an `Enumeration` of String objects, or an empty `Enumeration` if the portlet has no initialization parameters. Returns:Enumeration<String> an `Enumeration` of `String` objects containing the names of the portlet initialization parameters, or an empty `Enumeration` if the portlet has no initialization parameters.

public Enumeration<String> getInitParameterNames()

Returns the names of the portlet initialization parameters as an Enumeration of String objects, or an empty Enumeration if the portlet has no initialization parameters.

Returns:Enumeration<String>: an Enumeration of String objects containing the names of the portlet initialization parameters, or an empty Enumeration if the portlet has no initialization parameters.

getPortletContext back to summary

getPortletContext	back to summary
public PortletContext getPortletContext() Returns the `PortletContext` of the portlet application the portlet is in. Returns:PortletContext a `PortletContext` object, used by the caller to interact with its portlet container See Also `PortletContext`

public PortletContext getPortletContext()

Returns the PortletContext of the portlet application the portlet is in.

Returns:PortletContext: a PortletContext object, used by the caller to interact with its portlet container
See Also: PortletContext

getPortletModes back to summary

getPortletModes	back to summary
public Enumeration<PortletMode> getPortletModes(String mimeType) Returns an `Enumeration` of PortletMode objects that are defined for the portlet for the given MIME type. Note that a supported portlet mode may not be allowed in all situations due to security or other reasons. To determine whether a portlet mode is allowed during a request, use the `PortletRequest#isPortletModeAllowed(PortletMode)` method. To determine which portlet modes are supported by the portal, use `PortalContext#getSupportedPortletModes()` Parameters mimeType:String MIME type Returns:Enumeration<PortletMode> an `Enumeration` of `PortletMode` objects containing the defined and supported portlet modes. Since 3.0 See Also `PortletMode`, `PortletRequest#isPortletModeAllowed(PortletMode)`, `PortalContext#getSupportedPortletModes()`

public Enumeration<PortletMode> getPortletModes(String mimeType)

Returns an Enumeration of PortletMode objects that are defined for the portlet for the given MIME type.

Note that a supported portlet mode may not be allowed in all situations due to security or other reasons. To determine whether a portlet mode is allowed during a request, use the PortletRequest#isPortletModeAllowed(PortletMode) method. To determine which portlet modes are supported by the portal, use PortalContext#getSupportedPortletModes()

Parameters

mimeType:String: MIME type

Returns:Enumeration<PortletMode>

an Enumeration of PortletMode objects containing the defined and supported portlet modes.

Since

3.0

getPortletName back to summary

getPortletName	back to summary
public String getPortletName() Returns the name of the portlet. The name may be provided via server administration, assigned in the portlet application deployment descriptor with the `portlet-name` tag. Returns:String the portlet name

public String getPortletName()

Returns the name of the portlet.

The name may be provided via server administration, assigned in the portlet application deployment descriptor with the portlet-name tag.

Returns:String: the portlet name

getProcessingEventQNames back to summary

getProcessingEventQNames	back to summary
public Enumeration<QName> getProcessingEventQNames() Returns the QNames of the processing events supported by the portlet as an `Enumeration` of `QName` objects, or an empty `Enumeration` if the portlet has not defined any processing events. Processing events are defined in the portlet deployment descriptor with the `supported-processing-event` element. If the event was defined using the `name` element instead of the `qname` element the defined default namespace is added as namespace for the returned QName. Returns:Enumeration<QName> an `Enumeration` of `QName` objects containing the names of the processing events, or an empty `Enumeration` if the portlet has not defined any support for processing events in the deployment descriptor. Since 2.0

public Enumeration<QName> getProcessingEventQNames()

Returns the QNames of the processing events supported by the portlet as an Enumeration of QName objects, or an empty Enumeration if the portlet has not defined any processing events.

Processing events are defined in the portlet deployment descriptor with the supported-processing-event element.

If the event was defined using the name element instead of the qname element the defined default namespace is added as namespace for the returned QName.

Returns:Enumeration<QName>: an Enumeration of QName objects containing the names of the processing events, or an empty Enumeration if the portlet has not defined any support for processing events in the deployment descriptor.
Since: 2.0

getPublicRenderParameterDefinitions back to summary

getPublicRenderParameterDefinitions	back to summary
public Map<String, QName> getPublicRenderParameterDefinitions() Returns a Map of public render parameter names to their qualified names. The names are the values returned by the `PortletConfig#getPublicRenderParameterNames()` method. The values are the `QName` values associated with the public render parameter. If the public render parameter is specified in the portlet descriptor using the `<.name>.` tag rather than the `<.qname>.` tag, the QName is built from the default namespace from the deployment descriptor together with the value from the `<.name>.` tag. Returns:Map<String, QName> an `Map` of `String` to `QName` Since 3.0 See Also `PortletConfig#getPublicRenderParameterNames()`

public Map<String, QName> getPublicRenderParameterDefinitions()

Returns a Map of public render parameter names to their qualified names. The names are the values returned by the PortletConfig#getPublicRenderParameterNames() method. The values are the QName values associated with the public render parameter.

If the public render parameter is specified in the portlet descriptor using the <.name>. tag rather than the <.qname>. tag, the QName is built from the default namespace from the deployment descriptor together with the value from the <.name>. tag.

Returns:Map<String, QName>: an Map of String to QName
Since: 3.0
See Also: PortletConfig#getPublicRenderParameterNames()

getPublicRenderParameterNames back to summary

getPublicRenderParameterNames	back to summary
public Enumeration<String> getPublicRenderParameterNames() Returns the names of the public render parameters supported by the portlet as an `Enumeration` of `String` objects, or an empty `Enumeration` if the portlet has not defined public render parameters. Public render parameters are defined in the portlet deployment descriptor with the `supported-public-render-parameter` element. Returns:Enumeration<String> an `Enumeration` of `String` objects containing the names of the public render parameters, or an empty `Enumeration` if the portlet has not defined support for any public render parameters in the portlet deployment descriptor. Since 2.0

public Enumeration<String> getPublicRenderParameterNames()

Returns the names of the public render parameters supported by the portlet as an Enumeration of String objects, or an empty Enumeration if the portlet has not defined public render parameters.

Public render parameters are defined in the portlet deployment descriptor with the supported-public-render-parameter element.

Returns:Enumeration<String>: an Enumeration of String objects containing the names of the public render parameters, or an empty Enumeration if the portlet has not defined support for any public render parameters in the portlet deployment descriptor.
Since: 2.0

getPublishingEventQNames back to summary

getPublishingEventQNames	back to summary
public Enumeration<QName> getPublishingEventQNames() Returns the QNames of the publishing events supported by the portlet as an `Enumeration` of `QName` objects, or an empty `Enumeration` if the portlet has not defined any publishing events. Publishing events are defined in the portlet deployment descriptor with the `supported-publishing-event` element. Note that this call does not return any events published that have not been declared in the deployment descriptor as supported. If the event was defined using the `name` element instead of the `qname` element the defined default namespace is added as namespace for the returned QName. Returns:Enumeration<QName> an `Enumeration` of `QName` objects containing the names of the publishing events, or an empty `Enumeration` if the portlet has not defined any support for publishing events in the deployment descriptor. Since 2.0

public Enumeration<QName> getPublishingEventQNames()

Returns the QNames of the publishing events supported by the portlet as an Enumeration of QName objects, or an empty Enumeration if the portlet has not defined any publishing events.

Publishing events are defined in the portlet deployment descriptor with the supported-publishing-event element.

Note that this call does not return any events published that have not been declared in the deployment descriptor as supported.

If the event was defined using the name element instead of the qname element the defined default namespace is added as namespace for the returned QName.

Returns:Enumeration<QName>: an Enumeration of QName objects containing the names of the publishing events, or an empty Enumeration if the portlet has not defined any support for publishing events in the deployment descriptor.
Since: 2.0

getResourceBundle back to summary

getResourceBundle	back to summary
public ResourceBundle getResourceBundle(Locale locale) Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor with `resource-bundle` tag or the inlined resources defined in the deployment descriptor. Parameters locale:Locale the locale for which to retrieve the resource bundle Returns:ResourceBundle the resource bundle for the given locale

public ResourceBundle getResourceBundle(Locale locale)

Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor with resource-bundle tag or the inlined resources defined in the deployment descriptor.

Parameters

locale:Locale: the locale for which to retrieve the resource bundle

Returns:ResourceBundle

the resource bundle for the given locale

getSupportedLocales back to summary

getSupportedLocales	back to summary
public Enumeration<Locale> getSupportedLocales() Returns the locales supported by the portlet as an `Enumeration` of `Locale` objects, or an empty `Enumeration` if the portlet has not defined any supported locales. Supported locales are defined in the portlet deployment descriptor with the `supported-locale` element. Returns:Enumeration<Locale> an `Enumeration` of `Locale` objects containing the supported locales, or an empty `Enumeration` if the portlet has not defined any supported locales in the deployment descriptor. Since 2.0

public Enumeration<Locale> getSupportedLocales()

Returns the locales supported by the portlet as an Enumeration of Locale objects, or an empty Enumeration if the portlet has not defined any supported locales.

Supported locales are defined in the portlet deployment descriptor with the supported-locale element.

Returns:Enumeration<Locale>: an Enumeration of Locale objects containing the supported locales, or an empty Enumeration if the portlet has not defined any supported locales in the deployment descriptor.
Since: 2.0

getWindowStates back to summary

getWindowStates	back to summary
public Enumeration<WindowState> getWindowStates(String mimeType) Returns an `Enumeration` of WindowState objects that are defined for the portlet for the given MIME type. Note that a supported window state may not be allowed in all situations due to security or other reasons. To determine whether a window state is allowed during a request, use the `PortletRequest#isWindowStateAllowed(WindowState)` method. To determine which window states are supported by the portal, use `PortalContext#getSupportedWindowStates()`. Parameters mimeType:String MIME type Returns:Enumeration<WindowState> an `Enumeration` of `WindowState` objects containing the defined and supported window states. Since 3.0 See Also `WindowState`, `PortletRequest#isWindowStateAllowed(WindowState)`, `PortalContext#getSupportedWindowStates()`

public Enumeration<WindowState> getWindowStates(String mimeType)

Returns an Enumeration of WindowState objects that are defined for the portlet for the given MIME type.

Note that a supported window state may not be allowed in all situations due to security or other reasons. To determine whether a window state is allowed during a request, use the PortletRequest#isWindowStateAllowed(WindowState) method. To determine which window states are supported by the portal, use PortalContext#getSupportedWindowStates().

Parameters

mimeType:String: MIME type

Returns:Enumeration<WindowState>

an Enumeration of WindowState objects containing the defined and supported window states.

Since

3.0

public Interface PortletConfig

Method Summary

Method Detail