J2EEManagedObject, StatisticsProvider
WebSphere:*,type=Portlet
true
MBean Portlet
Information about a portlet belonging to a specific portletapplication.
Attribute Summary | |
---|---|
java.lang.String | id The id of the portlet. |
java.lang.String | name The name of the portlet. |
java.util.Locale | defaultLocale The default locale of the portlet. |
java.util.Map | initParameters The init parameters specified by the portlet. |
java.util.Map | preferences All preferences specified for this portlet. |
java.lang.String | preferencesValidatorName Returns the class name of the preferences validator specified for this portlet. |
java.util.List | readOnlyPreferenceNames All preference names specified for this portlet to be read-only. |
java.lang.String | portletApplicationName The name of the portlet application this portlet belongs to. |
java.util.Map | contentTypes The portlet's content types and its corresponding portlet modes. |
java.util.List | supportedLanguages All locales supported by this PortletApplication as defined within the portlet. |
java.lang.String | resourceBundleName The name of the resource bundle that is defined for this portlet within the portlet. |
java.util.Map | languageInformation All language information of a portlet as a map. |
java.lang.Integer | expirationCache The duration in seconds for the cache to expire. |
java.lang.String | cacheScope The caching scope that is defined for this portlet within the portlet. |
java.util.List | supportedPublicRenderParameters All public render parameter identifiers supported by this portlet as defined within the portlet. |
java.util.List | supportedProcessingEvents All events supported to be processed by this portlet as defined within the portlet. |
java.util.List | supportedPublishingEvents All events supported to be published by this portlet as defined within the portlet. |
java.util.Map | containerRuntimeOptions All supported container runtime options set in the portlet. |
Attributes inherited from MBean J2EEManagedObject |
---|
objectName , stateManageable , statisticsProvider , eventProvider |
Attributes inherited from MBean StatisticsProvider |
---|
stats |
Operation Summary | |
---|---|
java.util.Map | getLanguageInformation( All information for a specific language of a portlet as a map. |
Attribute Detail |
---|
public java.lang.String id
The id of the portlet. The id is null if no portlet id is defined within the portlet.xml.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String name
The name of the portlet. The portlet name cannot be null.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Locale defaultLocale
The default locale of the portlet. The locale cannot be null.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Map initParameters
The init parameters specified by the portlet. The init parameter map contains key/value pairs of type java.lang String. This map cannot be null.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Map preferences
All preferences specified for this portlet. The preferences map contains key/value pairs with a key of type java.lang.String. The value of type java.util.List contains the preference values of type java.lang.String. The preferences map cannot be null but may be empty.
For each key the value list may be empty or contain up to multiple values.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String preferencesValidatorName
Returns the class name of the preferences validator specified for this portlet. The preferences validator may be null.
Since:
7.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.List readOnlyPreferenceNames
All preference names specified for this portlet to be read-only. The value of type java.util.List contains preference names of type java.lang.String. The list cannot be null but may be empty.
Since:
7.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String portletApplicationName
The name of the portlet application this portlet belongs to. The portlet application name cannot be null. The portlet application name can be used to retrieve the portlet application information via an MBean of type PORTLETAPPLICATION.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Map contentTypes
The portlet's content types and its corresponding portlet modes. The key of the returned map is the content type [java.lang.String], for example: 'text/*'. The returned map can neither be null nor empty.
The value of type java.util.List contains the portlet modes of type java.lang.String that correspond to this content type. For each supported content type, the value can neither be null nor empty.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.List supportedLanguages
All locales supported by this PortletApplication as defined within the portlet.xml. The list returns elements of type java.util.Locale. The list cannot be null, but may be empty.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String resourceBundleName
The name of the resource bundle that is defined for this portlet within the portlet.xml. The resource bundle name may be null if no resource bundle has been defined.
Since:
7.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Map languageInformation
key [java.util.Locale]: The locale of the language All language information of a portlet as a map. The language map contains the following key/value pairs
value [java.lang.String] Array[5] of the following strings: All information for the specific language
The returned map cannot be null.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.Integer expirationCache
The duration in seconds for the cache to expire. The return value may be null.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String cacheScope
The caching scope that is defined for this portlet within the portlet.xml. The return value may be null.
Since:
7.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.List supportedPublicRenderParameters
All public render parameter identifiers supported by this portlet as defined within the portlet.xml. The list returns elements of type java.lang.String. The list cannot be null, but may be empty.
Since:
7.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.List supportedProcessingEvents
All events supported to be processed by this portlet as defined within the portlet.xml. The list returns elements of type javax.xml.namespace.QName. The list cannot be null, but may be empty.
Since:
7.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.List supportedPublishingEvents
All events supported to be published by this portlet as defined within the portlet.xml. The list returns elements of type javax.xml.namespace.QName. The list cannot be null, but may be empty.
Since:
7.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Map containerRuntimeOptions
All supported container runtime options set in the portlet.xml. The container options map contains the following information structure:
key value [java.lang.String]: The name of the container runtime option [java.lang.String[]] an String array containing the values of this container options
Any value may be null
.
Since:
7.0
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Operation Detail |
---|
public java.util.Map getLanguageInformation(
java.util.Locale locale
)
All information for a specific language of a portlet as a map. The language map contains the following key/value pairs: key [java.lang.String] value [java.lang.String] Language.Info.Title
Title. This value cannot be NULL. Language.Info.ShortTitle
Short Title. This value can be NULL. Language.Info.Description
Description. This value can be NULL. Language.Info.DisplayName
Display Name. This value can be NULL. Language.Info.Keywords
Keywords. This value can be NULL or may contain several comma separated keywords. Please refer to the Java Portlet Specification 1.0 for further information.
The return value cannot be null but may be empty.
locale
-
The locale of the language for which the information is retrieved.
administrator
operator