org.spf4j.concurrent.jdbc

Class JdbcHeartBeat

java.lang.Object

org.spf4j.concurrent.jdbc.JdbcHeartBeat

All Implemented Interfaces:

AutoCloseable

@ParametersAreNonnullByDefault
 @ThreadSafe
public final class JdbcHeartBeat
extends Object
implements AutoCloseable

A class that does "heartbeats" (at a arbitrary inteval) to a database table. This is to detect the death of a process. The process is considered dead when: currentTime - lastheartbeat > beatInterval * 2 When this class mechanism detects that it cannot perform the heartbeats it throws a Error. The sensible this for the process is to go down (and restart if it is a daemon). This is typically done by registering a default uncaught exception handler with: Thread.setDefaultUncaughtExceptionHandler

Author:

zoly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JdbcHeartBeat.LifecycleHook

Method Summary

Modifier and Type	Method and Description
void	addLyfecycleHook(JdbcHeartBeat.LifecycleHook hook)
void	beat()
void	close()
long	getBeatDurationNanos()
HeartBeatTableDesc	getHbTableDesc()
static JdbcHeartBeat	getHeartBeatAndSubscribe(DataSource dataSource, HeartBeatTableDesc hbTableDesc, JdbcHeartBeat.LifecycleHook hook) Get a reference to the hearbeat instance.
static JdbcHeartBeat	getHeartBeatAndSubscribe(DataSource dataSource, HeartBeatTableDesc hbTableDesc, JdbcHeartBeat.LifecycleHook hook, int heartBeatIntevalMillis, int jdbcTimeoutSeconds)
static JdbcHeartBeat	getHeartBeatAndSubscribe(DataSource dataSource, HeartBeatTableDesc hbTableDesc, JdbcHeartBeat.LifecycleHook hook, int heartBeatIntevalMillis, int jdbcTimeoutSeconds, com.google.common.util.concurrent.ListeningScheduledExecutorService scheduler)
long	getIntervalMillis()
long	getLastRunDB()
long	getLastRunNanos()
String	getLastRunTimeStampString()
void	registerJmx()
int	removeDeadHeartBeatRows(long timeoutSeconds)
Future<Integer>	removeDeadHeartBeatRowsAsync(long timeoutSeconds)
void	removeDeadHeartBeatRowsAsyncNoReturn(long timeoutSeconds)
void	removeLifecycleHook(JdbcHeartBeat.LifecycleHook hook)
void	scheduleHeartbeat(com.google.common.util.concurrent.ListeningScheduledExecutorService scheduler)
static void	stopHeartBeats()
String	toString()
void	unregisterJmx()

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Throws:

SQLException

getBeatDurationNanos

public long getBeatDurationNanos()

registerJmx

public void registerJmx()

unregisterJmx

public void unregisterJmx()

addLyfecycleHook

public void addLyfecycleHook(JdbcHeartBeat.LifecycleHook hook)

removeLifecycleHook

public void removeLifecycleHook(JdbcHeartBeat.LifecycleHook hook)

removeDeadHeartBeatRows

public int removeDeadHeartBeatRows(long timeoutSeconds)
                            throws SQLException,
                                   InterruptedException

Throws:

SQLException

InterruptedException

removeDeadHeartBeatRowsAsyncNoReturn

public void removeDeadHeartBeatRowsAsyncNoReturn(long timeoutSeconds)

removeDeadHeartBeatRowsAsync

public Future<Integer> removeDeadHeartBeatRowsAsync(long timeoutSeconds)

scheduleHeartbeat

public void scheduleHeartbeat(com.google.common.util.concurrent.ListeningScheduledExecutorService scheduler)

beat

public void beat()
          throws SQLException,
                 InterruptedException

Throws:

SQLException

InterruptedException

getLastRunDB

public long getLastRunDB()
                  throws SQLException,
                         InterruptedException

Throws:

SQLException

InterruptedException

getIntervalMillis

public long getIntervalMillis()

getLastRunNanos

public long getLastRunNanos()

getLastRunTimeStampString

public String getLastRunTimeStampString()

getHeartBeatAndSubscribe

public static JdbcHeartBeat getHeartBeatAndSubscribe(DataSource dataSource,
                                                     HeartBeatTableDesc hbTableDesc,
                                                     @Nullable
                                                     JdbcHeartBeat.LifecycleHook hook)
                                              throws InterruptedException,
                                                     SQLException

Get a reference to the hearbeat instance.

Parameters:

dataSource - the datasource the hearbeat goes against.

hbTableDesc - - heartbeat table description.

hook - a hook to notify when heartbeat fails.

Returns:

the heartbeat instance.

Throws:

InterruptedException

SQLException

getHeartBeatAndSubscribe

public static JdbcHeartBeat getHeartBeatAndSubscribe(DataSource dataSource,
                                                     HeartBeatTableDesc hbTableDesc,
                                                     @Nullable
                                                     JdbcHeartBeat.LifecycleHook hook,
                                                     int heartBeatIntevalMillis,
                                                     int jdbcTimeoutSeconds)
                                              throws InterruptedException,
                                                     SQLException

Throws:

InterruptedException

SQLException

getHeartBeatAndSubscribe

public static JdbcHeartBeat getHeartBeatAndSubscribe(DataSource dataSource,
                                                     HeartBeatTableDesc hbTableDesc,
                                                     @Nullable
                                                     JdbcHeartBeat.LifecycleHook hook,
                                                     int heartBeatIntevalMillis,
                                                     int jdbcTimeoutSeconds,
                                                     com.google.common.util.concurrent.ListeningScheduledExecutorService scheduler)
                                              throws InterruptedException,
                                                     SQLException

Throws:

InterruptedException

SQLException

stopHeartBeats

public static void stopHeartBeats()

getHbTableDesc

public HeartBeatTableDesc getHbTableDesc()

toString

public String toString()

Overrides:

toString in class Object