com.j256.simplejmx.common
Class JmxOperationInfo

java.lang.Object
  extended by com.j256.simplejmx.common.JmxOperationInfo

public class JmxOperationInfo
extends Object

This identifies a method that is _not_ named "get...", "is...", or "set..." to be a JMX operation. The method can either return void or return an object. It is recommended that the method return a simple object that will be for sure in jconsole's classpath and also should not throw an unknown exception class either. This is used when you are wiring using code or Spring another object that does not use the JmxResource annotation or JmxSelfNaming.

Author:
graywatson

Nested Class Summary
static class JmxOperationInfo.OperationAction
          An enumerated version of the constants from MBeanOperationInfo.
 
Field Summary
 JmxOperationInfo.OperationAction action
           
 String description
           
 String methodName
           
 String[] parameterDescriptions
           
 String[] parameterNames
           
 
Constructor Summary
JmxOperationInfo()
           
JmxOperationInfo(String methodName, JmxOperation jmxOperation)
           
JmxOperationInfo(String methodName, String[] parameterNames, String[] parameterDescriptions, JmxOperationInfo.OperationAction action, String description)
           
 
Method Summary
 JmxOperationInfo.OperationAction getAction()
           
 String getDescription()
           
 String getMethodName()
           
 String[] getParameterDescriptions()
           
 String[] getParameterNames()
           
 void setAction(JmxOperationInfo.OperationAction action)
          Not required.
 void setDescription(String description)
          Not required.
 void setMethodName(String methodName)
          Required.
 void setParameterDescriptions(String[] parameterDescriptions)
          Not required.
 void setParameterNames(String[] parameterNames)
          Not required.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

methodName

public String methodName

parameterNames

public String[] parameterNames

parameterDescriptions

public String[] parameterDescriptions

action

public JmxOperationInfo.OperationAction action

description

public String description
Constructor Detail

JmxOperationInfo

public JmxOperationInfo()

JmxOperationInfo

public JmxOperationInfo(String methodName,
                        String[] parameterNames,
                        String[] parameterDescriptions,
                        JmxOperationInfo.OperationAction action,
                        String description)

JmxOperationInfo

public JmxOperationInfo(String methodName,
                        JmxOperation jmxOperation)
Method Detail

getMethodName

public String getMethodName()

setMethodName

public void setMethodName(String methodName)
Required.


getParameterNames

public String[] getParameterNames()

setParameterNames

public void setParameterNames(String[] parameterNames)
Not required. Default is none.


getParameterDescriptions

public String[] getParameterDescriptions()

setParameterDescriptions

public void setParameterDescriptions(String[] parameterDescriptions)
Not required. Default is none.


getAction

public JmxOperationInfo.OperationAction getAction()

setAction

public void setAction(JmxOperationInfo.OperationAction action)
Not required. Default is UNKNOWN.


getDescription

public String getDescription()

setDescription

public void setDescription(String description)
Not required. Default is "Information about class".



This content is licensed by Gray Watson under the Creative Commons Attribution-Share Alike 3.0 License.