com.neeve.service

Class AbstractApp<R>

java.lang.Object

com.google.inject.AbstractModule

com.neeve.service.AbstractApp<R>

All Implemented Interfaces:

com.google.inject.Module, EmbeddedServerController

public abstract class AbstractApp<R>
extends com.google.inject.AbstractModule
implements EmbeddedServerController

The Eagle service application base class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractApp.AlertRequestHandler<R> The alert request handler
protected class	AbstractApp.AlertSender<T extends IRogMessage>
protected class	AbstractApp.EventSender<T extends IRogMessage> Implements the event sender
static class	AbstractApp.HeartbeatRequestHandler<R> The heartbeat request handler
protected class	AbstractApp.HeartbeatSender<T extends IRogMessage> Implements the heartbeat sender
static class	AbstractApp.LogoutRequestHandler<R> The logout request handler
protected class	AbstractApp.MessageSenderImpl<T extends IRogMessage> Message sender base implementation
protected class	AbstractApp.PeerRequestSender<T extends IRogMessage> Implements the request sender
static class	AbstractApp.PostMessageProcessingTimesRequestHandler<R> The post message processing times request handler
protected class	AbstractApp.RequestExecutor<I extends IRogMessage & IRogCopyableNode,O extends IRogMessage,H extends MessageHandler<I,O,R>,S extends MessageSender<O>> The request executor
protected class	AbstractApp.ResponseSender<T extends IRogMessage> Implements the response sender

Field Summary

Fields

