DuccAdmin (Apache UIMA DUCC: uima-ducc-common 2.0.0 API)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.uima.ducc.common.component.AbstractDuccComponent
- - org.apache.uima.ducc.common.main.DuccAdmin

All Implemented Interfaces:

Thread.UncaughtExceptionHandler, AbstractDuccComponentMBean, DuccComponent, DuccLifecycle, DuccRemoteLauncher.ProcessCompletionCallback
```
public class DuccAdmin
extends AbstractDuccComponent
implements DuccRemoteLauncher.ProcessCompletionCallback
```
This class implements support for sending Administrative commands to Ducc processes. Usage: DuccAdmin -killAll - stops all Ducc components DuccAdmin -quiesceAgents - quiesces named nodes

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DuccAdmin.DuccCommands
- Nested classes/interfaces inherited from class org.apache.uima.ducc.common.component.AbstractDuccComponent
  AbstractDuccComponent.AdminEventProcessor, AbstractDuccComponent.ErrorProcessor

Field Summary

Fields
Modifier and Type Field and Description

static String FileSeparator

Constructor Summary

Constructors
Constructor and Description

DuccAdmin(org.apache.camel.CamelContext context)

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`completed(DuccRemoteLauncher.ProcessCompletionResult result)`
`void`	`dispatch(String serializedEvent)` Sends the DuccAdminEvent (serialized as String) to the admin endpoint
`DuccLogger`	`getLogger()`
`org.apache.commons.cli.Options`	`getPosixOptions()`
`static void`	`main(String[] args)`
`void`	`parseWithPosixParser(String[] args)`
`void`	`process()` Interprets and executes Admin command
`String`	`serializeAdminEvent(DuccAdminEvent event)` Serializes DuccAdminEvent using XStream

Methods inherited from class org.apache.uima.ducc.common.component.AbstractDuccComponent
adjustTransportEndpoint, cleanup, getContext, getLogLevel, getProcessJmxUrl, handleAdminEvent, handleUncaughtException, handleUncaughtException, isStopping, loadProperties, onDuccAdminKillEvent, reloadProperties, setContext, setLogLevel, setLogLevel, start, start, startJmxAgent, stop, uncaughtException, validateAdministrator

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

- Field Detail
  - FileSeparator
```
public static final String FileSeparator
```
- Constructor Detail
  - DuccAdmin
```
public DuccAdmin(org.apache.camel.CamelContext context)
```
- Method Detail
  - getLogger
```
public DuccLogger getLogger()
```
    Specified by:
    
    getLogger in interface DuccComponent
  - dispatch
```
public void dispatch(String serializedEvent)
              throws Exception
```
    Sends the DuccAdminEvent (serialized as String) to the admin endpoint
    
    Parameters:
    serializedEvent - - serialized DuccAdminEvent
    
    Throws:
    
    Exception
  - serializeAdminEvent
```
public String serializeAdminEvent(DuccAdminEvent event)
```
    Serializes DuccAdminEvent using XStream
    
    Parameters:
    event - - instance of DuccAdminEvent
    
    Returns:
    - serialized DuccAdminEvent
  - getPosixOptions
```
public org.apache.commons.cli.Options getPosixOptions()
```
  - parseWithPosixParser
```
public void parseWithPosixParser(String[] args)
```
  - process
```
public void process()
             throws Exception
```
    Interprets and executes Admin command
    
    Throws:
    
    Exception
  - main
```
public static void main(String[] args)
```
  - completed
```
public void completed(DuccRemoteLauncher.ProcessCompletionResult result)
```
    Specified by:
    
    completed in interface DuccRemoteLauncher.ProcessCompletionCallback

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2012–2015 The Apache Software Foundation. All rights reserved.