javax.portlet
Interface PortletConfig

All Known Subinterfaces:
InternalPortletConfig
All Known Implementing Classes:
AboutPortlet, AdminPortlet, GenericPlutoPortlet, GenericPortlet, PageAdminPortlet, PortletConfigImpl, TestPortlet

public interface PortletConfig

The PortletConfig interface provides the portlet with its configuration. The configuration holds information about the portlet that is valid for all users. The configuration is retrieved from the portlet definition in the deployment descriptor. The portlet can only read the configuration data.

The configuration information contains the portlet name, the portlet initialization parameters, the portlet resource bundle and the portlet application context.

See Also:
Portlet

Method Summary
 java.lang.String getDefaultNamespace()
          Returns the default namespace for events and public render parameters.
 java.lang.String getInitParameter(java.lang.String name)
          Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
 java.util.Enumeration<java.lang.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.
 PortletContext getPortletContext()
          Returns the PortletContext of the portlet application the portlet is in.
 java.lang.String getPortletName()
          Returns the name of the portlet.
 java.util.Enumeration<javax.xml.namespace.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.
 java.util.Enumeration<java.lang.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.
 java.util.Enumeration<javax.xml.namespace.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.
 java.util.ResourceBundle getResourceBundle(java.util.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.
 java.util.Enumeration<java.util.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.
 

Method Detail

getPortletName

java.lang.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:
the portlet name

getPortletContext

PortletContext getPortletContext()
Returns the PortletContext of the portlet application the portlet is in.

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

getResourceBundle

java.util.ResourceBundle getResourceBundle(java.util.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 - the locale for which to retrieve the resource bundle
Returns:
the resource bundle for the given locale

getInitParameter

java.lang.String getInitParameter(java.lang.String name)
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.

Parameters:
name - a String specifying the name of the initialization parameter
Returns:
a String containing the value of the initialization parameter
Throws:
java.lang.IllegalArgumentException - if name is null.

getInitParameterNames

java.util.Enumeration<java.lang.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:
an Enumeration of String objects containing the names of the portlet initialization parameters, or an empty Enumeration if the portlet has no initialization parameters.

getPublicRenderParameterNames

java.util.Enumeration<java.lang.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:
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

getDefaultNamespace

java.lang.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:
the default namespace defined in the portlet deployment descriptor, or XMLConstants.NULL_NS_URI is non is defined.
Since:
2.0

getPublishingEventQNames

java.util.Enumeration<javax.xml.namespace.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.

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.
Since:
2.0

getProcessingEventQNames

java.util.Enumeration<javax.xml.namespace.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.

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.
Since:
2.0

getSupportedLocales

java.util.Enumeration<java.util.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:
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


Copyright © 2003-2010 Apache Software Foundation. All Rights Reserved.