Interface MethodServerDataMBean

All Superinterfaces:
SelfEmailingMBean

public interface MethodServerDataMBean extends SelfEmailingMBean
Provide basic top-level data on a single method server and proxying thereof

Supported API: true

Extendable: true
  • Method Details

    • getName

      String getName()
      Name of method server service

      Supported API: true
    • getStartDate

      Date getStartDate()
      Time method server started

      Supported API: true
    • getJvmId

      int getJvmId()
      JVM id of method server

      Supported API: true
    • getRemoteJmxUrl

      String getRemoteJmxUrl()
      URL of method server's JMX server

      Supported API: true
    • getDisplayName

      String getDisplayName()
      Display name of method server

      Supported API: true
    • isJmxConnectionFailed

      boolean isJmxConnectionFailed()
      Whether a JMX connection was established from the server manager to method server and this connection subsequently failed

      Supported API: true
    • isMBeansProxied

      boolean isMBeansProxied()
      Whether method server's MBeans are proxied into server manager MBeanServer

      Supported API: true
    • proxyMBeans

      @MBeanOperationImpact(0) void proxyMBeans() throws IOException
      Proxy method server's MBeans into server manager MBeanServer

      Supported API: true
      Throws:
      IOException
    • disconnectProxy

      @MBeanOperationImpact(1) void disconnectProxy()
      Stop proxying method server's MBeans into server manager MBeanServer

      Supported API: true
    • stopMethodServer

      @MBeanOperationImpact(1) void stopMethodServer() throws RemoteException
      Stop the method server

      Supported API: true
      Throws:
      RemoteException
    • restartMethodServer

      @MBeanOperationImpact(1) void restartMethodServer() throws Exception
      Stop the method server and immediately start a new one

      Supported API: true
      Throws:
      Exception
    • setLevel

      @MBeanOperationImpact(1) void setLevel(String loggerName, String level) throws Exception
      Set log level for a given logger.

      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
    • setProperty

      @MBeanOperationImpact(1) void setProperty(String propertyName, String newValue) throws Exception
      Sets the value of a specified property.

      Supported API: true
      Parameters:
      propertyName - name of property to retrieve
      newValue - new value to assign to property
      Throws:
      Exception
    • emailMethodServerMBeans

      @MBeanOperationImpact(0) void emailMethodServerMBeans(String addressesOrEmailList, String subject, boolean compress) throws Exception
      E-mail styled data for all method server 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
      compress - Whether e-mail contents should be compressed
      Throws:
      Exception
    • emailActiveMethodContexts

      @MBeanOperationImpact(0) void emailActiveMethodContexts(String addressesOrEmailList, String subject, boolean compress) 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 to
      subject - Subject to give e-mail
      compress - Whether e-mail contents should be compressed
      Throws:
      Exception
    • getAttributesFromMethodServer

      @MBeanOperationImpact(0) AttributeList getAttributesFromMethodServer(ObjectName mbean, String[] attributeNames) throws Exception
      Get attribute values from an MBean in the method server.

      Supported API: true
      Parameters:
      mbean - ObjectName of target MBean
      attributeNames - Names of attributes to fetch values for
      Throws:
      Exception
    • setAttributesInMethodServer

      @MBeanOperationImpact(1) AttributeList setAttributesInMethodServer(ObjectName mbean, AttributeList attributes) throws Exception
      Set attributes on an MBean in the method server.

      Supported API: true
      Parameters:
      mbean - ObjectName of target MBean
      attributes - Attribute settings to apply
      Throws:
      Exception
    • invokeOperationInMethodServer

      @MBeanOperationImpact(1) Object invokeOperationInMethodServer(ObjectName mbean, String operation, Object[] params, String[] signature) throws Exception
      Invoke an operation on an MBean in the method server.

      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:
      Exception
    • invokeInfoOperationInMethodServer

      @MBeanOperationImpact(0) Object invokeInfoOperationInMethodServer(ObjectName mbean, String operation, Object[] params, String[] signature) throws Exception
      Invoke an operation with an INFO (read-only) impact on an MBean in the method server. This operation will raise an exception if the target operation has a non-INFO impact.

      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:
      Exception