Portlet Config


  • The PortletConfig object provides the portlet object with information to be used during initialization. It also provides access to the portlet context, default event namespace, public render parameter names, and the resource bundle that provides title-bar resources.
  • The getInitParameterNames and getInitParameter methods of the PortletConfig interface return the initialization parameter names and values found in the portlet definition in the deployment descriptor.
  • The render method of the GenericPortlet uses the ResourceBundle object of the PortletConfig to retrieve the title of the portlet from the associated ResourceBundle or the inline information in the portlet definition.
  • The getDefaultNamespace method of the PortletConfig interface returns the default namespace for events and public render parameters set in the portlet deployment descriptor with the default-namespace element, or the XML default namespace XMLConstants.NULL_NS_URI if no default namespace is provided in the portlet deployment descriptor.
  • The getPublicRenderParameterNames method of the PortletConfig interface returns the public render parameter names found in the portlet definition in the deployment descriptor with the supported-public-render-parameter element or an empty enumeration if no public render parameters are defined for the current portlet definition.
  • The getPublishingEventQNames method of the PortletConfig interface returns the publishing event QNames found in the portlet definition in the deployment descriptor with the supported-publishing-event element or an empty enumeration if no publishing events are defined for the current portlet definition.
  • The getProcessingEventQNames method of the PortletConfig interface returns the processing event QNames found in the portlet definition in the deployment descriptor with the supported-processing-event element or an empty enumeration if no processing events are defined for the current portlet definition.
  • The getSupportedLocales method of the PortletConfig interface returns the supported locales found in the portlet definition in the deployment descriptor with the supported-locale element or an empty enumeration if no supported locales are defined for the current portlet definition.
  • The getContainerRuntimeOptions method returns an immutable Map containing  portlet application level container runtime options merged with the portlet level container runtime options, containing the names as keys and the container runtime values as map values, or an empty Map if no portlet application level or portlet level container runtime options are set in the portlet.xml or supported by this portlet container.