Package javax.portlet
Interface PortletConfig
- All Known Implementing Classes:
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.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongetInitParameter
(String name) Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.Returns the names of the portlet initialization parameters as anEnumeration
of String objects, or an emptyEnumeration
if the portlet has no initialization parameters.Returns thePortletContext
of the portlet application the portlet is in.Returns the name of the portlet.getResourceBundle
(Locale locale) Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor withresource-bundle
tag or the inlined resources defined in the deployment descriptor.
-
Method Details
-
getPortletName
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 thePortletContext
of the portlet application the portlet is in.- Returns:
- a
PortletContext
object, used by the caller to interact with its portlet container - See Also:
-
getResourceBundle
Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor withresource-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
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.- Parameters:
name
- aString
specifying the name of the initialization parameter- Returns:
- a
String
containing the value of the initialization parameter - Throws:
IllegalArgumentException
- if name isnull
.
-
getInitParameterNames
Enumeration getInitParameterNames()Returns the names of the portlet initialization parameters as anEnumeration
of String objects, or an emptyEnumeration
if the portlet has no initialization parameters.- Returns:
- an
Enumeration
ofString
objects containing the names of the portlet initialization parameters, or an emptyEnumeration
if the portlet has no initialization parameters.
-