Because JMX is stateless communication, all operations have at least two parameters: user and password.
List of operations is the following:
parameters
Table 13.1. Parameters of getServerJobs
| parameter name | mandatory | type | description |
|---|---|---|---|
| user | yes | String | |
| password | yes | String |
returns
IDs of running jobs(graphs). IDs may be used as parameters of another operations.
Since: 1.2.1
Executes specified graph. Only user, which has permission to execute the graph may call operation executeGraph(). Otherwise CloverSecurityException is thrown.
parameters
Table 13.2. Parameters of executeGraph
| parameter name | mandatory | type | description |
|---|---|---|---|
| user | yes | String | |
| password | yes | String | |
| sandbox | yes | String | Text ID of sandbox which contains graph to execute. |
| graphId | yes | String | Text ID of graph. It is path to graph file relative to sandbox root. Only forward slashes may be used. |
returns
Result runID of execution or throws an exception.
Kill running graph. Only user, which has permission to execute the graph may call operation killGraph() to kill it. Otherwise CloverSecurityException is thrown.
parameters
Table 13.3. Parameters of killGraph
| parameter name | mandatory | type | description |
|---|---|---|---|
| user | yes | String | |
| password | yes | String | |
| runID | yes | long | Run ID, which may be obtained i.e. by getRunningJobs() operation. |
returns
Result status of killed graph. If it is successfully killed, status should be ABORTED.
Since: 1.2.1
Returns current status of specified execution.
parameters
Table 13.4. Parameters of graphStatus
| parameter name | mandatory | type | description |
|---|---|---|---|
| user | yes | String | |
| password | yes | String | |
| runID | yes | long | Run ID, which is returned by executeGraph method or which may be obtained i.e. by getRunningJobs() operation. |
returns
Result status of specified graph execution. Possible values are: FINISHED_OK | RUNNING | N_A | ERROR | ABORTED | READY
Suspends server. Suspended server means that no graph may be executed. All attempts to execute graph will fail. See resumeServer operation. Only administrator can call this operation. Otherwise CloverSecurityException is thrown.
parameters
Table 13.5. Parameters of suspendServer
| parameter name | mandatory | type | description |
|---|---|---|---|
| user | yes | String | |
| password | yes | String | |
| atOnce | yes | boolean | If this param is set to true, running graphs from suspended server are aborted. Otherwise it can run until it is finished in common way. |
returns
void
Resumes suspended server. Only administrator can call this operation. Otherwise CloverSecurityException is thrown. See suspendServer() operation.
parameters
Table 13.6. Parameters of resumeServer
| parameter name | mandatory | type | description |
|---|---|---|---|
| user | yes | String | |
| password | yes | String |
returns
void
Suspends specified sandbox. Suspended sandbox means that no graph from sandbox may be executed. All attempts to execute graph will fail. See resumeServerSandbox operation. Only administrator can call this operation. Otherwise CloverSecurityException is thrown.
parameters
Table 13.7. Parameters of suspendServerSandbox
| parameter name | mandatory | type | description |
|---|---|---|---|
| user | yes | String | |
| password | yes | String | |
| sandbox | yes | String | Text ID of sandbox to suspend |
| atOnce | yes | boolean | If this param is set to true, running graphs from suspended sandbox are aborted. Otherwise it can run until it is finished in common way. |
returns
void
Resumes suspended sandbox. Only administrator can call this operation. Otherwise CloverSecurityException is thrown. See suspendServerSandbox() operation.
parameters
Table 13.8. Parameters of resumeServerSandbox
| parameter name | mandatory | type | description |
|---|---|---|---|
| user | yes | String | |
| password | yes | String | |
| sandbox | yes | String | Text ID of sandbox to suspend |
returns
void
Returns MBean name of running graph. It may be used for direct monitoring of the transformation. However in cluster environment, MBean is accessible only on the node, which runs graph.
parameters
Table 13.9. Parameters of getGraphExecutionMBeanName
| parameter name | mandatory | type | description |
|---|---|---|---|
| user | yes | String | |
| password | yes | String | |
| runID | yes | long | Run ID, which may be obtained i.e. by getRunningJobs() operation. |
returns
MBean name