Interface MethodServerMProxyMBean
- All Superinterfaces:
SelfEmailingMBean
Supported API: true
Extendable: true
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringType of notification produced when method server has been added to server table
Supported API: truestatic final StringType of notification produced when JMX connection to method server has failed
Supported API: truestatic final StringType of notification produced when method server has been removed from server table
Supported API: true -
Method Summary
Modifier and TypeMethodDescriptionvoidDisconnect proxies for all method servers' MBeans
Supported API: truevoiddumpAllMBeansToFileForClusterNode(String fileNameBase) Dump styled data to a file for all MBeans for this server manager except those proxied from its method servers and then cause each of its method servers to dump their own MBeans to a file.voiddumpAllMBeansToFileFromAllServerManagers(String fileNameBase) Cause each server manager in the cluster to dump styled data for all its MBeans.voidDumps full stack to a file for each server manager and method server in the cluster.String[]Get data (as XML) on all MBeans in this server manager that are not proxied from a method server
Supported API: truebyte[]dumpMBeansForThisServerManagerToGzippedBytes(String xslt, boolean applyXslt) Get gzip compressed data (as XML) on all MBeans in this server manager that are not proxied from a method server
Supported API: truevoiddumpMBeansToFileForThisServerManager(String outputFileRef) Dump styled data for all MBeans in this server manager that are not proxied from a method server
Supported API: truevoidemailActiveMethodContexts(String addressesOrEmailList, String subject, boolean compress, boolean allClusterNodes) E-mail styled data for all method contexts currently being processed
Supported API: truevoidemailAllMBeansForClusterNode(String addressesOrEmailList, String subject) E-mail styled data for all MBeans for this server manager except those proxied from its method servers and cause each of its method servers to e-mail their own MBeans.voidemailAllMBeansFromAllServerManagers(String addressesOrEmailList, String subject) Cause each server manager in the cluster to e-mail styled data for all its MBeans.voidemailLogsDirsFromAllServerManagers(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: truevoidemailMBeansForThisServerManager(String addressesOrEmailList, String subject) E-mail styled data for all MBeans in this server manager that are not proxied from a method server
Supported API: truefetchFileFromServerManager(String jvmName, ObjectName dirViewMBean, String relativeFilePath) Fetch file from a specified server manager; if fetching from this server manager the file path is returned, else streams the remote file to a local temporary file (without applying compression) and returns its path instead
Supported API: truefetchFileFromServerManager(String jvmName, ObjectName dirViewMBean, String relativeFilePath, boolean compress) Fetch file from a specified server manager; if fetching from this server manager the file path is returned, else streams the remote file to a local temporary file and returns its path instead
Supported API: truegetAttributesFromAllClusterMethodServers(ObjectName mbean, String[] attributeNames) Get attribute values from an MBean in all method servers in the cluster.getAttributesFromAllLocalMethodServers(ObjectName mbean, String[] attributeNames) Get attribute values from an MBean in all local method servers.getAttributesFromAllServerManagers(ObjectName mbean, String[] attributeNames) Get attribute values from an MBean in all server managers in the cluster.getAttributesFromServerManager(String jvmName, ObjectName mbean, String[] attributeNames) Get attribute values from an MBean in a specific server manager.intExpected number of method servers associated with this server manager
Supported API: trueintCurrent number of method servers associated with this server manager
Supported API: trueString[]URLs of method servers' JMX servers
Supported API: trueString[]Display names of method servers
Supported API: trueString[]Display names of method servers whose MBeans are not currently proxied
Supported API: trueinvokeInAllClusterMethodServers(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation on an MBean in all method servers in the cluster.invokeInAllLocalMethodServers(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation on an MBean in all local method servers.invokeInAllServerManagers(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation on an MBean in all server managers in the cluster.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.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.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.invokeInfoOpInOneLocalMethodServer(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation with an INFO (read-only) impact on an MBean in local method servers, stopping after the first invocation that does not result in an exception.invokeInfoOpInServerManager(String jvmName, ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation with an INFO (read-only) impact on an MBean in a specific server manager.invokeInfoOpsInAllServerManagers(ObjectName[] targetMBeans, String operation, Object[] params, String[] signature) Invoke a single operation with an INFO (read-only) impact on multiple MBeans (using the same parameters in each case) in all server managers.invokeInOneLocalMethodServer(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation on an MBean in local method servers, stopping after the first invocation that does not result in an exception.invokeInServerManager(String jvmName, ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation on an MBean in a specific server manager.booleanWhether method servers' MBeans are proxied into server manager's MBeanServer by default
Supported API: truevoidProxy all method servers' MBeans
Supported API: truerestartAllClusterMethodServers(boolean asyncRestart, long timeout) Restart all MethodServers in the cluster.restartAllLocalMethodServers(boolean asyncRestart, long timeout) Restart all local MethodServers
Supported API: truesearchFilesAsStreamingMapInAllServerManagers(ObjectName[] dirViewMBeans, String searchRegexp, String newEntryRegexp, boolean recursive, int maxAgeInDays, int minAgeInDays, String callerFileMatchingExpr, int maxLines, int streamThresholdCharCount) [FOR INTERNAL USE ONLY] Searches files from all specified DirViewMBeans in all server managers.voidsendAllMBeansForClusterNodeToSuppport(long callNumber, String description) Send styled data to technical support for all MBeans for this server manager except those proxied from its method servers and cause each of its method servers to send their own MBeans.voidsendAllServerManagersMBeansToSuppport(long callNumber, String description) Cause each server manager in the cluster to send styled data to technical support for all of its MBeans.voidsendLogsDirsFromAllServerManagersToSupport(long callNumber, String description, int maxAgeInDays, int minAgeInDays, String matchingExpression) For each LogsDirViewer MBean in each server manager, send log files from its target log directory to tech support filtering as specified
Supported API: truevoidsendThisServerManagersMBeansToSuppport(long callNumber, String description) Send styled data to technical support for all MBeans in this server manager that are not proxied from a method server
Supported API: truesetAttributesInAllClusterMethodServers(ObjectName mbean, AttributeList attributes) Set attribute values on an MBean in all method servers in the cluster.setAttributesInAllLocalMethodServers(ObjectName mbean, AttributeList attributes) Set attributes on an MBean in all local method server.setAttributesInAllServerManagers(ObjectName mbean, AttributeList attributes) Set attributes on an MBean in all server managers in the cluster.setAttributesInServerManager(String jvmName, ObjectName mbean, AttributeList attributes) Set attributes on an MBean in a specific server manager.voidsetLevelInAllClusterMethodServers(String loggerName, String level) Set log level for a given logger in all method servers in the cluster.voidsetLevelInAllLocalMethodServers(String loggerName, String level) Set log level for a given logger in all method servers.voidsetLevelInAllServerManagers(String loggerName, String level) Set log level for a given logger in all server managers in the cluster.voidsetPropertyInAllClusterMethodServers(String propertyName, String newValue) Sets the value of a specified property in all method servers in the cluster.voidsetPropertyInAllLocalMethodServers(String propertyName, String newValue) Sets the value of a specified property in all local method servers.voidsetPropertyInAllServerManagers(String propertyName, String newValue) Sets the value of a specified property in all server managers in the cluster.voidsetProxyingMethodServerMBeansByDefault(boolean proxying) Whether method servers' MBeans are proxied into server manager's MBeanServer by default
Supported API: truevoidstartServer(String serviceName) Start server for a given service name
Supported API: trueMethods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean
emailThisMBean
-
Field Details
-
METHOD_SERVER_ADDED_NOTIF
Type of notification produced when method server has been added to server table
Supported API: true -
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
Type of notification produced when JMX connection to method server has failed
Supported API: true
-
-
Method Details
-
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 -
getExpectedMethodServerCount
int getExpectedMethodServerCount()Expected 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
Proxy all method servers' MBeans
Supported API: true- Throws:
IOException
-
disconnectAllMethodServersMBeanProxies
Disconnect proxies for all method servers' MBeans
Supported API: true -
dumpMBeansForThisServerManager
Get data (as XML) on all MBeans in this server manager that are not proxied from a method server
Supported API: true- Throws:
SAXException
-
dumpMBeansForThisServerManagerToGzippedBytes
@MBeanOperationImpact(0) byte[] dumpMBeansForThisServerManagerToGzippedBytes(String xslt, boolean applyXslt) throws IOException, SAXException Get gzip compressed data (as XML) on all MBeans in this server manager that are not proxied from a method server
Supported API: true- Parameters:
xslt- Reference (URL, file, or resource) to XSLT stylesheet to apply; defaults to Dumper MBean's DefaultXsltStylesheetURL if not specifiedapplyXslt- Whether to apply XSLT or just insert a processing instruction for it- Throws:
IOExceptionSAXException
-
dumpAllMBeansToFileForClusterNode
@MBeanOperationImpact(0) void dumpAllMBeansToFileForClusterNode(String fileNameBase) throws Exception Dump styled data to a file for all MBeans for this server manager except those proxied from its method servers and then cause each of its method servers to dump their own MBeans to a file.
Supported API: true- Parameters:
fileNameBase- Base name of the file to dump to, will be appended with name of the server- Throws:
Exception
-
dumpMBeansToFileForThisServerManager
@MBeanOperationImpact(0) void dumpMBeansToFileForThisServerManager(String outputFileRef) throws Exception Dump styled data for all MBeans in this server manager that are not proxied from a method server
Supported API: true- Parameters:
outputFileRef- Name of the file to dump to- Throws:
Exception
-
dumpAllMBeansToFileFromAllServerManagers
@MBeanOperationImpact(0) void dumpAllMBeansToFileFromAllServerManagers(String fileNameBase) throws Exception Cause each server manager in the cluster to dump styled data for all its MBeans.
Supported API: true- Parameters:
fileNameBase- Base name of the file to dump to, will be appended with server names- Throws:
Exception
-
dumpFullStackTraceToFileForAllServers
Dumps full stack to a file for each server manager and method server in the cluster.
Supported API: true -
emailMBeansForThisServerManager
@MBeanOperationImpact(0) void emailMBeansForThisServerManager(String addressesOrEmailList, String subject) throws IOException, SAXException E-mail styled data for all MBeans in this server manager that are not proxied from a method server
Supported API: true- Parameters:
addressesOrEmailList- Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail tosubject- Subject to give e-mail- Throws:
IOExceptionSAXException
-
emailAllMBeansFromAllServerManagers
@MBeanOperationImpact(0) 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 tosubject- Subject to give e-mail- Throws:
Exception
-
emailAllMBeansForClusterNode
@MBeanOperationImpact(0) void emailAllMBeansForClusterNode(String addressesOrEmailList, String subject) throws Exception E-mail styled data for all MBeans for this server manager except those proxied from its method servers and cause each of its method servers to e-mail their own MBeans.
Supported API: true- Parameters:
addressesOrEmailList- Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail tosubject- Subject to give e-mail- Throws:
Exception
-
sendThisServerManagersMBeansToSuppport
@MBeanOperationImpact(0) void sendThisServerManagersMBeansToSuppport(long callNumber, String description) throws Exception Send styled data to technical support for all MBeans in this server manager that are not proxied from a method server
Supported API: true- Parameters:
callNumber- Existing technical support call number to associate this data withdescription- Description to give data- Throws:
Exception
-
sendAllMBeansForClusterNodeToSuppport
@MBeanOperationImpact(0) void sendAllMBeansForClusterNodeToSuppport(long callNumber, String description) throws Exception Send styled data to technical support for all MBeans for this server manager except those proxied from its method servers and cause each of its method servers to send their own MBeans.
Supported API: true- Parameters:
callNumber- Existing technical support call number to associate this data withdescription- Description to give data- Throws:
Exception
-
sendAllServerManagersMBeansToSuppport
@MBeanOperationImpact(0) void sendAllServerManagersMBeansToSuppport(long callNumber, String description) throws Exception Cause each server manager in the cluster to send styled data to technical support for all of its MBeans.
Supported API: true- Parameters:
callNumber- Existing technical support call number to associate this data withdescription- Description to give data- Throws:
Exception
-
sendLogsDirsFromAllServerManagersToSupport
@MBeanOperationImpact(0) void sendLogsDirsFromAllServerManagersToSupport(long callNumber, String description, int maxAgeInDays, int minAgeInDays, String matchingExpression) throws Exception For each LogsDirViewer MBean in each server manager, send log files from its target log directory to tech support filtering as specified
Supported API: true- Parameters:
callNumber- Existing technical support call number to associate this data withdescription- Description to give datamaxAgeInDays- Maximum age in days (by modification date) of files to sendminAgeInDays- Minimum age in days (by modification date) of files to send; ignored when less than or equal to zeromatchingExpression- Regular expression file names must match to be sent; ignored if empty or null- Throws:
Exception
-
emailLogsDirsFromAllServerManagers
@MBeanOperationImpact(0) 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 tosubject- Subject to give e-mailoneMessagePerFile- Whether to send a separate e-mail message for each filemaxAgeInDays- Maximum age in days (by modification date) of files to e-mailminAgeInDays- Minimum age in days (by modification date) of files to e-mail; ignored when less than or equal to zeromatchingExpression- Regular expression file names must match to be e-mailed; ignored if empty or null- Throws:
Exception
-
setLevelInAllLocalMethodServers
@MBeanOperationImpact(1) 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 loggerlevel- Level to assign logger; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)- Throws:
Exception
-
setLevelInAllClusterMethodServers
@MBeanOperationImpact(1) 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 loggerlevel- Level to assign logger; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)- Throws:
Exception
-
setLevelInAllServerManagers
@MBeanOperationImpact(1) 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 loggerlevel- Level to assign logger; valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)- Throws:
Exception
-
startServer
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
@MBeanOperationImpact(1) 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
@MBeanOperationImpact(1) 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 occurs while restarting MethodServers.
-
setPropertyInAllLocalMethodServers
@MBeanOperationImpact(1) 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 retrievenewValue- New value to assign to property- Throws:
Exception
-
setPropertyInAllClusterMethodServers
@MBeanOperationImpact(1) 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 retrievenewValue- New value to assign to property- Throws:
Exception
-
setPropertyInAllServerManagers
@MBeanOperationImpact(1) 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 retrievenewValue- New value to assign to property- Throws:
Exception
-
emailActiveMethodContexts
@MBeanOperationImpact(0) void emailActiveMethodContexts(String addressesOrEmailList, String subject, boolean compress, boolean allClusterNodes) throws Exception E-mail styled data for all method contexts currently being processed
Supported API: true- Parameters:
addressesOrEmailList- Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail tosubject- Subject to give e-mailcompress- Whether e-mail contents should be compressedallClusterNodes- Whether operation should be performed for all method servers in cluster or just local ones- Throws:
Exception
-
getAttributesFromAllLocalMethodServers
@MBeanOperationImpact(0) 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 MBeanattributeNames- Names of attributes to fetch values for
-
getAttributesFromAllClusterMethodServers
@MBeanOperationImpact(0) Map<String,Object> getAttributesFromAllClusterMethodServers(ObjectName mbean, String[] attributeNames) 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 MBeanattributeNames- Names of attributes to fetch values for
-
getAttributesFromServerManager
@MBeanOperationImpact(0) AttributeList getAttributesFromServerManager(String jvmName, ObjectName mbean, String[] attributeNames) throws Exception Get attribute values from an MBean in a specific server manager.
Supported API: true- Parameters:
jvmName- JVM name of target server managermbean- ObjectName of target MBeanattributeNames- Names of attributes to fetch values for- Throws:
Exception
-
getAttributesFromAllServerManagers
@MBeanOperationImpact(0) Map<String,Object> getAttributesFromAllServerManagers(ObjectName mbean, String[] attributeNames) 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 MBeanattributeNames- Names of attributes to fetch values for
-
setAttributesInAllLocalMethodServers
@MBeanOperationImpact(1) 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 MBeanattributes- Attribute settings to apply
-
setAttributesInAllClusterMethodServers
@MBeanOperationImpact(1) Map<String,Object> setAttributesInAllClusterMethodServers(ObjectName mbean, AttributeList attributes) 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 MBeanattributes- Attribute settings to apply
-
setAttributesInServerManager
@MBeanOperationImpact(1) AttributeList setAttributesInServerManager(String jvmName, ObjectName mbean, AttributeList attributes) throws Exception Set attributes on an MBean in a specific server manager.
Supported API: true- Parameters:
jvmName- JVM name of target server managermbean- ObjectName of target MBeanattributes- Attribute settings to apply- Throws:
Exception
-
setAttributesInAllServerManagers
@MBeanOperationImpact(1) Map<String,Object> setAttributesInAllServerManagers(ObjectName mbean, AttributeList attributes) 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 MBeanattributes- Attribute settings to apply
-
invokeInAllLocalMethodServers
@MBeanOperationImpact(1) 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 MBeanoperation- Name of target operationparams- Arguments of target operationsignature- Signature of target operation
-
invokeInfoOpInAllLocalMethodServers
@MBeanOperationImpact(0) 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 MBeanoperation- Name of target operationparams- Arguments of target operationsignature- Signature of target operation
-
invokeInOneLocalMethodServer
@MBeanOperationImpact(1) Map<String,Object> invokeInOneLocalMethodServer(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation on an MBean in local method servers, stopping after the first invocation that does not result in an exception. In the case of success, the return map will contain the successful method server name as the key and the invocation result as the value. In the case of failure, the return map will contain a map of exceptions by method server name.
Supported API: true- Parameters:
mbean- ObjectName of target MBeanoperation- Name of target operationparams- Arguments of target operationsignature- Signature of target operation
-
invokeInfoOpInOneLocalMethodServer
@MBeanOperationImpact(0) Map<String,Object> invokeInfoOpInOneLocalMethodServer(ObjectName mbean, String operation, Object[] params, String[] signature) Invoke an operation with an INFO (read-only) impact on an MBean in local method servers, stopping after the first invocation that does not result in an exception. In the case of success, the return map will contain the successful method server name as the key and the invocation result as the value. In the case of failure, the return map will contain a map of exceptions 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 MBeanoperation- Name of target operationparams- Arguments of target operationsignature- Signature of target operation
-
invokeInAllClusterMethodServers
@MBeanOperationImpact(1) 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. 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 MBeanoperation- Name of target operationparams- Arguments of target operationsignature- Signature of target operation
-
invokeInfoOpInAllClusterMethodServers
@MBeanOperationImpact(0) 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. 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 MBeanoperation- Name of target operationparams- Arguments of target operationsignature- Signature of target operation
-
invokeInServerManager
@MBeanOperationImpact(1) Object invokeInServerManager(String jvmName, ObjectName mbean, String operation, Object[] params, String[] signature) throws Exception Invoke an operation on an MBean in a specific server manager.
Supported API: true- Parameters:
jvmName- JVM name of target server managermbean- ObjectName of target MBeanoperation- Name of target operationparams- Arguments of target operationsignature- Signature of target operation- Throws:
Exception
-
invokeInAllServerManagers
@MBeanOperationImpact(1) 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. Results and exceptions are both returned in a map by server manager id string.
Supported API: true- Parameters:
mbean- ObjectName of target MBeanoperation- Name of target operationparams- Arguments of target operationsignature- Signature of target operation
-
invokeInfoOpInServerManager
@MBeanOperationImpact(0) Object invokeInfoOpInServerManager(String jvmName, ObjectName mbean, String operation, Object[] params, String[] signature) throws Exception Invoke an operation with an INFO (read-only) impact on an MBean in a specific server manager.
Supported API: true- Parameters:
jvmName- JVM name of target server managermbean- ObjectName of target MBeanoperation- Name of target operationparams- Arguments of target operationsignature- Signature of target operation- Throws:
Exception
-
invokeInfoOpInAllServerManagers
@MBeanOperationImpact(0) 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. 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 MBeanoperation- Name of target operationparams- Arguments of target operationsignature- Signature of target operation
-
invokeInfoOpsInAllServerManagers
@MBeanOperationImpact(0) Map<String,Object> invokeInfoOpsInAllServerManagers(ObjectName[] targetMBeans, String operation, Object[] params, String[] signature) Invoke a single operation with an INFO (read-only) impact on multiple MBeans (using the same parameters in each case) in all server managers.Returns results as a Map from server manager names to special "streaming" search results for that server manager. Each value in the result Map is the result (either a
Throwableor the actual return result) ofDumper.invokeInfoOperations(javax.management.ObjectName[], javax.management.QueryExp[], java.lang.String[], java.lang.Object[][], java.lang.String[][])with the specified operation being for each target MBean specified.
Supported API: true- Parameters:
targetMBeans- MBeans to invoke the operation uponoperation- Name of target operationparams- Arguments of target operationsignature- Signature of target operation- Returns:
-
fetchFileFromServerManager
@MBeanOperationImpact(0) String fetchFileFromServerManager(String jvmName, ObjectName dirViewMBean, String relativeFilePath) throws Exception Fetch file from a specified server manager; if fetching from this server manager the file path is returned, else streams the remote file to a local temporary file (without applying compression) and returns its path instead
Supported API: true- Parameters:
jvmName- JVM name of target server managerdirViewMBean- ObjectName of target DirView MBeanrelativeFilePath- Path of file relative to directory targeted by the DirView MBean- Throws:
Exception
-
fetchFileFromServerManager
@MBeanOperationImpact(0) String fetchFileFromServerManager(String jvmName, ObjectName dirViewMBean, String relativeFilePath, boolean compress) throws Exception Fetch file from a specified server manager; if fetching from this server manager the file path is returned, else streams the remote file to a local temporary file and returns its path instead
Supported API: true- Parameters:
jvmName- JVM name of target server managerdirViewMBean- ObjectName of target DirView MBeanrelativeFilePath- Path of file relative to directory targeted by the DirView MBeancompress- Whether local temporary files for non-.gz remote files should be compressed- Throws:
Exception
-
searchFilesAsStreamingMapInAllServerManagers
@MBeanOperationImpact(0) Map<String,Object> searchFilesAsStreamingMapInAllServerManagers(ObjectName[] dirViewMBeans, String searchRegexp, String newEntryRegexp, boolean recursive, int maxAgeInDays, int minAgeInDays, String callerFileMatchingExpr, int maxLines, int streamThresholdCharCount) [FOR INTERNAL USE ONLY] Searches files from all specified DirViewMBeans in all server managers.See
invokeInfoOpsInAllServerManagers(javax.management.ObjectName[], java.lang.String, java.lang.Object[], java.lang.String[])for a description of the overall return result. The underlying MBean operation being invoked in this case isDirViewMBean#searchFilesAsStreamingMap(java.lang.String, java.lang.String, boolean, int, int, java.lang.String), but all streaming objects in these results are replaced by corresponding temp file paths.- Parameters:
dirViewMBeans- ObjectNames of DirViewMBeans to searchsearchRegexp- Regular expression to search withnewEntryRegexp- Regular expression which indicate the first line of an "entry"; if null or empty, the value of the Dumper MBean's DefaultNewEntryRegexp is usedrecursive- Whether to include files from sub-directoriesmaxAgeInDays- Maximum age in days (by modification date) of files to searchminAgeInDays- Minimum age in days (by modification date) of files to search; ignored when less than or equal to zerocallerFileMatchingExpr- Regular expression file names must match to be searched; ignored if empty or nullmaxLines- Maximum lines to return from any given file (not including elision line); negative values imply no limitstreamThresholdCharCount- Maximum characters of search results to return from one file without using streaming this result
Supported API: true
-