Package com.tangosol.net.management

Class WrapperMBeanServerProxy

java.lang.Object

com.tangosol.net.management.WrapperMBeanServerProxy

All Implemented Interfaces:

MBeanServerProxy

public class WrapperMBeanServerProxy
extends Object
implements MBeanServerProxy

A MBeanServerProxy that wraps a MBeanServer.

Author:

jk 2019.05.30

Constructor Summary

Constructors

Constructor	Description
WrapperMBeanServerProxy(Supplier<MBeanServer> supplier)	Create a WrapperMBeanServerProxy.
WrapperMBeanServerProxy(MBeanServer server)	Create a WrapperMBeanServerProxy.

Method Summary

Modifier and Type	Method	Description
void	addNotificationListener(String sName, NotificationListener listener, NotificationFilter filter, Object oHandback)	Adds a listener to a registered MBean.
<R> R	execute(Remote.Function<MBeanServer,R> function)	A function executed on the management node.
Object	getAttribute(String sName, String sAttr)	Obtain the value of the specified MBean attribute.
Map<String,Object>	getAttributes(String sName, Filter<String> filter)	Return a Map of attribute name to attribute value for a given MBean name.
MBeanInfo	getMBeanInfo(String sName)	Return the MBeanInfo for a given MBean.
Object	invoke(String sName, String sOpName, Object[] aoParams, String[] asSignature)	Invoke an operation on the specified MBean.
boolean	isMBeanRegistered(String sName)	Check whether or not an MBean with the specified name is already registered.
MBeanServerProxy	local()	Return a local only MBeanServerProxy.
Set<String>	queryNames(String sPattern, Filter<ObjectName> filter)	Get the names of MBeans controlled by the MBean server that is collocated with the cluster registry.
Set<String>	queryNames(ObjectName pattern, Filter<ObjectName> filter)	Get the names of MBeans controlled by the MBean server that is collocated with the cluster registry.
void	removeNotificationListener(String sName, NotificationListener listener)	Removes a listener from a registered MBean.
void	removeNotificationListener(String sName, NotificationListener listener, NotificationFilter filter, Object oHandback)	Removes a listener from a registered MBean.
void	setAttribute(String sName, String sAttr, Object oValue)	Set the value of the specified MBean attribute.

Methods inherited from class java.lang.Object

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

Constructor Details

WrapperMBeanServerProxy

public WrapperMBeanServerProxy(MBeanServer server)

Create a WrapperMBeanServerProxy.

Parameters:

server - the MBeanServer to wrap

WrapperMBeanServerProxy

public WrapperMBeanServerProxy(Supplier<MBeanServer> supplier)

Create a WrapperMBeanServerProxy.

Parameters:

supplier - the Supplier of the MBeanServer to wrap

Method Details

getMBeanInfo

public MBeanInfo getMBeanInfo(String sName)

Description copied from interface: MBeanServerProxy

Return the MBeanInfo for a given MBean.

Specified by:

getMBeanInfo in interface MBeanServerProxy

Parameters:

sName - the MBean name

Returns:

the MBeanInfo for the MBean or null if the MBean does not exist

execute

public <R> R execute(Remote.Function<MBeanServer,R> function)

Description copied from interface: MBeanServerProxy

A function executed on the management node. The function is provided a local MBeanServer and can return any serializable result.

Specified by:

execute in interface MBeanServerProxy

Type Parameters:

R - the return type

Parameters:

function - the function to execute

Returns:

the result returned by the function

getAttributes

public Map<String,Object> getAttributes(String sName,
 Filter<String> filter)

Description copied from interface: MBeanServerProxy

Return a Map of attribute name to attribute value for a given MBean name.

The attributes returned must evaluate successfully against the provided Filter to be returned.

Specified by:

getAttributes in interface MBeanServerProxy

Parameters:

sName - the MBean name

filter - filter to limit the returned attributes

Returns:

a Map of attribute name to attribute value

getAttribute

public Object getAttribute(String sName,
 String sAttr)

Description copied from interface: MBeanServerProxy

Obtain the value of the specified MBean attribute.

Specified by:

getAttribute in interface MBeanServerProxy

Parameters:

sName - the MBean name

sAttr - the attribute name

Returns:

the value of the retrieved attribute

setAttribute

public void setAttribute(String sName,
 String sAttr,
 Object oValue)

Description copied from interface: MBeanServerProxy

Set the value of the specified MBean attribute.

Specified by:

setAttribute in interface MBeanServerProxy

Parameters:

