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"
< EclipseLink | DesignDocs
m (New page: = Design Specification: <feature-name> = [http://bugs.eclipse.org/1234 ER <bug-number>] == Document History == {|{{BMTableStyle}} |-{{BMTHStyle}} ! Date ! Author ! Version Description & ...) |
m (→Design Specification: <feature-name>) |
||
| Line 1: | Line 1: | ||
= Design Specification: <feature-name> = | = Design Specification: <feature-name> = | ||
| − | [http://bugs.eclipse.org/ | + | [http://bugs.eclipse.org/235168] |
== Document History == | == Document History == | ||
| Line 10: | Line 10: | ||
! Version Description & Notes | ! Version Description & Notes | ||
|- | |- | ||
| − | | | + | | 2008-06-23 |
| − | | | + | | Michael O |
| − | | | + | | 0.1 Starting Draft |
|} | |} | ||
== Project overview == | == Project overview == | ||
| − | + | This enhancement will add JMX MBean support to EclipseLink | |
Goals: | Goals: | ||
| − | |||
| − | |||
== Concepts == | == Concepts == | ||
| + | Based on JMX 1.2 and JMX Remote API 1.0 | ||
| − | + | [[http://edocs.bea.com/wls/docs100/wlsmbeanref/core/index.html JMX MBeans in WebLogic 10]] | |
== Requirements == | == Requirements == | ||
| + | ===Phase 1: WebLogic 10.3 MBean support=== | ||
| + | * R1: Enable JMX MBean Support for WebLogic | ||
| + | ** R1.1: Enable predeploy MBean registration | ||
| + | ** R1.2: Enable application managed lazy-load MBean registration (post-deploy) | ||
| + | |||
| + | ===Phase 2: Generic MBean support=== | ||
| + | ** R2: Enable JMX MBean support for generic J2EE servers | ||
| − | |||
== Design Constraints == | == Design Constraints == | ||
== Design / Functionality == | == 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. | ||
| + | <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 == | == Testing == | ||
| + | A formal JMX J2SE client test suite is required. | ||
== API == | == API == | ||
| + | === | ||
== GUI == | == GUI == | ||
| Line 47: | Line 70: | ||
== Open Issues == | == Open Issues == | ||
| − | |||
{|{{BMTableStyle}} | {|{{BMTableStyle}} | ||
| Line 62: | Line 84: | ||
== Decisions == | == Decisions == | ||
| − | |||
{|{{BMTableStyle}} | {|{{BMTableStyle}} | ||
| Line 78: | Line 99: | ||
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. | 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 specific MBean support | ||
Revision as of 09:36, 23 June 2008
Design Specification: <feature-name>
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
Goals:
Concepts
Based on JMX 1.2 and JMX Remote API 1.0
Requirements
Phase 1: WebLogic 10.3 MBean support
- R1: Enable JMX MBean Support for WebLogic
- R1.1: Enable predeploy MBean registration
- R1.2: Enable application managed lazy-load MBean registration (post-deploy)
Phase 2: Generic MBean support
- R2: Enable JMX MBean support for generic J2EE servers
Design Constraints
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 specific MBean support