com.neeve.service

Class AbstractClient

java.lang.Object

com.neeve.service.AbstractClient

public abstract class AbstractClient
extends Object

The Eagle service client base class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractClient.Communicator Implements the client-service communication machinery.
protected class	AbstractClient.RequestReplyTableEntry Represents an entry in the request-reply table

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_serverLaunched

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClient(String name, String appName, String appNameForConfig, int appVersionMajor, int appVersionMinor, Object handlers, Credentials credentials) Construct using client name and user event handler container

Method Summary

Modifier and Type	Method and Description
void	close() Close a client.
protected abstract EmbeddedServerController	doGetEmbeddedServerController() Get the embedded server controller
protected abstract MessageHeader	doGetResponseHeader(MessageView message)
protected abstract void	doRegisterFactories(AepEngine engine) Invoked to register service specific factories
protected abstract IRogMessage	doSetRequestHeader(IRogMessage request, MessageHeader header)
protected void	finalize() Finalizer method.
String	getName() Get the name
String	getSourceId() Get the source id
String	getTransactionId() Get the current transaction id
AbstractClient	listenForAlerts(boolean val) Configure the client to listen to alerts
AbstractClient	listenForEvents(boolean val) Configure the client to listen to events
AbstractClient	listenForHeartbeats(boolean val) Configure the client to listen to heartbeats
void	onBindingFailed(MessageBusBindingFailedEvent event)
void	onEngineStopped(AepEngineStoppedEvent event)
void	onHeartbeat(Heartbeat heartbeat)
void	onMessagingStarted(AepMessagingStartedEvent event)
void	onRequestsChannelDown(AepChannelDownEvent event)
void	onRequestsChannelUp(AepChannelUpEvent event)
void	open()
void	open(AepEngine engine)
void	open(Credentials credentials)
void	open(Credentials credentials, AepEngine engine) Open a client.
PingResponse	ping(PingRequest request) Ping the service
void	recordTransactionLegTime(String legName, int procTime) Record the processing time of a leg in the current transaction
void	sendAlert(AlertRequest request) Send an alert
void	sendAlert(String headline, String desc, Throwable e, AlertSeverity severity) Send an alert
void	sendAlert(String desc, Throwable e, AlertSeverity severity) Send an alert
protected void	sendRequest(MessageHeader header, IRogMessage request, int partition)
protected <T> T	sendRequest(MessageHeader header, IRogMessage request, int partition, boolean waitForReply, Integer... timeout)
protected <T> T	sendRequestAndWaitForReply(MessageHeader header, IRogMessage request, int partition, Integer... timeout)
void	setResponseTimeout(int timeout) Set the client response timeout (in seconds)
void	setTransactionId(String id) Set the current transaction id Transaction ids are stored local to threads.
protected void	validateRequest(IRogMessage request)

Methods inherited from class java.lang.Object

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

Field Detail

_serverLaunched

protected boolean _serverLaunched

Constructor Detail

AbstractClient

protected AbstractClient(String name,
                         String appName,
                         String appNameForConfig,
                         int appVersionMajor,
                         int appVersionMinor,
                         Object handlers,
                         Credentials credentials)

Construct using client name and user event handler container

Method Detail

doRegisterFactories

protected abstract void doRegisterFactories(AepEngine engine)

Invoked to register service specific factories

doGetEmbeddedServerController

protected abstract EmbeddedServerController doGetEmbeddedServerController()

Get the embedded server controller

doSetRequestHeader

protected abstract IRogMessage doSetRequestHeader(IRogMessage request,
                                                  MessageHeader header)

doGetResponseHeader

protected abstract MessageHeader doGetResponseHeader(MessageView message)

validateRequest

protected void validateRequest(IRogMessage request)

sendRequest

protected final <T> T sendRequest(MessageHeader header,
                                  IRogMessage request,
                                  int partition,
                                  boolean waitForReply,
                                  Integer... timeout)

sendRequestAndWaitForReply

protected final <T> T sendRequestAndWaitForReply(MessageHeader header,
                                                 IRogMessage request,
                                                 int partition,
                                                 Integer... timeout)

sendRequest

protected final void sendRequest(MessageHeader header,
                                 IRogMessage request,
                                 int partition)

onRequestsChannelUp

public final void onRequestsChannelUp(AepChannelUpEvent event)

onRequestsChannelDown

public final void onRequestsChannelDown(AepChannelDownEvent event)

onBindingFailed

public final void onBindingFailed(MessageBusBindingFailedEvent event)

onMessagingStarted

public final void onMessagingStarted(AepMessagingStartedEvent event)

onEngineStopped

public final void onEngineStopped(AepEngineStoppedEvent event)

onHeartbeat

public final void onHeartbeat(Heartbeat heartbeat)

setResponseTimeout

public final void setResponseTimeout(int timeout)

Set the client response timeout (in seconds)

listenForEvents

public final AbstractClient listenForEvents(boolean val)

Configure the client to listen to events

listenForHeartbeats

public final AbstractClient listenForHeartbeats(boolean val)

Configure the client to listen to heartbeats

listenForAlerts

public final AbstractClient listenForAlerts(boolean val)

Configure the client to listen to alerts

open

public final void open(Credentials credentials,
                       AepEngine engine)
                throws EServiceException

Open a client.

Parameters:

credentials - A valid set of credentials to use in interacting with the service.

Throws:

EServiceException - Thrown in case an error is encountered during the open.

This method opens a connection to the messaging bus used for communication between and server client and service. Eagle supports in-process service execution (i.e. where the service runs in the same process as the client) and out of process service execution. The former uses the 'loopback' bus and is primarily used for testing purposes.

open

public final void open(AepEngine engine)
                throws EServiceException

Throws:

EServiceException

open

public final void open(Credentials credentials)
                throws EServiceException

Throws:

EServiceException

open

public final void open()
                throws EServiceException

Throws:

EServiceException

getName

public final String getName()

Get the name

getSourceId

public final String getSourceId()

Get the source id

setTransactionId

public final void setTransactionId(String id)

Set the current transaction id

Transaction ids are stored local to threads. Therefore each thread maintains its own transaction id set via this method

getTransactionId

public final String getTransactionId()

Get the current transaction id

recordTransactionLegTime

public final void recordTransactionLegTime(String legName,
                                           int procTime)

Record the processing time of a leg in the current transaction

ping

public final PingResponse ping(PingRequest request)
                        throws EServiceException

Ping the service

Throws:

EServiceException

sendAlert

public final void sendAlert(AlertRequest request)
                     throws EServiceException

Send an alert

Throws:

EServiceException

sendAlert

public void sendAlert(String headline,
                      String desc,
                      Throwable e,
                      AlertSeverity severity)

Send an alert

sendAlert

public void sendAlert(String desc,
                      Throwable e,
                      AlertSeverity severity)

Send an alert

close

public final void close()

Close a client.

The caller should invoke this method when done with the client object. This method closes the client's connection to the messaging bus and releases its resources back to the system. The caller should release the client object for garbage collection after this call.

finalize

protected void finalize()
                 throws Throwable

Finalizer method.

Ensures threads and resources are released when the object is garbage collected. This is only expected to be useful if the user has inadvertently missed closing the client. It is recommended that the user of the client calls close to release resources.

Overrides:

finalize in class Object

Throws:

Throwable