Portlet MBean

All Parent MBeans:
J2EEManagedObject, StatisticsProvider

Partial ObjectName:
WebSphere:*,type=Portlet

ExcludeAccessCheck:

true


MBean Portlet

Information about a portlet belonging to a specific portletapplication.


Attribute Summary
java.lang.Stringid
           The id of the portlet.
java.lang.Stringname
           The name of the portlet.
java.util.LocaledefaultLocale
           The default locale of the portlet.
java.util.MapinitParameters
           The init parameters specified by the portlet.
java.util.Mappreferences
           All preferences specified for this portlet.
java.lang.StringpreferencesValidatorName
           Returns the class name of the preferences validator specified for this portlet.
java.util.ListreadOnlyPreferenceNames
           All preference names specified for this portlet to be read-only.
java.lang.StringportletApplicationName
           The name of the portlet application this portlet belongs to.
java.util.MapcontentTypes
           The portlet's content types and its corresponding portlet modes.
java.util.ListsupportedLanguages
           All locales supported by this PortletApplication as defined within the portlet.
java.lang.StringresourceBundleName
           The name of the resource bundle that is defined for this portlet within the portlet.
java.util.MaplanguageInformation
           All language information of a portlet as a map.
java.lang.IntegerexpirationCache
           The duration in seconds for the cache to expire.
java.lang.StringcacheScope
           The caching scope that is defined for this portlet within the portlet.
java.util.ListsupportedPublicRenderParameters
           All public render parameter identifiers supported by this portlet as defined within the portlet.
java.util.ListsupportedProcessingEvents
           All events supported to be processed by this portlet as defined within the portlet.
java.util.ListsupportedPublishingEvents
           All events supported to be published by this portlet as defined within the portlet.
java.util.MapcontainerRuntimeOptions
           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.MapgetLanguageInformation(java.util.Locale locale)
           All information for a specific language of a portlet as a map.

Attribute Detail

id

public java.lang.String id
The id of the portlet. The id is null if no portlet id is defined within the portlet.xml.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

name

public java.lang.String name
The name of the portlet. The portlet name cannot be null.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

defaultLocale

public java.util.Locale defaultLocale
The default locale of the portlet. The locale cannot be null.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

initParameters

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.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

preferences

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.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

preferencesValidatorName

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
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

readOnlyPreferenceNames

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
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

portletApplicationName

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.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

contentTypes

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.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

supportedLanguages

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.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

resourceBundleName

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
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

languageInformation

public java.util.Map languageInformation
All language information of a portlet as a map. The language map contains the following key/value pairs

key [java.util.Locale]: The locale of the language
value [java.lang.String] Array[5] of the following strings: All information for the specific language

  1. Title [java.lang.String]. This value cannot be NULL.
  2. Short Title [java.lang.String]. This value can be NULL.
  3. Description [java.lang.String]. This value can be NULL.
  4. DisplayName [java.lang.String]. This value can be NULL.
  5. Keywords [java.lang.String]. 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 returned map cannot be null.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

expirationCache

public java.lang.Integer expirationCache
The duration in seconds for the cache to expire. The return value may be null.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

cacheScope

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
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

supportedPublicRenderParameters

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
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

supportedProcessingEvents

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
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

supportedPublishingEvents

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
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

containerRuntimeOptions

public java.util.Map containerRuntimeOptions
All supported container runtime options set in the portlet.xml. The container options map contains the following information structure:

[java.util.Map] the container runtime options
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
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Operation Detail

getLanguageInformation

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.
Parameters:
locale - The locale of the language for which the information is retrieved.
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005