org.gytheio.content

Interface Component

All Superinterfaces:

MessageConsumer

All Known Implementing Classes:

AbstractAsyncComponent, AbstractComponent

public interface Component
extends MessageConsumer

Defines a component which is a consumer of request for content action messages, delegates that work to a worker, and sends a reply with the results.

Author:

Ray Gauss II

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Gets the name of the component, useful for health checks.
String	getWorkerVersionDetailsString() Gets a string returning detailed version information such as JVM or command line application's version output
String	getWorkerVersionString() Gets a string returning name and version information
boolean	isWorkerAvailable() Determines whether or not the worker is available.

Methods inherited from interface org.gytheio.messaging.MessageConsumer

getConsumingMessageBodyClass, onReceive

Method Detail

getName

String getName()

Gets the name of the component, useful for health checks.

Returns:

the component name

isWorkerAvailable

boolean isWorkerAvailable()

Determines whether or not the worker is available.

Returns:

true if the worker is available

See Also:

ContentWorker#isAvailable()}

getWorkerVersionString

String getWorkerVersionString()

Gets a string returning name and version information

Returns:

the version string

See Also:

ContentWorker#getVersionString()}

getWorkerVersionDetailsString

String getWorkerVersionDetailsString()

Gets a string returning detailed version information such as JVM or command line application's version output

Returns:

the version string

See Also:

ContentWorker#getVersionDetailsString()}