Controller (OpenNMS 2021.1.1 API)

java.lang.Object
- org.opennms.netmgt.vmmgr.Controller

```
public class Controller
extends Object
```
This Controller class is used to interact with a Manager MBean running inside an OpenNMS JMX service. This class can invoke operations on that MBean and request status information from it. It is used to execute shell operations to control the lifecycle of the OpenNMS process from init.d or systemd scripts.

Author:

Seth, Brian Weaver, Sowmya Nataraj

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONNECTOR_ADDRESS` The system property used to determine the JMX management agent URI for the JVM that we are attaching to.
`static String`	`DEFAULT_JMX_RMI_URL`

Constructor Summary

Constructors
Constructor and Description

Controller()

Constructors
Constructor and Description
`Controller()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`check()` check
`Object`	`doInvokeOperation(String operation)`
`int`	`dumpThreads()` dumpThreads
`int`	`exit()` exit
`String`	`getJmxUrl()` This method uses the Java Attach API to connect to a running OpenNMS JVM and fetch the dynamically assigned local JMX agent URL.
`String`	`getPid()`
`int`	`getRmiHandshakeTimeout()`
`int`	`invokeOperation(String operation)`
`boolean`	`isVerbose()` isVerbose
`static void`	`main(String[] argv)` main
`void`	`setJmxRmiUrl(String jmxUrl)` setJmxRmiUrl
`void`	`setPid(String pid)`
`void`	`setRmiHandshakeTimeout(int httpRequestReadTimeout)`
`void`	`setVerbose(boolean verbose)` setVerbose
`void`	`start()` Start the OpenNMS daemon.
`int`	`status()` status
`int`	`stop()` stop

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

- Field Detail
  - CONNECTOR_ADDRESS
```
public static final String CONNECTOR_ADDRESS
```
    The system property used to determine the JMX management agent URI for the JVM that we are attaching to. This is used for getting status information from a running OpenNMS instance.
    
    See Also:
    
    https://docs.oracle.com/javase/8/docs/technotes/guides/management/agent.html, Constant Field Values
  - DEFAULT_JMX_RMI_URL
```
public static final String DEFAULT_JMX_RMI_URL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Controller
```
public Controller()
```
- Method Detail
  - main
```
public static void main(String[] argv)
```
    main
    
    Parameters:
    
    argv - an array of String objects.
  - start
```
public void start()
```
    Start the OpenNMS daemon. Never returns.
  - stop
```
public int stop()
```
    stop
    
    Returns:
    
    a int.
  - status
```
public int status()
```
    status
    
    Returns:
    
    a int.
  - check
```
public int check()
```
    check
    
    Returns:
    
    a int.
  - dumpThreads
```
public int dumpThreads()
```
    dumpThreads
    
    Returns:
    
    a int.
  - exit
```
public int exit()
```
    exit
    
    Returns:
    
    a int.
  - invokeOperation
```
public int invokeOperation(String operation)
```
  - doInvokeOperation
```
public Object doInvokeOperation(String operation)
                         throws MalformedURLException,
                                IOException,
                                InstanceNotFoundException,
                                MalformedObjectNameException,
                                MBeanException,
                                ReflectionException,
                                NullPointerException
```
    Throws:
    
    MalformedURLException
    
    IOException
    
    InstanceNotFoundException
    
    MalformedObjectNameException
    
    MBeanException
    
    ReflectionException
    
    NullPointerException
  - isVerbose
```
public boolean isVerbose()
```
    isVerbose
    
    Returns:
    
    a boolean.
  - setVerbose
```
public void setVerbose(boolean verbose)
```
    setVerbose
    
    Parameters:
    
    verbose - a boolean.
  - getJmxUrl
```
public String getJmxUrl()
```
    This method uses the Java Attach API to connect to a running OpenNMS JVM and fetch the dynamically assigned local JMX agent URL.
    
    Returns:
    
    a String object.
    
    See Also:
    
    https://docs.oracle.com/javase/8/docs/jdk/api/attach/spec/index.html, https://docs.oracle.com/javase/8/docs/technotes/guides/management/agent.html
  - setJmxRmiUrl
```
public void setJmxRmiUrl(String jmxUrl)
```
    setJmxRmiUrl
    
    Parameters:
    
    jmxUrl - a String object.
  - getPid
```
public String getPid()
```
  - setPid
```
public void setPid(String pid)
```
  - getRmiHandshakeTimeout
```
public int getRmiHandshakeTimeout()
```
  - setRmiHandshakeTimeout
```
public void setRmiHandshakeTimeout(int httpRequestReadTimeout)
```

Class Controller

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONNECTOR_ADDRESS

DEFAULT_JMX_RMI_URL

Constructor Detail

Controller

Method Detail

main

start

stop

status

check

dumpThreads

exit

invokeOperation

doInvokeOperation

isVerbose

setVerbose

getJmxUrl

setJmxRmiUrl

getPid

setPid

getRmiHandshakeTimeout

setRmiHandshakeTimeout