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

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

All Implemented Interfaces:

Thread.UncaughtExceptionHandler, AbstractDuccComponentMBean, DuccComponent, DuccLifecycle

Direct Known Subclasses:

DuccAdmin, DuccRmAdmin, DuccService
```
public abstract class AbstractDuccComponent
extends Object
implements DuccComponent, Thread.UncaughtExceptionHandler, AbstractDuccComponentMBean
```
Abstract class which every Ducc component should extend from. Provides support for loading property files and resolving any placeholders in property values. Creates a special purpose Camel router to receive system wide DuccAdminEvent messages.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class AbstractDuccComponent.AdminEventProcessor

class AbstractDuccComponent.ErrorProcessor

Nested Classes
Modifier and Type	Class and Description
`class`	`AbstractDuccComponent.AdminEventProcessor`
`class`	`AbstractDuccComponent.ErrorProcessor`

Constructor Summary

Constructors
Constructor and Description
`AbstractDuccComponent(String componentName)`
`AbstractDuccComponent(String componentName, org.apache.camel.CamelContext context)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`adjustTransportEndpoint(String endpointValue, String endpointType)`
`void`	`cleanup(Throwable e)`
`org.apache.camel.CamelContext`	`getContext()`
`String`	`getLogLevel()`
`protected String`	`getProcessJmxUrl()`
`void`	`handleAdminEvent(DuccAdminEvent event)` Components interested in receiving DuccAdminEvents should override this method
`void`	`handleUncaughtException(Error e)`
`void`	`handleUncaughtException(Exception e)`
`boolean`	`isStopping()`
`void`	`loadProperties(String componentProperties)` Loads named property file
`void`	`onDuccAdminKillEvent(DuccAdminEvent event)` Called when DuccAdminEvent is received on the Ducc Admin Channel
`void`	`reloadProperties(String componentProperties)`
`void`	`setContext(org.apache.camel.CamelContext context)`
`void`	`setLogLevel(String level)`
`void`	`setLogLevel(String clz, String level)`
`void`	`start(DuccService service)`
`void`	`start(DuccService service, String[] args)`
`String`	`startJmxAgent()` Start RMI registry so the JMX clients can connect to the JVM via JMX.
`void`	`stop()`
`void`	`uncaughtException(Thread t, Throwable e)`
`boolean`	`validateAdministrator(DuccAdminEvent event)` Is the event apparently issue by a DUCC registered admin or not?

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

Methods inherited from interface org.apache.uima.ducc.common.component.DuccComponent
getLogger

Constructor Detail

AbstractDuccComponent

public AbstractDuccComponent(String componentName)

AbstractDuccComponent

public AbstractDuccComponent(String componentName,
                     org.apache.camel.CamelContext context)

Method Detail

loadProperties
```
public void loadProperties(String componentProperties)
                    throws Exception
```
Loads named property file

Parameters:
componentProperties - - property file to read

Throws:

Exception

reloadProperties

public void reloadProperties(String componentProperties)
                      throws Exception

Throws:: Exception

adjustTransportEndpoint

public String adjustTransportEndpoint(String endpointValue,
                             String endpointType)
                               throws Exception

Throws:: Exception

setContext

public void setContext(org.apache.camel.CamelContext context)

Specified by:: setContext in interface DuccComponent

getContext
```
public org.apache.camel.CamelContext getContext()
```
Specified by:

getContext in interface DuccComponent

validateAdministrator
```
public boolean validateAdministrator(DuccAdminEvent event)
```
Is the event apparently issue by a DUCC registered admin or not?

onDuccAdminKillEvent
```
public void onDuccAdminKillEvent(DuccAdminEvent event)
                          throws Exception
```
Called when DuccAdminEvent is received on the Ducc Admin Channel

Parameters:
event - - admin event

Throws:

Exception

start

public void start(DuccService service)
           throws Exception

Specified by:: start in interface DuccLifecycle
Throws:: Exception

start

public void start(DuccService service,
         String[] args)
           throws Exception

Throws:: Exception

getProcessJmxUrl
```
protected String getProcessJmxUrl()
```

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

stop in interface DuccLifecycle

Throws:

Exception

handleUncaughtException
```
public void handleUncaughtException(Exception e)
```
Specified by:

handleUncaughtException in interface DuccComponent

handleUncaughtException

public void handleUncaughtException(Error e)

startJmxAgent
```
public String startJmxAgent()
                     throws Exception
```
Start RMI registry so the JMX clients can connect to the JVM via JMX.

Returns:
JMX connect URL

Throws:

Exception

cleanup
```
public void cleanup(Throwable e)
```
Specified by:

cleanup in interface DuccComponent

uncaughtException

public void uncaughtException(Thread t,
                     Throwable e)

Specified by:: uncaughtException in interface Thread.UncaughtExceptionHandler

handleAdminEvent
```
public void handleAdminEvent(DuccAdminEvent event)
                      throws Exception
```
Components interested in receiving DuccAdminEvents should override this method

Specified by:

handleAdminEvent in interface DuccLifecycle

Throws:

Exception

setLogLevel

public void setLogLevel(String clz,
               String level)

Specified by:: setLogLevel in interface AbstractDuccComponentMBean

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

setLogLevel in interface AbstractDuccComponentMBean

getLogLevel
```
public String getLogLevel()
```

isStopping
```
public boolean isStopping()
```

Class AbstractDuccComponent

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.uima.ducc.common.component.DuccComponent

Constructor Detail

AbstractDuccComponent

AbstractDuccComponent

Method Detail

loadProperties

reloadProperties

adjustTransportEndpoint

setContext

getContext

validateAdministrator

onDuccAdminKillEvent

start

start

getProcessJmxUrl

stop

handleUncaughtException

handleUncaughtException

startJmxAgent

cleanup

uncaughtException

handleAdminEvent

setLogLevel

setLogLevel

getLogLevel

isStopping