org.gytheio.content

Class AbstractComponent<W extends org.gytheio.content.ContentWorker>

java.lang.Object

org.gytheio.content.AbstractComponent<W>

Type Parameters:

W -

All Implemented Interfaces:

Component, MessageConsumer

Direct Known Subclasses:

AbstractAsyncComponent

public abstract class AbstractComponent<W extends org.gytheio.content.ContentWorker>
extends Object
implements Component

Base implementation of a component with content worker and messageProducer fields.

Author:

Ray Gauss II

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageProducer	messageProducer
protected String	name
protected W	worker

Constructor Summary

Constructors

Constructor and Description
AbstractComponent()

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
void	init()
boolean	isWorkerAvailable() Determines whether or not the worker is available.
void	onReceive(Object message) Performs any processing required upon receiving the given POJO message
protected abstract void	onReceiveImpl(Object message)
void	setMessageProducer(MessageProducer messageProducer) Sets the message producer used to send replies
void	setName(String name) Sets the component name
void	setWorker(W worker) Sets the transformer worker which does the actual work of the transformation
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gytheio.messaging.MessageConsumer

getConsumingMessageBodyClass

Field Detail

name

protected String name

worker

protected W extends org.gytheio.content.ContentWorker worker

messageProducer

protected MessageProducer messageProducer

Constructor Detail

AbstractComponent

public AbstractComponent()

Method Detail

getName

public String getName()

Description copied from interface: Component

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

Specified by:

getName in interface Component

Returns:

the component name

setName

public void setName(String name)

Sets the component name

Parameters:

name -

setWorker

public void setWorker(W worker)

Sets the transformer worker which does the actual work of the transformation

Parameters:

transformerWorker -

setMessageProducer

public void setMessageProducer(MessageProducer messageProducer)

Sets the message producer used to send replies

Parameters:

messageProducer -

init

public void init()

onReceive

public void onReceive(Object message)

Description copied from interface: MessageConsumer

Performs any processing required upon receiving the given POJO message

Specified by:

onReceive in interface MessageConsumer

onReceiveImpl

protected abstract void onReceiveImpl(Object message)

isWorkerAvailable

public boolean isWorkerAvailable()

Description copied from interface: Component

Determines whether or not the worker is available.

Specified by:

isWorkerAvailable in interface Component

Returns:

true if the worker is available

See Also:

ContentWorker#isAvailable()}

getWorkerVersionString

public String getWorkerVersionString()

Description copied from interface: Component

Gets a string returning name and version information

Specified by:

getWorkerVersionString in interface Component

Returns:

the version string

See Also:

ContentWorker#getVersionString()}

getWorkerVersionDetailsString

public String getWorkerVersionDetailsString()

Description copied from interface: Component

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

Specified by:

getWorkerVersionDetailsString in interface Component

Returns:

the version string

See Also:

ContentWorker#getVersionDetailsString()}

toString

public String toString()

Overrides:

toString in class Object