PortletApplication MBean

All Parent MBeans:
J2EEManagedObject, StatisticsProvider

Partial ObjectName:
WebSphere:*,type=PortletApplication

ExcludeAccessCheck:

true


MBean PortletApplication

Information about a Portlet Application.


Attribute Summary
java.lang.Stringid
           The id of the application.
java.lang.Stringversion
           The version of the application.
java.lang.StringwebApplicationContextRoot
           The context root of the web application this portlet application belongs to.
java.util.ListportletMBeanNames
           All portlet names belonging to this portletapplication.
java.lang.StringwebApplicationName
           The name of the corresponding web application this portlet application belongs to.
java.lang.StringearApplicationName
           The name identifying the enterprise application this portlet application belongs to.
java.util.CollectioncustomPortletModes
           All custom portlet modes supported by this portletapplication.
java.util.ListportalManagedCustomModes
           All custom portlet modes specified by this portletapplication that are defined to be portal-managed.
java.util.CollectioncustomWindowStates
           All custom window states supported by this portletapplication.
java.util.CollectionuserAttributes
           All user attributes specified for this portletapplication.
java.util.ListsecurityConstraints
           All security constraints defined for this portletapplication.
java.util.MapfilterMappings
           All filter mapping information of a portlet as a map.
java.util.Mapfilters
           All filter information of a portlet as a map.
java.util.MapeventDefinitions
           All event information of a portlet as a map.
java.util.MappublicRenderParameters
           All public render parameter information of a portlet as a map.
java.util.MapcontainerRuntimeOptions
           All supported container runtime options set in the PortletApplication DD.

Attributes inherited from MBean J2EEManagedObject
objectName, stateManageable, statisticsProvider, eventProvider

Attributes inherited from MBean StatisticsProvider
stats

Notification Summary
portletapplication.starting
           A portlet application is being started.
portletapplication.started
           A portlet application is now started.
portletapplication.stopping
           A portlet application is being stopped
portletapplication.stopped
           A portlet application is now stopped

Attribute Detail

id

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

version

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

webApplicationContextRoot

public java.lang.String webApplicationContextRoot
The context root of the web application this portlet application belongs to. The context root cannot be null, for example: 'bookmark'.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

portletMBeanNames

public java.util.List portletMBeanNames
All portlet names belonging to this portletapplication. The list of portlet names of all portlet names [java.lang.String] cannot be null. Each portlet name can be used to retrieve portlet specific information via an MBean of type PORTLET.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

webApplicationName

public java.lang.String webApplicationName
The name of the corresponding web application this portlet application belongs to. The web application name cannot be null.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

earApplicationName

public java.lang.String earApplicationName
The name identifying the enterprise application this portlet application belongs to. The ear application name cannot be null.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

customPortletModes

public java.util.Collection customPortletModes
All custom portlet modes supported by this portletapplication. Besides the standard portlet modes (view, edit, help), a portlet application can define additional custom portlet modes. The collection of portlet modes [java.lang.String] cannot be null but may be empty.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

portalManagedCustomModes

public java.util.List portalManagedCustomModes
All custom portlet modes specified by this portletapplication that are defined to be portal-managed. The list of portlet modes [java.lang.String] cannot be null but may be empty.
Since:
7.0
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

customWindowStates

public java.util.Collection customWindowStates
All custom window states supported by this portletapplication. Besides the standard window states (normal, minimized, maximized), a portletapplication can define additional custom window states. The collection of window states [java.lang.String] cannot be null but may be empty.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

userAttributes

public java.util.Collection userAttributes
All user attributes specified for this portletapplication. The collection of user attributes [java.lang.String] cannot be null but may be empty.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

securityConstraints

