GlassFish Wiki : Amx_extension.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
<TITLE></TITLE>
<META NAME="GENERATOR" CONTENT="StarOffice 8 (Solaris x86)">
<META NAME="AUTHOR" CONTENT="Yamini">
<META NAME="CREATED" CONTENT="20071113;10510400">
<META NAME="CHANGEDBY" CONTENT="Yamini">
<META NAME="CHANGED" CONTENT="20071217;14301600">
<STYLE TYPE="text/css">
<!--
H2.western

Unknown macro: { font-family}

H2.cjk

Unknown macro: { font-family}

H2.ctl

Unknown macro: { font-family}

-->
</STYLE>
</HEAD>
<BODY LANG="en-US" DIR="LTR">
<H1 ALIGN=CENTER>Design Proposal for Extending GlassFish AMX</H1>
 

<H2 CLASS="western">Introduction</H2>
This document describes a proposal for extending the existing AMX
support in GlassFish. The need for this is driven by the SailFin
requirement to provide AMX support for the new SailFin Mbeans.
In the current AMX support code, it is not possible to plug-in
external Mbeans. By external, we mean Mbeans developed outside of
GlassFish to support any new domain configuration elements. The new
AMX Mbeans should be loaded automatically during the runtime. So our
aim is to provide runtime pluggability for the newly added AMX
Mbeans. At the same time, AMX extension should be done such that it
should not affect the loading of regular GlassFish AMX Mbeans.
When SailFin is installed on top of GlassFish, it should load the
new SailFin AMX Mbeans as well.
We would like to target this feature for GlassFish 9.1.1
<H2 CLASS="western">AMX Extension</H2>
We can enable extended AMX support by using a system property
“com.sun.appserv.pluggable.extensions.amx” This
property will basically point to an implementation class exposing
methods to pass all the required information to AMX support. The
following interface
com.sun.appserv.management.ext.support.ExtendedAMX can be
exposed from AMX:
 

 

 

<IMG SRC="http://wiki.glassfish.java.net/attach/Amx_extension.html/ExtendedAMX.jpg" NAME="graphics1" ALIGN=LEFT WIDTH=705 HEIGHT=635 BORDER=0> 

package com.sun.appserv.management.ext.support; 

import java.util.HashMap; 

import java.util.Map; 

/** 

* Base interface implemented by external modules. 

* All the extended AMX Support Features can be added here. 

* This interface is not for public
consumption. 

* 

* @author: Yamini K B 

*/ 

public interface ExtendedAMX

Unknown macro: { /** * Get all external AMX interfaces. * * @return Class[] containing the interfaces. */ public Class[] getExternalMbeanInterfaces(); /** * Get all the new config types. * * @return String[] containing the new config types. */ public String[] getAllConfigTypes(); /** * Get the child types for a config type. * * @return Object[] containing all the child types. */ public Object[] getAllChildTypes(); /** * Get all misc child types for a config type. * * @return String[)(] containing all the misc child types. */ public String[)(] getAllMiscChildTypes(); /** * Get the old config types. * * @return Map containing the old config types. */ public Map<String,String> getOldConfigTypes(); /** * Get the interface implementation classes * * @return Map conating the interface implementations. */ public Map<String,String> getInterfaceImpls(); /** * Get the old monitor types. * * @return Map containing the old monitor types. */ public Map<String,String> getOldMonitorTypes(); /** * Get all the new monitor types. * * @return String[] containing the new monitor types. */ public String[] getAllServerRootMonitorTypes(); /** * Get the child types for a monitor type. * * @return Object[] containing all the monitor child types. */ public Object[] getAllMonitorChildTypes(); }

