com.bea.console.handles
Class JMXHandle

java.lang.Object
  com.bea.console.handles.HandleImpl
      com.bea.console.handles.JMXHandle

All Implemented Interfaces:

Handle, Serializable

public class JMXHandle
extends com.bea.console.handles.HandleImpl

Wraps a JMX ObjectName and is used to correlate an org.apache.struts.action.ActionForm bean with the MBean from which the bean has been populated.

This class implements the Handle interface and contains methods to retrieve the wrapped JMX ObjectName and other data.

See Also:

org.apache.struts.action.ActionForm, javax.management.ObjectName, Serialized Form

Constructor Summary

JMXHandle()
Creates a placeholder handle which you can use if the Portal framework requires a handle but you do not need the features that handles enable.

JMXHandle(ObjectName objectName)
Creates a handle for the specified JMX ObjectName.

JMXHandle(String objectIdentifier)
Creates a handle and assumes that the objectIdentifier parameter is a String representation of a JMX ObjectName.

Method Summary

String	getDisplayName() If you used the JMXHandle.JMXHandle(String objectIdentifier) constructor, returns the objectIdentifier that this object wraps.
ObjectName	getObjectName() If you used the JMXHandle.JMXHandle(ObjectName objectName) constructor, returns the javax.management.ObjectName that this object wraps.
String	getObjectType() Returns the value of the Type key property that was passed to the constructor of this handle.

Methods inherited from class com.bea.console.handles.HandleImpl

equals, getObjectIdentifier, getType, isInitialized, isObjectType, setObjectIdentifier, setType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JMXHandle

public JMXHandle()

Creates a placeholder handle which you can use if the Portal framework requires a handle but you do not need the features that handles enable.

JMXHandle

public JMXHandle(String objectIdentifier)

Creates a handle and assumes that the objectIdentifier parameter is a String representation of a JMX ObjectName. Does not require the ObjectName to be registered in an MBean server.

The objectIdentifier must contain a key property whose keyword is Type. For example:
com.bea:Name=myserver,Type=Server

JMXHandle

public JMXHandle(ObjectName objectName)

Creates a handle for the specified JMX ObjectName. Does not require the ObjectName to be registered in an MBean server.

The ObjectName must contain a key property whose keyword is Type. For example:
com.bea:Name=myserver,Type=Server

Method Detail

getObjectName

public ObjectName getObjectName()
                         throws MalformedObjectNameException

If you used the JMXHandle.JMXHandle(ObjectName objectName) constructor, returns the javax.management.ObjectName that this object wraps. Otherwise returns null.

Returns:

an ObjectName for this handle

Throws:

MalformedObjectNameException

getObjectType

public String getObjectType()

Returns the value of the Type key property that was passed to the constructor of this handle.

Specified by:

getObjectType in interface Handle

Overrides:

getObjectType in class com.bea.console.handles.HandleImpl

Returns:

java.lang.String

See Also:

Handle.getObjectType()

getDisplayName

public String getDisplayName()

If you used the JMXHandle.JMXHandle(String objectIdentifier) constructor, returns the objectIdentifier that this object wraps. Otherwise returns null.

Specified by:

getDisplayName in interface Handle

Overrides:

getDisplayName in class com.bea.console.handles.HandleImpl

Returns:

java.lang.String