JmxChannel (Apache Tomcat 10.1.48 API Documentation)
Description: declaration: package: org.apache.catalina.tribes, interface: JmxChannel

# Interface JmxChannel

All Superinterfaces:
  `MBeanRegistration`

All Known Implementing Classes:
  `GroupChannel`

public interface JmxChannel extends MBeanRegistration

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getJmxDomain()`
  Return the jmx domain which this channel is registered.
  `String`
  `getJmxPrefix()`
  Return the jmx prefix which will be used with channel ObjectName.
  `boolean`
  `isJmxEnabled()`
  If set to true, this channel is registered with jmx.
  `void`
  `setJmxDomain(String jmxDomain)`
  Set the jmx domain which this channel should be registered.
  `void`
  `setJmxEnabled(boolean jmxEnabled)`
  If set to true, this channel is registered with jmx.
  `void`
  `setJmxPrefix(String jmxPrefix)`
  Set the jmx prefix which will be used with channel ObjectName.

  ### Methods inherited from interface MBeanRegistration

  `postDeregister, postRegister, preDeregister, preRegister`

- ## Method Details

  - ### isJmxEnabled

    boolean isJmxEnabled()
    If set to true, this channel is registered with jmx.
    Returns:
      true if this channel will be registered with jmx.

  - ### setJmxEnabled

    void setJmxEnabled(boolean jmxEnabled)
    If set to true, this channel is registered with jmx.
    Parameters:
      `jmxEnabled` - set to true if this channel should be registered with jmx.

  - ### getJmxDomain

    String getJmxDomain()
    Return the jmx domain which this channel is registered.
    Returns:
      jmxDomain

  - ### setJmxDomain

    void setJmxDomain(String jmxDomain)
    Set the jmx domain which this channel should be registered.
    Parameters:
      `jmxDomain` - The jmx domain which this channel should be registered.

  - ### getJmxPrefix

    String getJmxPrefix()
    Return the jmx prefix which will be used with channel ObjectName.
    Returns:
      jmxPrefix

  - ### setJmxPrefix

    void setJmxPrefix(String jmxPrefix)
    Set the jmx prefix which will be used with channel ObjectName.
    Parameters:
      `jmxPrefix` - The jmx prefix which will be used with channel ObjectName.