public java.util.List securityConstraints
All security constraints defined for this portletapplication. The list contains the following information structure:
[java.util.Map] a security constraint represented as a map
key value
[java.lang.String] "id" (optional) [java.lang.String] the id of this constraint
[java.lang.String] "displayname" (optional) [java.util.Map] a map containing one entry per locale
key value
[java.util.Locale] the locale [java.lang.String] the localized displayname
[java.lang.String] "portlets" [java.util.List] a list of portlet MBean names as java.lang.Strings
[java.lang.String] "user-data-constraint" [java.util.Map] a map containing all information about this constraint
key value
[java.lang.String] "id" (optional) [java.lang.String] the id of this constraint
[java.lang.String] "description" (optional) [java.util.Map] a map containing descriptions for different locales
key value
[java.util.Locale] the locale [java.lang.String] the localized description
[java.lang.String] "transport-guarantee" [java.lang.String] possible values are NONE, INTEGRAL and CONFIDENTIAL

All values are guaranteed not to be null unless marked as an optional entry.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

filterMappings

public java.util.Map filterMappings
All filter mapping information of a portlet as a map. The filter mapping map contains the following information structure:

[java.util.Map] a filter mapping represented as a map
key value
[java.lang.String]: The name of the filter [java.util.Map] Map of the following key/value pairs per filter:
key value
[java.lang.String] "portlets" [java.util.List] a list of java.lang.String objects representing the portlet names mapped to this filter

Any value may be null.

Since:
7.0
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

filters

public java.util.Map filters
All filter information of a portlet as a map. The filter map contains the following information structure:

[java.util.Map] a filter represented as a map
key value
[java.lang.String]: The name of the filter [java.util.Map] Map of the following key/value pairs per filter:
key value
[java.lang.String] "displayname" [java.lang.String] a string representing the filter display name mapped to this filter
[java.lang.String] "filter-class" [java.lang.String] a string representing the filter class of this filter
[java.lang.String] "lifecycle" [java.util.List] a List of String representing all applicable lifecycle methods for this filter
[java.lang.String] "description" (optional) [java.util.Map] a map containing descriptions for different locales
key value
[java.util.Locale] the locale [java.lang.String] the localized description
[java.lang.String] "initparameter" (optional) [java.util.Map] a map containing init parameters
key value
[java.lang.String] the key of the initparameter [java.lang.String] the value of the initparameter

Any value may be null.

Since:
7.0
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

eventDefinitions

public java.util.Map eventDefinitions
All event information of a portlet as a map. The event map contains the following information structure:

[java.util.Map] an event represented as a map
key value
[javax.xml.namespace.QName]: The name of the event [java.util.Map] Map of the following key/value pairs per event:
key value
[java.lang.String] "value-type" [java.lang.String] a string representing the java class of this event
[java.lang.String] "description" (optional) [java.util.Map] a map containing descriptions for different locales
key value
[java.util.Locale] the locale [java.lang.String] the localized description
[java.lang.String] "aliasnames" [java.util.List] a list of javax.xml.namespace.QName containing the alias names of the event

Any value may be null.

Since:
7.0
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

publicRenderParameters

public java.util.Map publicRenderParameters
All public render parameter information of a portlet as a map. The parameter map contains the following information structure:

[java.util.Map] a public render parameter represented as a map
key value
[java.lang.String]: The identifier of the public render parameter [java.util.Map] Map of the following key/value pairs per parameter:
key value
[java.lang.String] "identifier" [java.lang.String] the identifier of this parameter
[java.lang.String] "name" [javax.xml.namespace.QName] the name of this parameter
[java.lang.String] "aliasnames" [java.util.List] a list of javax.xml.namespace.QName objects representing the list of aliasnames defined for this parameter
[java.lang.String] "description" (optional) [java.util.Map] a map containing descriptions for different locales
key value
[java.util.Locale] the locale [java.lang.String] the localized description

Any value may be null.

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 PortletApplication DD. 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

Notification Detail

portletapplication.starting

A portlet application is being started.
Severity:
6  (Normal, Cleared, or Informative)

portletapplication.started

A portlet application is now started.
Severity:
6  (Normal, Cleared, or Informative)

portletapplication.stopping

A portlet application is being stopped
Severity:
6  (Normal, Cleared, or Informative)

portletapplication.stopped

A portlet application is now stopped
Severity:
6  (Normal, Cleared, or Informative)

Copyright IBM Corp. 1996-2005