Modifier and Type	Field and Description
protected Alerter	_alerter
protected MessageChannel	_alertsChannel
static Set<String>	_coreAppChannels
protected AepEngine	_engine
protected MessageChannel	_eventsChannel
protected ScheduledThreadPoolExecutor	_heartbeatExecutor
protected MessageChannel	_heartbeatsChannel
protected IHeartbeatTracer	_heartbeatTracer
protected com.google.inject.Injector	_injector
protected Properties	_krt
protected MessageProcessingStatsCollector	_messageProcessingStatsCollector
protected IMessageTracer	_messageTracer
protected ExecutorService	_requestExecutor
protected MessageChannel	_responsesChannel
protected Tracer	_tracer
protected ICdcTracer	ALERT_CDC_TRACER
static String	ALERT_CHANNEL_NAME
protected IDbTracer	ALERT_DB_TRACER
protected IAlertTracer	ALERT_TRACER
static String	EVENT_CHANNEL_NAME
static String	HEARTBEAT_CHANNEL_NAME
protected IHeartbeatTracer	HEARTBEAT_TRACER
static String	LOOPBACK_URL
protected ICdcTracer	MAIN_CDC_TRACER
protected IDbTracer	MAIN_DB_TRACER
protected IMessageTracer	MESSAGE_TRACER
protected ICdcTracer	MPS_CDC_TRACER
protected IDbTracer	MPS_DB_TRACER
protected IMessageProcessingStatsTracer	MSGPROCSTATS_TRACER
static String	REQUEST_CHANNEL_NAME
static String	RESPONSE_CHANNEL_NAME
protected Tracer	TRACER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractApp(String appName, String appNameForConfig, int appPart, int appMajorVersion, int appMinorVersion) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addAppGuiceModule(String moduleClassName, Set<com.google.inject.AbstractModule> modules)
void	addCommandHandlerContainer(Set<Object> containers) Get command handler containers
void	addEventHandlerContainer(Set<Object> containers) Get event handler containers
protected void	configure() Guice module configurer
protected <I extends IRogMessage & IRogCopyableNode,O extends IRogMessage,H extends MessageHandler<I,O,R>,S extends MessageSender<O>> AbstractApp.RequestExecutor<I,O,H,S>	createRequestExecutor(String method, I request, MessageHeader requestHeader, O response, MessageHeader responseHeader, H handler, S sender) Request executor creator
protected void	doAddChannelDescriptorsForStreamingPeers(MessageBusDescriptor busDescriptor) Invoked to add channel descriptors for streaming peers
protected void	doAddChannelsForStreamingPeers(AepEngineDescriptor engineDescriptor) Invoked to add channels for streaming peers
protected void	doAddCommandHandlerContainers(Set<Object> containers) Invoked to add command handler containers
protected void	doAddEventHandlerContainers(Set<Object> containers) Invoked to add event handler containers
protected abstract void	doAddGuiceModules(Set<com.google.inject.AbstractModule> modules) Invoked to add service specific guice modules during initialization
protected void	doFinalize() Invoked to do service specific finalize
protected abstract String	doGetMainClassName() Invoked to get the name of the main app class
protected abstract Map<String,AbstractClient>	doGetPeerAsyncClients() Invoked to get the names and clients of the peer apps
protected abstract List<AbstractClient>	doGetPeerClients() Invoked to get the clients of the peer apps
protected void	doInitialize() Invoked to do service specific initialization
protected abstract void	doRegisterFactories() Invoked to register service specific factories
void	finalize() App finalizer
int	getThreadPoolCapacity() Thread pool capacity gauge stat reporter
int	getThreadPoolUsed() Thread pool used gauge stat reporter
protected Tracer	heartbeatTracer()
void	initialize() Initalize the application
protected abstract boolean	joinChannel(String channelName) Invoked to check if engine should join the specified channel
protected static String	localizeAppName(String env, String str)
String	messageStats(String command, String[] args) Message type stats command handler
protected Tracer	messageTracer() Return the message tracer
protected void	onActivated() Invoked to notify that the app has activated (become primary)
void	onAlert(AlertRequest request)
void	onAlertsChannelDown(AepChannelDownEvent event)
void	onAlertsChannelUp(AepChannelUpEvent event)
void	onEngineStarted(AepEngineStartedEvent event)
void	onEngineStopped(AepEngineStoppedEvent event)
void	onEventsChannelDown(AepChannelDownEvent event)
void	onEventsChannelUp(AepChannelUpEvent event)
void	onFirstMessage(FirstRequest request)
void	onHeartbeat(HeartbeatRequest request)
void	onHeartbeatsChannelDown(AepChannelDownEvent event)
void	onHeartbeatsChannelUp(AepChannelUpEvent event)
void	onLogout(LogoutRequest request)
protected void	onMessageProcessingComplete(MessageView message) Invoked on completion of message handler
protected void	onMessageProcessingStart(MessageView message) Invoked on invocation of message handler
protected void	onMessageSchedule(MessageView message) Invoked when a message is scheduled for inbound dispatch
protected void	onMessageSend(MessageView message, boolean response) Invoked when a message is sent outbound
void	onMessagingPrestart(AepMessagingPrestartEvent event)
protected void	onMessagingStarted() Invoked after messaging is successfully started
void	onMessagingStarted(AepMessagingStartedEvent event)
void	onNull(NullMessage message)
void	onPing(PingRequest request)
void	onPostMessageProcessingTimes(PostMessageProcessingTimesRequest request)
void	onRequestsChannelDown(AepChannelDownEvent event)
void	onRequestsChannelUp(AepChannelUpEvent event)
void	onResponsesChannelDown(AepChannelDownEvent event)
void	onResponsesChannelUp(AepChannelUpEvent event)
protected void	onStarted() Invoked to notify that the app has started
protected void	onStopped(Throwable cause) Invoked to notify that the app has stopped
protected void	onSubmitForRemoteExecution(MessageView message) Invoked prior to submitting a request to a separate thread for remote execution
void	prepEngineDescriptor(AepEngineDescriptor engineDescriptor) App engine descriptor injector
String	resetStats(String command, String[] args) Stats reset command handler
String	scheduleAlertLogCompaction(String command, String[] args) Schedule compaction (on next write) on the alert log
String	scheduleMpsLogCompaction(String command, String[] args) Schedule compaction (on next write) on the mps log
String	setAlertLogCompactionThreshold(String command, String[] args) Set alert log compaction threshold
void	setAppEngine(AepEngine engine) App engine injector
void	setAppLoader(SrvAppLoader loader) App loader injector
String	setMpsLogCompactionThreshold(String command, String[] args) Set mps log compaction threshold
void	start() Start the embedded server
String	startAlertLogging(String command, String[] args) Start alert logging
String	startMpsLogging(String command, String[] args) Start message processing time logging
void	stop() Stop the embedded server
String	stopAlertLogging(String command, String[] args) Stop alert logging
String	stopMpsLogging(String command, String[] args) Stop message processing time logging

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Field Detail