sName - the MBean name

sAttr - the attribute name

oValue - the attribute value

invoke

public Object invoke(String sName,
 String sOpName,
 Object[] aoParams,
 String[] asSignature)

Description copied from interface: MBeanServerProxy

Invoke an operation on the specified MBean.

Specified by:

invoke in interface MBeanServerProxy

Parameters:

sName - the MBean name to invoke the method on

sOpName - the name of the method to be invoked

aoParams - an array containing the method parameters

asSignature - an optional array containing the method signatures, this parameter is only necessary if there are multiple methods with the same name

Returns:

the result of invocation

queryNames

public Set<String> queryNames(String sPattern,
 Filter<ObjectName> filter)

Description copied from interface: MBeanServerProxy

Get the names of MBeans controlled by the MBean server that is collocated with the cluster registry.

Specified by:

queryNames in interface MBeanServerProxy

Parameters:

sPattern - the MBean name pattern identifying MBean names to be retrieved; this pattern is the same as in the MBeanServer.queryNames method; if null, the name of all registered MBeans will be retrieved

filter - (optional) the filter to be applied for selecting MBeans

Returns:

a set of MBean names matching the pattern and the filter

queryNames

public Set<String> queryNames(ObjectName pattern,
 Filter<ObjectName> filter)

Description copied from interface: MBeanServerProxy

Get the names of MBeans controlled by the MBean server that is collocated with the cluster registry.

Specified by:

queryNames in interface MBeanServerProxy

Parameters:

pattern - the MBean name pattern identifying MBean names to be retrieved; this pattern is the same as in the MBeanServer.queryNames method; if null, the name of all registered MBeans will be retrieved

filter - (optional) the filter to be applied for selecting MBeans

Returns:

a set of MBean names matching the pattern and the filter

isMBeanRegistered

public boolean isMBeanRegistered(String sName)

Description copied from interface: MBeanServerProxy

Check whether or not an MBean with the specified name is already registered.

Specified by:

isMBeanRegistered in interface MBeanServerProxy

Parameters:

sName - the MBean name

Returns:

true iff the specified name is already registered

local

public MBeanServerProxy local()

Description copied from interface: MBeanServerProxy

Return a local only MBeanServerProxy.

A local only proxy operates only on the MBeans that are local to this member.

Specified by:

local in interface MBeanServerProxy

Returns:

a local only MBeanServerProxy

addNotificationListener

public void addNotificationListener(String sName,
 NotificationListener listener,
 NotificationFilter filter,
 Object oHandback)

Description copied from interface: MBeanServerProxy

Adds a listener to a registered MBean.

Notifications emitted by the MBean will be forwarded to the listener.

Specified by:

addNotificationListener in interface MBeanServerProxy

Parameters:

sName - the name of the MBean on which the listener should be added

listener - the listener object which will handle the notifications emitted by the registered MBean

filter - the filter object. If filter is null, no filtering will be performed before handling notifications

oHandback - the context to be sent to the listener when a notification is emitted

See Also:

• MBeanServerProxy.removeNotificationListener(String, NotificationListener)
• MBeanServerProxy.removeNotificationListener(String, NotificationListener, NotificationFilter, Object)

removeNotificationListener

public void removeNotificationListener(String sName,
 NotificationListener listener)

Description copied from interface: MBeanServerProxy

Removes a listener from a registered MBean.

If the listener is registered more than once, perhaps with different filters or callbacks, this method will remove all those registrations.

Specified by:

removeNotificationListener in interface MBeanServerProxy

Parameters:

sName - the name of the MBean on which the listener should be removed

listener - the listener to be removed

See Also:

• MBeanServerProxy.addNotificationListener(String, NotificationListener, NotificationFilter, Object)

removeNotificationListener

public void removeNotificationListener(String sName,
 NotificationListener listener,
 NotificationFilter filter,
 Object oHandback)

Description copied from interface: MBeanServerProxy

Removes a listener from a registered MBean.

The MBean must have a listener that exactly matches the given listener, filter, and handback parameters. If there is more than one such listener, only one is removed.

The filter and handback parameters may be null if and only if they are null in a listener to be removed.

Specified by:

removeNotificationListener in interface MBeanServerProxy

Parameters:

sName - the name of the MBean on which the listener should be removed

listener - the listener to be removed

filter - the filter that was specified when the listener was added

oHandback - the handback that was specified when the listener was added

See Also:

• MBeanServerProxy.addNotificationListener(String, NotificationListener, NotificationFilter, Object)