Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/DesignDocs/235168"
m (→Future Considerations) |
m (→Design Specification: JMX MBean Support) |
||
| Line 17: | Line 17: | ||
== Project overview == | == Project overview == | ||
| − | This enhancement will add JMX MBean support to EclipseLink 1.0 by exposing runtime and | + | 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 == | == Concepts == | ||
| Line 29: | Line 27: | ||
== Requirements == | == Requirements == | ||
| − | |||
* R1: Enable JMX MBean Support for WebLogic | * 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 == | == Design Constraints == | ||
| − | + | * C1: MBeans are not available until the first login of a server application (lazy-loaded) | |
| + | * C2: | ||
== Use Cases == | == Use Cases == | ||
| + | * UC1: EclipseLink managed MBean registration | ||
| + | * UC2: Application managed MBean registration | ||
| + | * UC3: No MBean registration | ||
== Design / Functionality == | == Design / Functionality == | ||
Revision as of 21:48, 23 June 2008
Design Specification: JMX MBean Support
Document History
| 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
ELUG Documentation 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
Predeploy Registration
Lazy Registration
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.
<!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>
Testing
A formal JMX J2SE client test suite is required.
API
=
GUI
Config files
Documentation
Open Issues
| Issue # | Owner | Description / Notes |
|---|---|---|
Decisions
| 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