wt.manager.jmx
Interface MethodServerMProxyMBean

All Superinterfaces:

SelfEmailingMBean

public interface MethodServerMProxyMBean
extends SelfEmailingMBean

Provides top-level overview of method servers associated with a server manager

Supported API: true

Extendable: true

Field Summary

static String	METHOD_SERVER_ADDED_NOTIF Type of notification produced when method server has been added to server table Supported API: true
static String	METHOD_SERVER_JMX_CONN_FAILED_NOTIF Type of notification produced when JMX connection to method server has failed Supported API: true
static String	METHOD_SERVER_REMOVED_NOTIF Type of notification produced when method server has been removed from server table Supported API: true

Method Summary

void	disconnectAllMethodServersMBeanProxies() Disconnect proxies for all method servers' MBeans Supported API: true
void	emailAllMBeansFromAllServerManagers(String addressesOrEmailList, String subject) Cause each server manager in the cluster to e-mail styled data for all its MBeans.
void	emailLogsDirsFromAllServerManagers(String addressesOrEmailList, String subject, boolean oneMessagePerFile, int maxAgeInDays, int minAgeInDays, String matchingExpression) For each LogsDirViewer MBean in each server manager, e-mail log files from its target log directory filtering by the specified file age Supported API: true
Map<String,Object>	getAttributesFromAllClusterMethodServers(ObjectName mbean, String[] attributeNames) Get attribute values from an MBean in all method servers in the cluster.
Map<String,Object>	getAttributesFromAllLocalMethodServers(ObjectName mbean, String[] attributeNames) Get attribute values from an MBean in all local method servers.
Map<String,Object>	getAttributesFromAllServerManagers(ObjectName mbean, String[] attributeNames) Get attribute values from an MBean in all server managers in the cluster.
int	getMethodServerCount() Current number of method servers associated with this server manager Supported API: true
String[]	getMethodServerJmxServiceUrls() URLs of method servers' JMX servers Supported API: true
String[]	getMethodServers() Display names of method servers Supported API: true
String[]	getUnproxiedMethodServers() Display names of method servers whose MBeans are not currently proxied Supported API: true
Map<String,Object>	invokeInAllClusterMethodServers(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation on an MBean in all method servers in the cluster.
Map<String,Object>	invokeInAllLocalMethodServers(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation on an MBean in all local method servers.
Map<String,Object>	invokeInAllServerManagers(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation on an MBean in all server managers in the cluster.
Map<String,Object>	invokeInfoOpInAllClusterMethodServers(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation with an INFO (read-only) impact on an MBean in all method servers in the cluster.
Map<String,Object>	invokeInfoOpInAllLocalMethodServers(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation with an INFO (read-only) impact on an MBean in all local method servers.
Map<String,Object>	invokeInfoOpInAllServerManagers(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation with an INFO (read-only) impact on an MBean in all server managers in the cluster.
boolean	isProxyingMethodServerMBeansByDefault() Whether method servers' MBeans are proxied into server manager's MBeanServer by default Supported API: true
void	proxyAllMethodServersMBeans() Proxy all method servers' MBeans Supported API: true
String	restartAllClusterMethodServers(boolean asyncRestart, long timeout) Restart all MethodServers in the cluster.
String	restartAllLocalMethodServers(boolean asyncRestart, long timeout) Restart all local MethodServers Supported API: true
Map<String,Object>	setAttributesInAllClusterMethodServers(ObjectName mbean, AttributeList attributes) Set attribute values on an MBean in all method servers in the cluster.
Map<String,Object>	setAttributesInAllLocalMethodServers(ObjectName mbean, AttributeList attributes) Set attributes on an MBean in all local method server.
Map<String,Object>	setAttributesInAllServerManagers(ObjectName mbean, AttributeList attributes) Set attributes on an MBean in all server managers in the cluster.
void	setLevelInAllClusterMethodServers(String loggerName, String level) Set log level for a given logger in all method servers in the cluster.
void	setLevelInAllLocalMethodServers(String loggerName, String level) Set log level for a given logger in all method servers.
void	setLevelInAllServerManagers(String loggerName, String level) Set log level for a given logger in all server managers in the cluster.
void	setPropertyInAllClusterMethodServers(String propertyName, String newValue) Sets the value of a specified property in all method servers in the cluster.
void	setPropertyInAllLocalMethodServers(String propertyName, String newValue) Sets the value of a specified property in all local method servers.
void	setPropertyInAllServerManagers(String propertyName, String newValue) Sets the value of a specified property in all server managers in the cluster.
void	setProxyingMethodServerMBeansByDefault(boolean proxying) Whether method servers' MBeans are proxied into server manager's MBeanServer by default Supported API: true
void	startServer(String serviceName) Start server for a given service name Supported API: true

Methods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean

emailThisMBean

Field Detail

METHOD_SERVER_ADDED_NOTIF

static final String METHOD_SERVER_ADDED_NOTIF

Type of notification produced when method server has been added to server table

Supported API: true

METHOD_SERVER_REMOVED_NOTIF

static final String METHOD_SERVER_REMOVED_NOTIF

Type of notification produced when method server has been removed from server table

Supported API: true

METHOD_SERVER_JMX_CONN_FAILED_NOTIF

static final String METHOD_SERVER_JMX_CONN_FAILED_NOTIF

Type of notification produced when JMX connection to method server has failed

Supported API: true

Method Detail

isProxyingMethodServerMBeansByDefault

boolean isProxyingMethodServerMBeansByDefault()

Whether method servers' MBeans are proxied into server manager's MBeanServer by default

Supported API: true

setProxyingMethodServerMBeansByDefault

void setProxyingMethodServerMBeansByDefault(boolean proxying)

Whether method servers' MBeans are proxied into server manager's MBeanServer by default

Supported API: true

getMethodServerCount

int getMethodServerCount()

Current number of method servers associated with this server manager

Supported API: true

getMethodServers

String[] getMethodServers()

Display names of method servers

Supported API: true

getMethodServerJmxServiceUrls

String[] getMethodServerJmxServiceUrls()

URLs of method servers' JMX servers

Supported API: true

getUnproxiedMethodServers

String[] getUnproxiedMethodServers()

Display names of method servers whose MBeans are not currently proxied

Supported API: true

proxyAllMethodServersMBeans

void proxyAllMethodServersMBeans()
                                 throws IOException

Proxy all method servers' MBeans

Supported API: true

Throws:

IOException

disconnectAllMethodServersMBeanProxies

void disconnectAllMethodServersMBeanProxies()

Disconnect proxies for all method servers' MBeans

Supported API: true

emailAllMBeansFromAllServerManagers

void emailAllMBeansFromAllServerManagers(String addressesOrEmailList,
                                         String subject)
                                         throws Exception

Cause each server manager in the cluster to e-mail styled data for all its MBeans.

Supported API: true

Parameters:

addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to

subject - Subject to give e-mail

Throws:

Exception

emailLogsDirsFromAllServerManagers

void emailLogsDirsFromAllServerManagers(String addressesOrEmailList,
                                        String subject,
                                        boolean oneMessagePerFile,
                                        int maxAgeInDays,
                                        int minAgeInDays,
                                        String matchingExpression)
                                        throws Exception

For each LogsDirViewer MBean in each server manager, e-mail log files from its target log directory filtering by the specified file age

Supported API: true

Parameters:

addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to

subject - Subject to give e-mail

oneMessagePerFile - Whether to send a separate e-mail message for each file

maxAgeInDays - Maximum age in days (by modification date) of files to e-mail

minAgeInDays - Minimum age in days (by modification date) of files to e-mail; ignored when less than or equal to zero

matchingExpression - Regular expression file names must match to be e-mailed; ignored if empty or null

Throws:

Exception

setLevelInAllLocalMethodServers

void setLevelInAllLocalMethodServers(String loggerName,
                                     String level)
                                     throws Exception

Set log level for a given logger in all method servers.

Supported API: true

Parameters:

loggerName - Name of logger

level - Level to assign logger; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Throws:

Exception

setLevelInAllClusterMethodServers

void setLevelInAllClusterMethodServers(String loggerName,
                                       String level)
                                       throws Exception

Set log level for a given logger in all method servers in the cluster.

Supported API: true

Parameters:

loggerName - Name of logger

level - Level to assign logger; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Throws:

Exception

setLevelInAllServerManagers

void setLevelInAllServerManagers(String loggerName,
                                 String level)
                                 throws Exception

Set log level for a given logger in all server managers in the cluster.

Supported API: true

Parameters:

loggerName - Name of logger

level - Level to assign logger; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Throws:

Exception

startServer

void startServer(String serviceName)
                 throws Exception

Start server for a given service name

Supported API: true

Parameters:

serviceName - Name of service to start (e.g. "MethodServer" or "BackgroundMethodServer"); defaults to "MethodServer" if not specified

Throws:

Exception

restartAllLocalMethodServers

String restartAllLocalMethodServers(boolean asyncRestart,
                                    long timeout)
                                    throws Exception

Restart all local MethodServers

Supported API: true

Parameters:

asyncRestart - Whether or not to restart MethodServers asynchronously or wait for the entire action to complete before returning.

timeout - The number of milliseconds to wait for a MethodServer to restart; values of 0 or less will imply an unlimited wait.

Returns:

String - Success/failure message for this action.

Throws:

Exception - - Thrown if an error occurrs while restarting MethodServers.

restartAllClusterMethodServers

String restartAllClusterMethodServers(boolean asyncRestart,
                                      long timeout)
                                      throws Exception

Restart all MethodServers in the cluster.

Supported API: true

Parameters:

asyncRestart - Whether or not to restart MethodServers asynchronously or wait for the entire action to complete before returning.

timeout - The number of milliseconds to wait for a MethodServer to restart; values of 0 or less will imply an unlimited wait.

Returns:

String - Success/failure message for this action.

Throws:

Exception - - Thrown if an error occurrs while restarting MethodServers.

setPropertyInAllLocalMethodServers

void setPropertyInAllLocalMethodServers(String propertyName,
                                        String newValue)
                                        throws Exception

Sets the value of a specified property in all local method servers.

Supported API: true

Parameters:

propertyName - Name of property to retrieve

newValue - New value to aassign to property

Throws:

Exception

setPropertyInAllClusterMethodServers

void setPropertyInAllClusterMethodServers(String propertyName,
                                          String newValue)
                                          throws Exception

Sets the value of a specified property in all method servers in the cluster.

Supported API: true

Parameters:

propertyName - Name of property to retrieve

newValue - New value to aassign to property

Throws:

Exception

setPropertyInAllServerManagers

void setPropertyInAllServerManagers(String propertyName,
                                    String newValue)
                                    throws Exception

Sets the value of a specified property in all server managers in the cluster.

Supported API: true

Parameters:

propertyName - Name of property to retrieve

newValue - New value to aassign to property

Throws:

Exception

getAttributesFromAllLocalMethodServers

Map<String,Object> getAttributesFromAllLocalMethodServers(ObjectName mbean,
                                                          String[] attributeNames)

Get attribute values from an MBean in all local method servers. Results (which will be AttributeLists) and exceptions are both returned in a map by method server name.

Supported API: true

Parameters:

mbean - ObjectName of target MBean

attributeNames - Names of attributes to fetch values for

getAttributesFromAllClusterMethodServers

Map<String,Object> getAttributesFromAllClusterMethodServers(ObjectName mbean,
                                                            String[] attributeNames)
                                                            throws InvocationTargetException,
                                                                   RemoteException

Get attribute values from an MBean in all method servers in the cluster. Results and exceptions are both returned in a map by server manager id string. Results within this map are in turn as described by getAttributesFromAllLocalMethodServers().

Supported API: true

Parameters:

mbean - ObjectName of target MBean

attributeNames - Names of attributes to fetch values for

Throws:

InvocationTargetException

RemoteException

getAttributesFromAllServerManagers

Map<String,Object> getAttributesFromAllServerManagers(ObjectName mbean,
                                                      String[] attributeNames)
                                                      throws InvocationTargetException,
                                                             RemoteException

Get attribute values from an MBean in all server managers in the cluster. Results (which will be AttributeLists) and exceptions are both returned in a map by server manager id string.

Supported API: true

Parameters:

mbean - ObjectName of target MBean

attributeNames - Names of attributes to fetch values for

Throws:

InvocationTargetException

RemoteException

setAttributesInAllLocalMethodServers

Map<String,Object> setAttributesInAllLocalMethodServers(ObjectName mbean,
                                                        AttributeList attributes)

Set attributes on an MBean in all local method server. Results (which will be AttributeLists) and exceptions are both returned in a map by method server name.

Supported API: true

Parameters:

mbean - ObjectName of target MBean

attributes - Attribute settings to apply

setAttributesInAllClusterMethodServers

Map<String,Object> setAttributesInAllClusterMethodServers(ObjectName mbean,
                                                          AttributeList attributes)
                                                          throws InvocationTargetException,
                                                                 RemoteException

Set attribute values on an MBean in all method servers in the cluster. Results and exceptions are both returned in a map by server manager id string. Results within this map are in turn as described by setAttributesInAllLocalMethodServers().

Supported API: true

Parameters:

mbean - ObjectName of target MBean

attributes - Attribute settings to apply

Throws:

InvocationTargetException

RemoteException

setAttributesInAllServerManagers

Map<String,Object> setAttributesInAllServerManagers(ObjectName mbean,
                                                    AttributeList attributes)
                                                    throws InvocationTargetException,
                                                           RemoteException

Set attributes on an MBean in all server managers in the cluster. Results (which will be AttributeLists) and exceptions are both returned in a map by server manager id string.

Supported API: true

Parameters:

mbean - ObjectName of target MBean

attributes - Attribute settings to apply

Throws:

InvocationTargetException

RemoteException

invokeInAllLocalMethodServers

Map<String,Object> invokeInAllLocalMethodServers(ObjectName mbean,
                                                 String operation,
                                                 Object[] params,
                                                 String[] signature)

Invoke an operation on an MBean in all local method servers. Results and exceptions are both returned in a map by method server name.

Supported API: true

Parameters:

mbean - ObjectName of target MBean

operation - Name of target operation

params - Arguments of target operation

signature - Signature of target operation

invokeInfoOpInAllLocalMethodServers

Map<String,Object> invokeInfoOpInAllLocalMethodServers(ObjectName mbean,
                                                       String operation,
                                                       Object[] params,
                                                       String[] signature)

Invoke an operation with an INFO (read-only) impact on an MBean in all local method servers. Results and exceptions are both returned in a map by method server name. If the target operation is found to have a non-INFO impact for a given MBean, the operation will not be invoked on that MBean and an exception will be returned in the map for this MBean.

Supported API: true

Parameters:

mbean - ObjectName of target MBean

operation - Name of target operation

params - Arguments of target operation

signature - Signature of target operation

invokeInAllClusterMethodServers

Map<String,Object> invokeInAllClusterMethodServers(ObjectName mbean,
                                                   String operation,
                                                   Object[] params,
                                                   String[] signature)
                                                   throws InvocationTargetException,
                                                          RemoteException

Invoke an operation on an MBean in all method servers in the cluster. Results and exceptions are both returned in a map by server manager id string. Results within this map are in turn as described by invokeInAllLocalMethodServers().

Supported API: true

Parameters:

mbean - ObjectName of target MBean

operation - Name of target operation

params - Arguments of target operation

signature - Signature of target operation

Throws:

InvocationTargetException

RemoteException

invokeInfoOpInAllClusterMethodServers

Map<String,Object> invokeInfoOpInAllClusterMethodServers(ObjectName mbean,
                                                         String operation,
                                                         Object[] params,
                                                         String[] signature)
                                                         throws InvocationTargetException,
                                                                RemoteException

Invoke an operation with an INFO (read-only) impact on an MBean in all method servers in the cluster. Results and exceptions are both returned in a map by server manager id string. Results within this map are in turn as described by invokeInAllLocalMethodServers(). If the target operation is found to have a non-INFO impact for a given MBean, the operation will not be invoked on that MBean and an exception will be returned in the map for this MBean.

Supported API: true

Parameters:

mbean - ObjectName of target MBean

operation - Name of target operation

params - Arguments of target operation

signature - Signature of target operation

Throws:

InvocationTargetException

RemoteException

invokeInAllServerManagers

Map<String,Object> invokeInAllServerManagers(ObjectName mbean,
                                             String operation,
                                             Object[] params,
                                             String[] signature)
                                             throws InvocationTargetException,
                                                    RemoteException

Invoke an operation on an MBean in all server managers in the cluster. Results and exceptions are both returned in a map by server manager id string.

Supported API: true

Parameters:

mbean - ObjectName of target MBean

operation - Name of target operation

params - Arguments of target operation

signature - Signature of target operation

Throws:

InvocationTargetException

RemoteException

invokeInfoOpInAllServerManagers

Map<String,Object> invokeInfoOpInAllServerManagers(ObjectName mbean,
                                                   String operation,
                                                   Object[] params,
                                                   String[] signature)
                                                   throws InvocationTargetException,
                                                          RemoteException

Invoke an operation with an INFO (read-only) impact on an MBean in all server managers in the cluster. Results and exceptions are both returned in a map by server manager id string. If the target operation is found to have a non-INFO impact for a given MBean, the operation will not be invoked on that MBean and an exception will be returned in the map for this MBean.

Supported API: true

Parameters:

mbean - ObjectName of target MBean

operation - Name of target operation

params - Arguments of target operation

signature - Signature of target operation

Throws:

InvocationTargetException

RemoteException