_engine

protected AepEngine _engine

_eventsChannel

protected MessageChannel _eventsChannel

_responsesChannel

protected MessageChannel _responsesChannel

_heartbeatsChannel

protected MessageChannel _heartbeatsChannel

_alertsChannel

protected MessageChannel _alertsChannel

_krt

protected Properties _krt

_requestExecutor

protected ExecutorService _requestExecutor

_heartbeatExecutor

protected ScheduledThreadPoolExecutor _heartbeatExecutor

_injector

protected com.google.inject.Injector _injector

_tracer

@Inject
protected Tracer _tracer

_messageTracer

@Inject
protected IMessageTracer _messageTracer

_heartbeatTracer

@Inject
protected IHeartbeatTracer _heartbeatTracer

_alerter

@Inject
protected Alerter _alerter

_messageProcessingStatsCollector

@Inject
protected MessageProcessingStatsCollector _messageProcessingStatsCollector

TRACER

protected final Tracer TRACER

MESSAGE_TRACER

protected final IMessageTracer MESSAGE_TRACER

HEARTBEAT_TRACER

protected final IHeartbeatTracer HEARTBEAT_TRACER

MSGPROCSTATS_TRACER

protected final IMessageProcessingStatsTracer MSGPROCSTATS_TRACER

ALERT_TRACER

protected final IAlertTracer ALERT_TRACER

MAIN_CDC_TRACER

protected final ICdcTracer MAIN_CDC_TRACER

MPS_CDC_TRACER

protected final ICdcTracer MPS_CDC_TRACER

ALERT_CDC_TRACER

protected final ICdcTracer ALERT_CDC_TRACER

MAIN_DB_TRACER

protected final IDbTracer MAIN_DB_TRACER

MPS_DB_TRACER

protected final IDbTracer MPS_DB_TRACER

ALERT_DB_TRACER

protected final IDbTracer ALERT_DB_TRACER

REQUEST_CHANNEL_NAME

public static final String REQUEST_CHANNEL_NAME

See Also:

Constant Field Values

RESPONSE_CHANNEL_NAME

public static final String RESPONSE_CHANNEL_NAME

See Also:

Constant Field Values

HEARTBEAT_CHANNEL_NAME

public static final String HEARTBEAT_CHANNEL_NAME

See Also:

Constant Field Values

ALERT_CHANNEL_NAME

public static final String ALERT_CHANNEL_NAME

See Also:

Constant Field Values

EVENT_CHANNEL_NAME

public static final String EVENT_CHANNEL_NAME

See Also:

Constant Field Values

_coreAppChannels

public static final Set<String> _coreAppChannels

LOOPBACK_URL

public static final String LOOPBACK_URL

See Also:

Constant Field Values

Constructor Detail

AbstractApp

protected AbstractApp(String appName,
                      String appNameForConfig,
                      int appPart,
                      int appMajorVersion,
                      int appMinorVersion)

Constructor

Method Detail

heartbeatTracer

protected final Tracer heartbeatTracer()

messageTracer

protected final Tracer messageTracer()

Return the message tracer

localizeAppName

protected static final String localizeAppName(String env,
                                              String str)

addAppGuiceModule

protected final void addAppGuiceModule(String moduleClassName,
                                       Set<com.google.inject.AbstractModule> modules)

doGetMainClassName

protected abstract String doGetMainClassName()

Invoked to get the name of the main app class

doGetPeerAsyncClients

protected abstract Map<String,AbstractClient> doGetPeerAsyncClients()

Invoked to get the names and clients of the peer apps

doGetPeerClients