<H2 CLASS="western">getExternalMbeanInterfaces()</H2>
Can return an array of the new AMX interfaces (like
SIPServiceConfig.class, SIPListenerConfig.class and so on..) This
will be consumed by TypesMapper during the initialization to
provide a mapping for the new types defined in SIPXTypes.
<H2 CLASS="western">getAllConfigTypes(), getAllChildTypes()</H2>
These methods can be used to define the containment. For example,
SIPServiceConfig
needs to be within ConfigConfig. Likewise,
SIPListenerConfig is
child of SIPServiceConfig
getAllConfigTypes() can return an array of all new child
types for ConfigConfig type.
getAllChildTypes() can
be used to define the new child types (i.e the containing objects)
for a specific container type. TypeInfos will
use the data provided from these two methods to define the
containment hierarchy for the new data types.
<H2 CLASS="western">getOldConfigTypes()</H2>
Provide a mapping between the new J2EE types and the “old”
config types. For example, the new J2EE type X-SIPServiceConfig
should map to the 'sip-service' configuration.
<H2 CLASS="western">getAllServerRootMonitorTypes(),
getAllMonitorChildTypes()</H2>
These methods can be used to define the containment for the
monitoring Mbeans. For example, SIPServiceMonitor needs to be
within ServerRootMonitorChild.
getAllMonitorChildTypes() can be used to define the new
monitor child types
<H2 CLASS="western">getOldMonitorTypes()</H2>
To provide a mapping between the new J2EE types and the “old”
monitor types. For example, the new J2EE type X-SIPServiceMonitor
should map to the monitoring service 'sip-service' configuration.
<H2 CLASS="western">getInterfaceImpls()</H2>
Currently the package info for the interface and implementation is
predefined. This method can be used to provide a mapping for the new
AMX interfaces and the actual implementation classes for
configuration and monitoring Mbeans.
<H2 CLASS="western">How will ExtendedAMX be used?</H2>
ExtendedAMX will be used in following places to plug-in the
external (SailFin in this case) Mbean information.
<OL>
<LI>We have a TypesMapper which maps the XTypes
with their Mbean interfaces. The TypesMapper can obtain the
list of new SailFin Mbean interfaces during the initialization using
getExternalMbeanInterfaces().
<LI>The TypeInfo class provides a mapping of the interface
and the actual implementation class. This information is passed
using getInterfaceImpls()
<LI>The TypeInfos
class defines the containment
hierarchy for the configuration or monitoring types. Using
ExtendedAMX, the
container/containee information can be passed to TypeInfos
for the SailFin configuration and
monitoring types.
<LI>The OldConfigTypes and
OldMonitorTypes loads the external mapping i.e for the SailFin
Xtypes.
</OL>
<H2 CLASS="western">Alternate AMX Extension</H2>
Instead of using system property, the new interface can be exposed
by using Pluggable Feature Factory of GlassFish. This pluggable
feature interface will be similar to ExtendedAMX interface
except that the feature will be loaded automatically during runtime
without introducing yet another JVM option!
<H2 CLASS="western">Packaging of SailFin AMX</H2>
<TABLE WIDTH=988 BORDER=1 BORDERCOLOR="#000000" CELLPADDING=4 CELLSPACING=0>
<COL WIDTH=446>
<COL WIDTH=212>
<COL WIDTH=305>
<TR VALIGN=TOP>
<TD WIDTH=446 BGCOLOR="#b3b3b3">
Prefix
</TD>
<TD WIDTH=212 BGCOLOR="#b3b3b3">
SailFin module
</TD>
<TD WIDTH=305 BGCOLOR="#b3b3b3">
Comments
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=446>
org.jvnet.glassfish.comms.management.config
</TD>
<TD WIDTH=212>
administration
</TD>
<TD WIDTH=305>
Config public interfaces
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=446>
org.jvnet.glassfish.comms.management.monitor
</TD>
<TD WIDTH=212>
administration
</TD>
<TD WIDTH=305>
Monitor public interfaces
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=446>
org.jvnet.glassfish.comms.admin.management.extensions.config
</TD>
<TD WIDTH=212>
administration
</TD>
<TD WIDTH=305>
Config implementation classes
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=446>
org.jvnet.glassfish.comms.admin.management.extensions.monitor
</TD>
<TD WIDTH=212>
administration
</TD>
<TD WIDTH=305>
Monitor implementation classes
</TD>
</TR>
</TABLE>
 

</BODY>
</HTML>

Attachments:

ExtendedAMX6.jpg (image/pjpeg)