|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pluto.internal.impl.PortletConfigImpl
public class PortletConfigImpl
Field Summary | |
---|---|
protected PortletDD |
portletDD
The portlet descriptor. |
Constructor Summary | |
---|---|
PortletConfigImpl(javax.servlet.ServletConfig servletConfig,
PortletContext portletContext,
PortletDD portletDD,
PortletAppDD portletAppDD)
|
Method Summary | |
---|---|
String |
getDefaultNamespace()
Returns the default namespace for events and public render parameters. |
String |
getInitParameter(String name)
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist. |
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. |
PortletContext |
getPortletContext()
Returns the PortletContext of the portlet application
the portlet is in. |
PortletDD |
getPortletDefinition()
|
String |
getPortletName()
Returns the name of the portlet. |
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. |
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. |
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. |
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. |
javax.servlet.ServletConfig |
getServletConfig()
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected PortletDD portletDD
Constructor Detail |
---|
public PortletConfigImpl(javax.servlet.ServletConfig servletConfig, PortletContext portletContext, PortletDD portletDD, PortletAppDD portletAppDD)
Method Detail |
---|
public String getPortletName()
PortletConfig
The name may be provided via server administration, assigned in the
portlet application deployment descriptor with the portlet-name
tag.
getPortletName
in interface PortletConfig
public PortletContext getPortletContext()
PortletConfig
PortletContext
of the portlet application
the portlet is in.
getPortletContext
in interface PortletConfig
PortletContext
object, used by the
caller to interact with its portlet containerPortletContext
public ResourceBundle getResourceBundle(Locale locale)
PortletConfig
resource-bundle
tag or the inlined resources
defined in the deployment descriptor.
getResourceBundle
in interface PortletConfig
locale
- the locale for which to retrieve the resource bundle
public String getInitParameter(String name)
PortletConfig
getInitParameter
in interface PortletConfig
name
- a String
specifying the name
of the initialization parameter
String
containing the value
of the initialization parameterpublic Enumeration<String> getInitParameterNames()
PortletConfig
Enumeration
of String objects, or an empty Enumeration
if the
portlet has no initialization parameters.
getInitParameterNames
in interface PortletConfig
Enumeration
of String
objects containing the names of the portlet
initialization parameters, or an empty Enumeration
if the
portlet has no initialization parameters.public javax.servlet.ServletConfig getServletConfig()
getServletConfig
in interface InternalPortletConfig
public PortletDD getPortletDefinition()
getPortletDefinition
in interface InternalPortletConfig
public Enumeration<String> getPublicRenderParameterNames()
PortletConfig
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.
getPublicRenderParameterNames
in interface PortletConfig
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.public String getDefaultNamespace()
PortletConfig
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
.
getDefaultNamespace
in interface PortletConfig
XMLConstants.NULL_NS_URI
is non is
defined.public Enumeration<QName> getProcessingEventQNames()
PortletConfig
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.
getProcessingEventQNames
in interface PortletConfig
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.public Enumeration<QName> getPublishingEventQNames()
PortletConfig
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.
getPublishingEventQNames
in interface PortletConfig
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.public Enumeration<Locale> getSupportedLocales()
PortletConfig
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.
getSupportedLocales
in interface PortletConfig
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |