JmxRemoteLifecycleListener (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- org.apache.catalina.mbeans.JmxRemoteLifecycleListener

All Implemented Interfaces:

LifecycleListener
```
public class JmxRemoteLifecycleListener
extends java.lang.Object
implements LifecycleListener
```
This listener fixes the port used by JMX/RMI Server making things much simpler if you need to connect jconsole or similar to a remote Tomcat instance that is running behind a firewall. Only the ports are configured via the listener. The remainder of the configuration is via the standard system properties for configuring JMX.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JmxRemoteLifecycleListener.RmiClientLocalhostSocketFactory`
`static class`	`JmxRemoteLifecycleListener.RmiServerBindSocketFactory`
`static class`	`JmxRemoteLifecycleListener.SslRmiServerBindSocketFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`accessFile`
`protected boolean`	`authenticate`
`protected java.lang.String[]`	`ciphers`
`protected boolean`	`clientAuth`
`protected javax.management.remote.JMXConnectorServer`	`csPlatform`
`protected java.lang.String`	`loginModuleName`
`protected java.lang.String`	`passwordFile`
`protected java.lang.String[]`	`protocols`
`protected java.lang.String`	`rmiBindAddress`
`protected int`	`rmiRegistryPortPlatform`
`protected boolean`	`rmiRegistrySSL`
`protected int`	`rmiServerPortPlatform`
`protected boolean`	`rmiServerSSL`
`protected static StringManager`	`sm`
`protected boolean`	`useLocalPorts`

Constructor Summary

Constructors
Constructor and Description

JmxRemoteLifecycleListener()

Constructors
Constructor and Description
`JmxRemoteLifecycleListener()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getRmiBindAddress()` Get the inet address on which the Platform RMI server is exported.
`int`	`getRmiRegistryPortPlatform()` Get the port on which the Platform RMI registry is exported.
`int`	`getRmiServerPortPlatform()` Get the port on which the Platform RMI server is exported.
`boolean`	`getUseLocalPorts()` Get the flag that indicates that local ports should be used for all connections.
`void`	`lifecycleEvent(LifecycleEvent event)` Acknowledge the occurrence of the specified event.
`void`	`setRmiBindAddress(java.lang.String theRmiBindAddress)` Set the inet address on which the Platform RMI server is exported.
`void`	`setRmiRegistryPortPlatform(int theRmiRegistryPortPlatform)` Set the port on which the Platform RMI registry is exported.
`void`	`setRmiServerPortPlatform(int theRmiServerPortPlatform)` Set the port on which the Platform RMI server is exported.
`void`	`setUseLocalPorts(boolean useLocalPorts)` Set the flag that indicates that local ports should be used for all connections.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sm
```
protected static final StringManager sm
```
  - rmiBindAddress
```
protected java.lang.String rmiBindAddress
```
  - rmiRegistryPortPlatform
```
protected int rmiRegistryPortPlatform
```
  - rmiServerPortPlatform
```
protected int rmiServerPortPlatform
```
  - rmiRegistrySSL
```
protected boolean rmiRegistrySSL
```
  - rmiServerSSL
```
protected boolean rmiServerSSL
```
  - ciphers
```
protected java.lang.String[] ciphers
```
  - protocols
```
protected java.lang.String[] protocols
```
  - clientAuth
```
protected boolean clientAuth
```
  - authenticate
```
protected boolean authenticate
```
  - passwordFile
```
protected java.lang.String passwordFile
```
  - loginModuleName
```
protected java.lang.String loginModuleName
```
  - accessFile
```
protected java.lang.String accessFile
```
  - useLocalPorts
```
protected boolean useLocalPorts
```
  - csPlatform
```
protected javax.management.remote.JMXConnectorServer csPlatform
```
- Constructor Detail
  - JmxRemoteLifecycleListener
```
public JmxRemoteLifecycleListener()
```
- Method Detail
  - getRmiBindAddress
```
public java.lang.String getRmiBindAddress()
```
    Get the inet address on which the Platform RMI server is exported.
    
    Returns:
    The textual representation of inet address
  - setRmiBindAddress
```
public void setRmiBindAddress(java.lang.String theRmiBindAddress)
```
    Set the inet address on which the Platform RMI server is exported.
    
    Parameters:
    theRmiBindAddress - The textual representation of inet address
  - getRmiServerPortPlatform
```
public int getRmiServerPortPlatform()
```
    Get the port on which the Platform RMI server is exported. This is the port that is normally chosen by the RMI stack.
    
    Returns:
    The port number
  - setRmiServerPortPlatform
```
public void setRmiServerPortPlatform(int theRmiServerPortPlatform)
```
    Set the port on which the Platform RMI server is exported. This is the port that is normally chosen by the RMI stack.
    
    Parameters:
    theRmiServerPortPlatform - The port number
  - getRmiRegistryPortPlatform
```
public int getRmiRegistryPortPlatform()
```
    Get the port on which the Platform RMI registry is exported.
    
    Returns:
    The port number
  - setRmiRegistryPortPlatform
```
public void setRmiRegistryPortPlatform(int theRmiRegistryPortPlatform)
```
    Set the port on which the Platform RMI registry is exported.
    
    Parameters:
    theRmiRegistryPortPlatform - The port number
  - getUseLocalPorts
```
public boolean getUseLocalPorts()
```
    Get the flag that indicates that local ports should be used for all connections. If using SSH tunnels, or similar, this should be set to true to ensure the RMI client uses the tunnel.
    
    Returns:
    true if local ports should be used
  - setUseLocalPorts
```
public void setUseLocalPorts(boolean useLocalPorts)
```
    Set the flag that indicates that local ports should be used for all connections. If using SSH tunnels, or similar, this should be set to true to ensure the RMI client uses the tunnel.
    
    Parameters:
    useLocalPorts - Set to true if local ports should be used
  - lifecycleEvent
```
public void lifecycleEvent(LifecycleEvent event)
```
    Description copied from interface: LifecycleListener
    
    Acknowledge the occurrence of the specified event.
    
    Specified by:
    
    lifecycleEvent in interface LifecycleListener
    
    Parameters:
    event - LifecycleEvent that has occurred

Class JmxRemoteLifecycleListener

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sm

rmiBindAddress

rmiRegistryPortPlatform

rmiServerPortPlatform

rmiRegistrySSL

rmiServerSSL

ciphers

protocols

clientAuth

authenticate

passwordFile

loginModuleName

accessFile

useLocalPorts

csPlatform

Constructor Detail

JmxRemoteLifecycleListener

Method Detail

getRmiBindAddress

setRmiBindAddress

getRmiServerPortPlatform

setRmiServerPortPlatform

getRmiRegistryPortPlatform

setRmiRegistryPortPlatform

getUseLocalPorts

setUseLocalPorts

lifecycleEvent