J2EEManagedObject, StatisticsProvider
WebSphere:*,type=PortletApplication
true
MBean PortletApplication
Information about a Portlet Application.
Attribute Summary | |
---|---|
java.lang.String | id The id of the application. |
java.lang.String | version The version of the application. |
java.lang.String | webApplicationContextRoot The context root of the web application this portlet application belongs to. |
java.util.List | portletMBeanNames All portlet names belonging to this portletapplication. |
java.lang.String | webApplicationName The name of the corresponding web application this portlet application belongs to. |
java.lang.String | earApplicationName The name identifying the enterprise application this portlet application belongs to. |
java.util.Collection | customPortletModes All custom portlet modes supported by this portletapplication. |
java.util.List | portalManagedCustomModes All custom portlet modes specified by this portletapplication that are defined to be portal-managed. |
java.util.Collection | customWindowStates All custom window states supported by this portletapplication. |
java.util.Collection | userAttributes All user attributes specified for this portletapplication. |
java.util.List | securityConstraints All security constraints defined for this portletapplication. |
java.util.Map | filterMappings All filter mapping information of a portlet as a map. |
java.util.Map | filters All filter information of a portlet as a map. |
java.util.Map | eventDefinitions All event information of a portlet as a map. |
java.util.Map | publicRenderParameters All public render parameter information of a portlet as a map. |
java.util.Map | containerRuntimeOptions 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 |
---|
public java.lang.String id
The id of the application. The id cannot be null.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String version
The version of the application. The version cannot be null.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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'.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String webApplicationName
The name of the corresponding web application this portlet application belongs to. The web application name cannot be null.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String earApplicationName
The name identifying the enterprise application this portlet application belongs to. The ear application name cannot be null.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
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.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.List securityConstraints
All security constraints defined for this portletapplication. The list contains the following information structure:
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.String
s [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.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Map filterMappings
All filter mapping information of a portlet as a map. The filter mapping map contains the following information structure:
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
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Map filters
All filter information of a portlet as a map. The filter map contains the following information structure:
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
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Map eventDefinitions
All event information of a portlet as a map. The event map contains the following information structure:
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
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Map publicRenderParameters
All public render parameter information of a portlet as a map. The parameter map contains the following information structure:
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
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Map containerRuntimeOptions
All supported container runtime options set in the PortletApplication DD. 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
Notification Detail |
---|
A portlet application is being started.
6
(Normal, Cleared, or Informative)
A portlet application is now started.
6
(Normal, Cleared, or Informative)
A portlet application is being stopped
6
(Normal, Cleared, or Informative)
A portlet application is now stopped
6
(Normal, Cleared, or Informative)