protected abstract List<AbstractClient> doGetPeerClients()

Invoked to get the clients of the peer apps

doAddChannelDescriptorsForStreamingPeers

protected void doAddChannelDescriptorsForStreamingPeers(MessageBusDescriptor busDescriptor)

Invoked to add channel descriptors for streaming peers

joinChannel

protected abstract boolean joinChannel(String channelName)

Invoked to check if engine should join the specified channel

doAddChannelsForStreamingPeers

protected void doAddChannelsForStreamingPeers(AepEngineDescriptor engineDescriptor)
                                       throws Exception

Invoked to add channels for streaming peers

Throws:

Exception

doAddGuiceModules

protected abstract void doAddGuiceModules(Set<com.google.inject.AbstractModule> modules)

Invoked to add service specific guice modules during initialization

doRegisterFactories

protected abstract void doRegisterFactories()

Invoked to register service specific factories

doAddEventHandlerContainers

protected void doAddEventHandlerContainers(Set<Object> containers)

Invoked to add event handler containers

doAddCommandHandlerContainers

protected void doAddCommandHandlerContainers(Set<Object> containers)

Invoked to add command handler containers

doInitialize

protected void doInitialize()

Invoked to do service specific initialization

onStarted

protected void onStarted()

Invoked to notify that the app has started

onActivated

protected void onActivated()
                    throws Exception

Invoked to notify that the app has activated (become primary)

Throws:

Exception - An exception thrown by this method will result in the app being stopped.

Note: This event is dispatched before the first message is scheduled with the underlying engine and before messaging is started.

onMessagingStarted

protected void onMessagingStarted()

Invoked after messaging is successfully started

onSubmitForRemoteExecution

protected void onSubmitForRemoteExecution(MessageView message)

Invoked prior to submitting a request to a separate thread for remote execution

onMessageProcessingStart

protected void onMessageProcessingStart(MessageView message)

Invoked on invocation of message handler

onMessageProcessingComplete

protected void onMessageProcessingComplete(MessageView message)

Invoked on completion of message handler

onMessageSend

protected void onMessageSend(MessageView message,
                             boolean response)

Invoked when a message is sent outbound

onMessageSchedule

protected void onMessageSchedule(MessageView message)

Invoked when a message is scheduled for inbound dispatch

onStopped

protected void onStopped(Throwable cause)

Invoked to notify that the app has stopped

doFinalize

protected void doFinalize()

Invoked to do service specific finalize

configure

protected void configure()

Guice module configurer

Specified by:

configure in class com.google.inject.AbstractModule

createRequestExecutor

protected final <I extends IRogMessage & IRogCopyableNode,O extends IRogMessage,H extends MessageHandler<I,O,R>,S extends MessageSender<O>> AbstractApp.RequestExecutor<I,O,H,S> createRequestExecutor(String method,
                                                                                                                                                                                                       I request,
                                                                                                                                                                                                       MessageHeader requestHeader,
                                                                                                                                                                                                       O response,
                                                                                                                                                                                                       MessageHeader responseHeader,
                                                                                                                                                                                                       H handler,
                                                                                                                                                                                                       S sender)

Request executor creator

getThreadPoolCapacity

public final int getThreadPoolCapacity()

Thread pool capacity gauge stat reporter

getThreadPoolUsed

public final int getThreadPoolUsed()

Thread pool used gauge stat reporter

setAppLoader

public final void setAppLoader(SrvAppLoader loader)
                        throws Exception

App loader injector

Throws:

Exception

addCommandHandlerContainer

public final void addCommandHandlerContainer(Set<Object> containers)
                                      throws Exception

Get command handler containers

Throws:

Exception

addEventHandlerContainer

public final void addEventHandlerContainer(Set<Object> containers)
                                    throws Exception

Get event handler containers

Throws:

Exception

prepEngineDescriptor

public final void prepEngineDescriptor(AepEngineDescriptor engineDescriptor)
                                throws Exception

App engine descriptor injector

Throws:

Exception

setAppEngine

