# supervisor4j

**Repository Path**: mbigger/supervisor4j

## Basic Information

- **Project Name**: supervisor4j
- **Description**: A Java Client for Supervisord's XML RPC API base on Apache XML-RPC.
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-11
- **Last Updated**: 2022-06-08

## Categories & Tags

**Categories**: rpc

**Tags**: None

## README

# supervisor4j

#### Description
A Java Client for Supervisor's XML RPC API base on Apache XML-RPC.

http://www.supervisord.org/api.html

### Usage
Create an instance of `Supervisor`, then call the method.
```
Supervisor supervisor = Supervisor.configXmlRpcClient();
```

You can config the url and auth befor `configXmlRpcClient`.
```
Supervisor supervisor = Supervisor
                .url("http://127.0.0.1:10109/RPC2")
                .auth("Supervisor", "Supervisor518")
                .configXmlRpcClient();
```

You can use the method `execute` to call the interface extended by yourself

### Method List
<table>
	<tr>
	    <th>group</th>
        <th>method</th>
	    <th>implement</th>
	    <th>test</th>  
	</tr>
	<tr>
	    <td rowspan="9">Status and Control</td>
	    <td>getAPIVersion</td>
	    <td>√</td>
        <td></td>
	</tr>
	<tr>
	    <td>getSupervisorVersion</td>
	    <td>√</td>
        <td></td>
	</tr>
	<tr>
	    <td>getIdentification</td>
	    <td>√</td>
        <td></td>
	</tr>
	<tr>
	   <td>getState</td>
	   <td>√</td>
       <td></td>
	</tr>
	<tr><td>getPID</td>
	    <td>√</td>
        <td></td>
	</tr>
	<tr>
	    <td>readLogt</td>
	    <td>√</td>
        <td></td>
	</tr>
	<tr>
	    <td>clearLog</td>
	    <td>√</td>
        <td></td>
	</tr>
	<tr>
	    <td>shutdown</td>
	    <td>√</td>
        <td></td>
	</tr>
	<tr>
	    <td>restar</td>
	    <td>√</td>
        <td></td>
	</tr>
	<tr>
	    <td rowspan="16">Process Control</td>
	    <td>getProcessInfo</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>getAllProcessInfo</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>startProcess</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>startAllProcesses</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>startProcessGroup</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>stopProcess</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>stopProcessGroup</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>stopAllProcesses</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>signalProcess</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>signalProcessGroup</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>signalAllProcesses</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>sendProcessStdin</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>sendRemoteCommEvent</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>reloadConfig</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>addProcessGroup</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>removeProcessGroup</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td rowspan="6">Process Logging</td>
	    <td>readProcessStdoutLog</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>readProcessStderrLog</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>tailProcessStdoutLog</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>tailProcessStderrLog</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>clearProcessLogs</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>clearAllProcessLogs</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td rowspan="4">System Methods</td>
	    <td>listMethods</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>methodHelp</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>methodSignature</td>
	    <td>√</td>
        <td></td>
	</tr>
    <tr>
	    <td>multicall</td>
	    <td>√</td>
        <td></td>
	</tr>
</table>