|
|
| (60 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| − | = Design Specification: JMX MBean Support =
| + | *[http://wiki.eclipse.org/EclipseLink/DesignDocs/248748 248748] : JMX support for WebLogic |
| − | | + | *[http://wiki.eclipse.org/EclipseLink/DesignDocs/316513 316513] : JMX support for WebSphere, JBoss and Glassfish |
| − | [http://bugs.eclipse.org/235168 235168] | + | |
| − | | + | |
| − | == Document History ==
| + | |
| − | {|{{BMTableStyle}}
| + | |
| − | |-{{BMTHStyle}}
| + | |
| − | ! Date
| + | |
| − | ! Author
| + | |
| − | ! Version Description & Notes
| + | |
| − | |-
| + | |
| − | | 2008-06-23
| + | |
| − | | Michael O
| + | |
| − | | 0.1 Starting Draft
| + | |
| − | |}
| + | |
| − | | + | |
| − | == Project overview ==
| + | |
| − | | + | |
| − | This enhancement will add JMX MBean support to EclipseLink 1.0 by exposing select runtime and development attributes and methods to custom JMX client code or JConsole.
| + | |
| − | | + | |
| − | == Concepts ==
| + | |
| − | Based on JMX 1.2 and JMX Remote API 1.0
| + | |
| − | | + | |
| − | == References ==
| + | |
| − | [http://wiki.eclipse.org/Integrating_EclipseLink_with_an_Application_Server_(ELUG)#How_to_Integrate_JMX ELUG Documentation]
| + | |
| − | [http://edocs.bea.com/wls/docs100/wlsmbeanref/core/index.html JMX MBeans in WebLogic 10]
| + | |
| − | | + | |
| − | == Requirements ==
| + | |
| − | * R1: Enable JMX MBean Support for WebLogic
| + | |
| − | * R2: Enable JMX MBean support for generic J2EE servers
| + | |
| − | * R3: MBeans have a 1:1 relationship with their session (multiple EARs=multiple beans)
| + | |
| − | * R4: Clients can disable post login MBean registration (via SessionCustomizer)
| + | |
| − | * R5: Clients can manage their own registration of EclipseLink MBeans (via ApplicationLifecycleListener)
| + | |
| − | == Design Constraints ==
| + | |
| − | * C1: MBeans are not available until the first login of a server application (lazy-loaded)
| + | |
| − | * C2:
| + | |
| − | == Use Cases ==
| + | |
| − | * UC1: EclipseLink managed MBean registration
| + | |
| − | * UC2: Application managed MBean registration
| + | |
| − | * UC3: No MBean registration
| + | |
| − | | + | |
| − | == Design / Functionality ==
| + | |
| − | ===EclipseLink Managed Lazy Registration===
| + | |
| − | By default MBean registration is enabled for WebLogic. This registration occurs as a post step during the first login to the session.
| + | |
| − | ===Application Managed Lazy Registration===
| + | |
| − | ====Disabling MBean Registration====
| + | |
| − | If MBean registration is not required, or the application will be handling registration then you may disable automatic registration at the first login by setting up the following.
| + | |
| − | ====WebLogic ApplicationLifecycleListener Example====
| + | |
| − | Here the application can manage registration/deregistration of the MBeans by using a SessionCustomizer in conjunction with a listener on either a servlet or session bean within the JEE application.
| + | |
| − | * SessionCustomizer | + | |
| − | | + | |
| − | * Listener
| + | |
| − | You must configure the EclipseLink Mbeans in the EAR/meta-inf via a weblogic-application.xml descriptor entry.
| + | |
| − | <source lang="xml">
| + | |
| − | <!DOCTYPE application PUBLIC "-//Sun Microsystems, Inc.//DTD J2EE Application 1.3//EN" "http://java.sun.com/dtd/application_1_3.dtd">
| + | |
| − | <weblogic-application xmlns="http://www.bea.com/ns/weblogic/10">
| + | |
| − | <listener>
| + | |
| − | <listener-class>org.eclipse.persistence.example.unified.integration.ApplicationLifecycleListenerImpl</listener-class>
| + | |
| − | </listener>
| + | |
| − | </weblogic-application>
| + | |
| − | </source>
| + | |
| − | | + | |
| − | == Testing ==
| + | |
| − | A formal JMX J2SE client test suite is required.
| + | |
| − | | + | |
| − | == API ==
| + | |
| − | | + | |
| − | | + | |
| − | | + | |
| − | == GUI ==
| + | |
| − | | + | |
| − | == Config files ==
| + | |
| − | | + | |
| − | == Documentation ==
| + | |
| − | | + | |
| − | http://wiki.eclipse.org/Integrating_EclipseLink_with_an_Application_Server_(ELUG)#How_to_Integrate_JMX | + | |
| − | - move and rewrite for WebLogic
| + | |
| − | http://wiki.eclipse.org/Configuring_a_Session_%28ELUG%29#Configuring_the_Server_Platform
| + | |
| − | - WebLogic replaces OC4J in
| + | |
| − | "Check this field to configure the EclipseLink runtime to enable the deployment of a JMX MBean that allows monitoring of the EclipseLink session. Currently, this is only supported for OC4J."
| + | |
| − | | + | |
| − | == Open Issues ==
| + | |
| − | | + | |
| − | | + | |
| − | {|{{BMTableStyle}}
| + | |
| − | |-{{BMTHStyle}}
| + | |
| − | ! Issue #
| + | |
| − | ! Owner
| + | |
| − | ! Description / Notes
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | |
| + | |
| − | |
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | |
| + | |
| − | |
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | |
| + | |
| − | |
| + | |
| − | |}
| + | |
| − | | + | |
| − | == Decisions ==
| + | |
| − | | + | |
| − | | + | |
| − | {|{{BMTableStyle}}
| + | |
| − | |-{{BMTHStyle}}
| + | |
| − | ! Issue #
| + | |
| − | ! Description / Notes
| + | |
| − | ! Decision
| + | |
| − | |-
| + | |
| − | |
| + | |
| − | |
| + | |
| − | |
| + | |
| − | |}
| + | |
| − | | + | |
| − | == Future Considerations ==
| + | |
| − | | + | |
| − | During the research for this project the following items were identified as out of scope but are captured here as potential future enhancements. If agreed upon during the review process these should be logged in the bug system.
| + | |
| − | | + | |
| − | * OC4J, WebSphere, JBoss, Geronimo specific MBean support
| + | |