public final void setAppEngine(AepEngine engine)
                        throws Exception

App engine injector

Throws:

Exception

initialize

public final void initialize()
                      throws Exception

Initalize the application

Throws:

Exception

startMpsLogging

public final String startMpsLogging(String command,
                                    String[] args)
                             throws Exception

Start message processing time logging

Throws:

Exception

scheduleMpsLogCompaction

public final String scheduleMpsLogCompaction(String command,
                                             String[] args)
                                      throws Exception

Schedule compaction (on next write) on the mps log

Throws:

Exception

setMpsLogCompactionThreshold

public final String setMpsLogCompactionThreshold(String command,
                                                 String[] args)
                                          throws Exception

Set mps log compaction threshold

Throws:

Exception

stopMpsLogging

public final String stopMpsLogging(String command,
                                   String[] args)
                            throws Exception

Stop message processing time logging

Throws:

Exception

messageStats

public final String messageStats(String command,
                                 String[] args)
                          throws Exception

Message type stats command handler

Throws:

Exception

resetStats

public final String resetStats(String command,
                               String[] args)
                        throws Exception

Stats reset command handler

Throws:

Exception

startAlertLogging

public final String startAlertLogging(String command,
                                      String[] args)
                               throws Exception

Start alert logging

Throws:

Exception

scheduleAlertLogCompaction

public final String scheduleAlertLogCompaction(String command,
                                               String[] args)
                                        throws Exception

Schedule compaction (on next write) on the alert log

Throws:

Exception

setAlertLogCompactionThreshold

public final String setAlertLogCompactionThreshold(String command,
                                                   String[] args)
                                            throws Exception

Set alert log compaction threshold

Throws:

Exception

stopAlertLogging

public final String stopAlertLogging(String command,
                                     String[] args)
                              throws Exception

Stop alert logging

Throws:

Exception

onEngineStarted

public final void onEngineStarted(AepEngineStartedEvent event)

onMessagingPrestart

public final void onMessagingPrestart(AepMessagingPrestartEvent event)

onMessagingStarted

public final void onMessagingStarted(AepMessagingStartedEvent event)

onRequestsChannelUp

public final void onRequestsChannelUp(AepChannelUpEvent event)

onRequestsChannelDown

public final void onRequestsChannelDown(AepChannelDownEvent event)

onResponsesChannelUp

public final void onResponsesChannelUp(AepChannelUpEvent event)

onResponsesChannelDown

public final void onResponsesChannelDown(AepChannelDownEvent event)

onEventsChannelUp

public final void onEventsChannelUp(AepChannelUpEvent event)

onEventsChannelDown

public final void onEventsChannelDown(AepChannelDownEvent event)

onHeartbeatsChannelUp

public final void onHeartbeatsChannelUp(AepChannelUpEvent event)

onHeartbeatsChannelDown

public final void onHeartbeatsChannelDown(AepChannelDownEvent event)

onAlertsChannelUp

public final void onAlertsChannelUp(AepChannelUpEvent event)

onAlertsChannelDown

public final void onAlertsChannelDown(AepChannelDownEvent event)

onNull

public final void onNull(NullMessage message)

onFirstMessage

public final void onFirstMessage(FirstRequest request)

onPing

public final void onPing(PingRequest request)

onHeartbeat

public final void onHeartbeat(HeartbeatRequest request)

onAlert

public final void onAlert(AlertRequest request)

onPostMessageProcessingTimes

public final void onPostMessageProcessingTimes(PostMessageProcessingTimesRequest request)

onLogout

public final void onLogout(LogoutRequest request)

onEngineStopped

public final void onEngineStopped(AepEngineStoppedEvent event)

finalize

public void finalize()

App finalizer

Overrides:

finalize in class Object

start

public final void start()
                 throws Exception

Description copied from interface: EmbeddedServerController

Start the embedded server

Specified by:

start in interface EmbeddedServerController

Throws:

Exception

stop

public final void stop()

Description copied from interface: EmbeddedServerController

Stop the embedded server

Specified by:

stop in interface EmbeddedServerController