software.amazon.jdbc.util.monitoring

Class AbstractMonitor

java.lang.Object

software.amazon.jdbc.util.monitoring.AbstractMonitor

All Implemented Interfaces:

java.lang.Runnable, Monitor

Direct Known Subclasses:

ClusterTopologyMonitorImpl, CustomEndpointMonitorImpl, HostMonitorImpl, LimitlessRouterMonitor, NodeResponseTimeMonitor

public abstract class AbstractMonitor
extends java.lang.Object
implements Monitor, java.lang.Runnable

An AbstractMonitor that implements common monitor logic.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.atomic.AtomicLong	lastActivityTimestampNanos
protected java.util.concurrent.ExecutorService	monitorExecutor
protected java.util.concurrent.atomic.AtomicReference<MonitorState>	state
protected java.util.concurrent.atomic.AtomicBoolean	stop
protected java.util.concurrent.atomic.AtomicLong	terminationTimeoutSec

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMonitor(long terminationTimeoutSec)
protected	AbstractMonitor(long terminationTimeoutSec, java.util.concurrent.ExecutorService monitorExecutor)

Method Summary

Modifier and Type	Method and Description
boolean	canDispose() Defines whether this monitor can be disposed.
void	close() Closes all resources used by this monitor.
long	getLastActivityTimestampNanos() Gets the timestamp for the last action performed by this monitor, in nanoseconds.
MonitorState	getState() Gets the current state of this monitor.
void	run() Starts the monitor workflow, making sure to set the initial state of the monitor.
void	start() Submits this monitor in a separate thread to begin its monitoring tasks.
void	stop() Stops the monitoring tasks for this monitor and closes all resources.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jdbc.util.monitoring.Monitor

monitor

Field Detail

stop

protected final java.util.concurrent.atomic.AtomicBoolean stop

monitorExecutor

protected final java.util.concurrent.ExecutorService monitorExecutor

terminationTimeoutSec

protected final java.util.concurrent.atomic.AtomicLong terminationTimeoutSec

lastActivityTimestampNanos

protected final java.util.concurrent.atomic.AtomicLong lastActivityTimestampNanos

state

protected final java.util.concurrent.atomic.AtomicReference<MonitorState> state

Constructor Detail

AbstractMonitor

protected AbstractMonitor(long terminationTimeoutSec)

AbstractMonitor

protected AbstractMonitor(long terminationTimeoutSec,
                          java.util.concurrent.ExecutorService monitorExecutor)

Method Detail

start

public void start()

Description copied from interface: Monitor

Submits this monitor in a separate thread to begin its monitoring tasks.

Specified by:

start in interface Monitor

run

public void run()

Starts the monitor workflow, making sure to set the initial state of the monitor. The monitor's workflow is wrapped in a try-catch so that unexpected exceptions are reported to the monitor service and the monitor's state is updated to MonitorState.ERROR.

Specified by:

run in interface java.lang.Runnable

stop

public void stop()

Description copied from interface: Monitor

Stops the monitoring tasks for this monitor and closes all resources.

Specified by:

stop in interface Monitor

close

public void close()

Description copied from interface: Monitor

Closes all resources used by this monitor. This method will be called as part of Monitor.stop().

Specified by:

close in interface Monitor

getLastActivityTimestampNanos

public long getLastActivityTimestampNanos()

Description copied from interface: Monitor

Gets the timestamp for the last action performed by this monitor, in nanoseconds.

Specified by:

getLastActivityTimestampNanos in interface Monitor

Returns:

the timestamp for the last action performed by this monitor, in nanoseconds.

getState

public MonitorState getState()

Description copied from interface: Monitor

Gets the current state of this monitor.

Specified by:

getState in interface Monitor

Returns:

the current state of this monitor.

canDispose

public boolean canDispose()

Description copied from interface: Monitor

Defines whether this monitor can be disposed.

Specified by:

canDispose in interface Monitor

Returns:

true if this monitor can be disposed, otherwise returns false.