javax.portlet
Interface PortletConfig
- GenericPortlet
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.
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 | 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.
|
String | getPortletName() - Returns the name of the portlet.
|
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.
|
getInitParameter
public 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.
name
- a String
specifying the name
of the initialization parameter
- a
String
containing the value
of the initialization parameter
getInitParameterNames
public java.util.Enumeration 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.
- 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
public PortletContext getPortletContext()
Returns the PortletContext
of the portlet application
the portlet is in.
- a
PortletContext
object, used by the
caller to interact with its portlet container
getPortletName
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.
getResourceBundle
public 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.
locale
- the locale for which to retrieve the resource bundle
- the resource bundle for the given locale