DuccService (Apache UIMA DUCC: uima-ducc-common 2.2.1 API)

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

All Implemented Interfaces:

Thread.UncaughtExceptionHandler, AbstractDuccComponentMBean, DuccComponent, DuccLifecycle
```
public class DuccService
extends AbstractDuccComponent
```
Main program to launch Ducc Component process. Launch configuration is provided in properties file via -Dducc.deploy.configuration=. Entries in this file are used to enrich System properties. Any value in the properties file can be overriden with a -D= where matches a key in properties file. To launch multiple Ducc components in the same jvm, list them in ducc.deploy.components property. For example, ducc.deploy.components=jm,rm The above will launch Job Manager and Resource Manager in the same jvm.

Nested Class Summary
- 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 DUCC_DEPLOY_COMPONENTS

static String DUCC_PROPERTY_FILE

Fields
Modifier and Type	Field and Description
`static String`	`DUCC_DEPLOY_COMPONENTS`
`static String`	`DUCC_PROPERTY_FILE`

Constructor Summary

Constructors
Constructor and Description

DuccService()

Constructors
Constructor and Description
`DuccService()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`boot(String[] args)` Initializes Ducc component(s) based on provided configuration.
`AbstractDuccComponent`	`getComponentByInstanceType(Class<?> instanceType)` This method is only called when launching a JP.
`AbstractDuccComponent`	`getComponentInstance(String componentKey)`
`static DuccLogger`	`getDuccLogger()`
`static DuccLogger`	`getDuccLogger(Class claz)`
`static DuccLogger`	`getDuccLogger(String claz)`
`IJobProcessor`	`getJobProcessorComponent()` This method returns an instance of IJobProcessor which would only exist in a JP and UIMA-based AP.
`DuccLogger`	`getLogger()`
`String`	`getLogLevel(String clz)`
`static void`	`main(String[] args)`
`void`	`registerInvestmentInstance(Object instance)`
`void`	`registerInvestmentResetCallback(Object o, Method m)`
`static void`	`setDuccLogger(DuccLogger l)`
`void`	`setLogLevel(String clz, String level)`
`void`	`setProcessor(Object ipc, String[] args)` This method is only called when launching a JP.
`void`	`start()` This method is only called when launching a JP.
`void`	`stop()`

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, start, start, startJmxAgent, uncaughtException, validateAdministrator

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

Field Detail
- DUCC_PROPERTY_FILE
```
public static final String DUCC_PROPERTY_FILE
```
  See Also:
  Constant Field Values
- DUCC_DEPLOY_COMPONENTS
```
public static final String DUCC_DEPLOY_COMPONENTS
```
  See Also:
  Constant Field Values

Constructor Detail
- DuccService
```
public DuccService()
```

Method Detail

getDuccLogger

public static DuccLogger getDuccLogger()

getDuccLogger

public static DuccLogger getDuccLogger(String claz)

getDuccLogger

public static DuccLogger getDuccLogger(Class claz)

setDuccLogger

public static void setDuccLogger(DuccLogger l)

getLogger
```
public DuccLogger getLogger()
```

boot
```
public void boot(String[] args)
          throws Exception
```
Initializes Ducc component(s) based on provided configuration.

Throws:

Exception

getComponentInstance

public AbstractDuccComponent getComponentInstance(String componentKey)

getJobProcessorComponent
```
public IJobProcessor getJobProcessorComponent()
```
This method returns an instance of IJobProcessor which would only exist in a JP and UIMA-based AP.

Returns:
- IJobProcessor instance

getComponentByInstanceType
```
public AbstractDuccComponent getComponentByInstanceType(Class<?> instanceType)
```
This method is only called when launching a JP.

Parameters:
instanceType -

Returns:

setProcessor
```
public void setProcessor(Object ipc,
                String[] args)
                  throws Exception
```
This method is only called when launching a JP.

Parameters:
ipc - - instance of IProcessContainer
args - - program args

Throws:

Exception

start
```
public void start()
           throws Exception
```
This method is only called when launching a JP. It starts the JP including initialization and starts all worker threads.

Throws:

Exception

stop
```
public void stop()
          throws Exception
```
Specified by:

stop in interface DuccLifecycle

Overrides:

stop in class AbstractDuccComponent

Throws:

Exception

main

public static void main(String[] args)

setLogLevel
```
public void setLogLevel(String clz,
               String level)
```
Specified by:

setLogLevel in interface AbstractDuccComponentMBean

Overrides:

setLogLevel in class AbstractDuccComponent

getLogLevel

public String getLogLevel(String clz)

registerInvestmentInstance

public void registerInvestmentInstance(Object instance)

registerInvestmentResetCallback

public void registerInvestmentResetCallback(Object o,
                                   Method m)
                                     throws Exception

Throws:: Exception

Class DuccService

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.uima.ducc.common.component.AbstractDuccComponent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.uima.ducc.common.component.AbstractDuccComponent

Methods inherited from class java.lang.Object

Field Detail

DUCC_PROPERTY_FILE

DUCC_DEPLOY_COMPONENTS

Constructor Detail

DuccService

Method Detail

getDuccLogger

getDuccLogger

getDuccLogger

setDuccLogger

getLogger

boot

getComponentInstance

getJobProcessorComponent

getComponentByInstanceType

setProcessor

start

stop

main

setLogLevel

getLogLevel

registerInvestmentInstance

registerInvestmentResetCallback