|
J2EE1.4 SDK | |||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
DomainRoot | The top-level interface for an appserver domain. |
Appserver Management Extensions (AMX) package summary.
Contents
Naming Conventions
Proxies Versus MBean Interfaces
System Requirements
Various suffixes are used for classes within AMX. These suffixes are
used consistently throughout the API to aid in understanding what any
particular class is used for. The suffix, combined with the package
name together give a strong clue as the functionality of any given
interface (MBean). Note that the J2EE Management (JSR 77) interfaces
do not use any suffix; these are specified by a standard.
Note that all interfaces representing MBeans are implemented as dynamic proxies to server-side MBeans. The actual MBean interface, as seen in its MBeanInfo, is a subset of this interface, and also differs slightly in certain consistent ways. See Proxy Versus MBean Interface below for further information.
Idiom | Explanation |
Abc | A dynamic proxy interface Abc, such as DomainRoot . |
AbcMgr | Manager interface for items or activities of type Abc |
XyzConfig |
Configuration interface for an item of type Xyz |
XyzMonitor |
Monitoring interface for an item of type Xyz |
Examples for naming conventions:
Example | Discussion |
DomainRoot | The root-level interface from which all others may be accessed. |
HTTPListenerConfig WebModuleConfig |
Configuration for an HTTP listener. |
DeploymentMgr | The interface for performing J2EE deployment. |
JMXMonitorMgr | Utility MBean for creating and destroying javax.management.monitor MBeans. |
ServletMonitor | Monitoring MBean for a Servlet. |
The AMX interfaces provide a convenient and easy-to-use way of accessing the server-side JMX MBeans. They are found in the following Java packages (or their sub-packages):
com.sun.appserv.management.base
com.sun.appserv.management.config
com.sun.appserv.management.monitor
com.sun.appserv.management.j2ee
com.sun.appserv.management.deploy
The com.sun.appserv.management.client
package contains code for initiating
connections to the Appserver. There are also a small number of
support classes.
AMX Interface (proxy) Pattern |
MBeanInfo Pattern |
Explanation |
Set
getContaineeJ2EETypes(); Map getMultiContaineeMap(...); Map getContaineeMap(...); AMX getSingletonContainee(...); Set getContaineeSet(...); Set getContaineeSet( ); Set getContaineeSet(...); Set getByNameContaineeSet(...); AMX getContainee(...); |
Set getContaineeJ2EETypes(); Map getMultiContaineeObjectNameMap(...); Map getContaineeObjectNameMap(...); ObjectName getSingletonContaineeObjectName(...); Set getContaineeObjectNameSet(...); Set getContaineeObjectNameSet( ); Set getContaineeObjectNameSet(...); Set getByNameContaineeObjectNameSet(...); ObjectName getContaineeObjectName(...); |
These
methods are from Container.
Note that ObjectName either replaces AMX or is inserted into the
operation name. |
AbcConfig createAbcConfig(...); |
ObjectName
createAbcConfig(...); |
Creation of a new item always returns an appropriate
interface for the type of item created when using AMX. When using
MBeans, an ObjectName is always returned. |
Abc getAbc(); | ObjectName getAbcObjectName(); | The MBean
represented by ObjectName implements the Abc interface
with the differences described in this table. |
System
requirements
The AMX client works against Appserver 8.1 PE or EE. It does not
support Appserver 8.0 or earlier. JDK 1.4 or 1.5 is
required. JDK 1.3 is neither tested, nor supported.
The following jar files are required to use the MBean API (AMX) and
must be in the classpath of your client application. They are found in
the appserver install at <install_root>/lib
.
jar file name | Discussion |
appserv-admin.jar |
This jar file contains all the
interfaces and classes necessary to access AMX; all of which reside
within the package com.sun.appserv.management or its
subpackages. Note that appserv-admin.jar also contains
other classes that are not needed for AMX. In the future, a separate,
smaller jar may be made available which contains just the minimal
classes; it is best not to assume any fixed dependency on this jar file
name.It is possible to extract just the com.sun.appserv.management classes
into a separate, and much smaller jar file. You may want to name
this jar "amx-client.jar". |
jmxremote.jar |
Contains the JMX Remote (JSR 160) classes--javax.management.remote.
If you are running JDK 1.5 or later, JMX remote is already
inco-rporated into the JDK (rt.jar). |
j2ee.jar |
For including JMX
1.2 classes--javax.management.
Alternately, you may download JMX directly and include include jmxri.jar .
If you are running JDK 1.5 or later, JMX is already incorporated into
the JDK (rt.jar). |
|
J2EE1.4 SDK | |||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
Copyright 2003 Sun Microsystems, Inc. All rights reserved.