Class JDBC_PING

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.Discovery

org.jgroups.protocols.FILE_PING

org.jgroups.protocols.JDBC_PING

All Implemented Interfaces:

Lifecycle

public class JDBC_PING
extends FILE_PING

Discovery protocol using a JDBC connection to a shared database. Connection options can be defined as configuration properties, or the JNDI name of a DataSource can be provided (avoid providing both).

Both the schema and the used SQL statements can be customized; make sure the order of parameters of such customized SQL statements is maintained and that compatible types are used for the columns. The recommended schema uses a single table, with two String columns being used primary key (local address, cluster name) and a third column to store the serialized form of the objects needed by JGroups.

A default table will be created at first connection, errors during this operation are not considered critical. Set the initialize_sql to an empty value to prevent this initial table creation, or change it to create a customized table.

Since:

2.12

Author:

Sanne Grinovero, Bela Ban

Nested Class Summary

Nested classes/interfaces inherited from class FILE_PING

FILE_PING.InfoWriter

Nested classes/interfaces inherited from class Discovery

Discovery.DiscoveryCacheDisseminationTask

Field Summary

Fields

Modifier and Type	Field	Description
protected String	clear_sql
protected String	connection_driver
protected String	connection_password
protected String	connection_url
protected String	connection_username
protected String	contains_sql
protected DataSource	dataSource
protected String	datasource_injecter_class
protected String	datasource_jndi_name
protected String	delete_single_sql
protected String	initialize_sql
protected String	insert_single_sql
protected String	select_all_pingdata_sql

Fields inherited from class FILE_PING

filter, info_writer, info_writer_max_writes_after_view, info_writer_sleep_time, location, num_read_loops, read_sleep, reads, regexp, register_shutdown_hook, remove_all_data_on_view_change, remove_old_coords_on_view_change, root_dir, shutdown_hook, SUFFIX, update_store_on_view_change, write_data_on_find, writes

Fields inherited from class Discovery

async_discovery, async_discovery_use_separate_thread_per_request, break_on_coord_rsp, cluster_name, current_coord, discovery_req_futures, discovery_rsp_callback, discovery_rsp_expiry_time, is_coord, is_leaving, is_server, max_members_in_discovery_request, max_rank_to_reply, num_discovery_requests, num_discovery_runs, ping_responses, return_entire_cache, send_cache_on_join, sends_can_block, stagger_timeout, timer, transport, transport_supports_multicasting, use_disk_cache, view, WHITESPACE

Fields inherited from class Protocol

after_creation_hook, down_prot, ergonomics, id, local_addr, log, policies, preview_warning, stack, stats, up_prot

Constructor Summary

Constructors

Constructor	Description
JDBC_PING()

Method Summary

Modifier and Type	Method	Description
protected static void	assertNonNull(String... strings)
protected void	attemptSchemaInitialization()
protected void	clearTable(String clustername)
protected void	closeConnection(Connection connection)
protected boolean	contains(String cluster_name, Address addr)
protected void	createRootDir()
protected void	delete(String clustername, String addressToDelete)
protected void	delete(Connection connection, String clustername, String addressToDelete)
String	getClearSql()
protected Connection	getConnection()
String	getConnectionDriver()
String	getConnectionPassword()
String	getConnectionUrl()
String	getConnectionUsername()
String	getContainsSql()
DataSource	getDataSource()
protected DataSource	getDataSourceFromJNDI(String name)
String	getDatasourceInjecterClass()
String	getDatasourceJndiName()
String	getDeleteSingleSql()
String	getInitializeSql()
String	getInsertSingleSql()
String	getSelectAllPingdataSql()
void	init()	Called after a protocol has been created and before the protocol is started.
protected DataSource	injectDataSource(String ds_class)
protected void	insert(Connection connection, PingData data, String clustername, String address)
protected void	loadDriver()
static void	main(String[] args)
protected static final PreparedStatement	prepareStatement(Connection connection, String sql, int resultSetType, int resultSetConcurrency)
protected void	readAll(Connection connection, List<Address> members, String clustername, Responses rsps)
protected void	readAll(List<Address> members, String clustername, Responses responses)
protected void	remove(String clustername, Address addr)
protected void	removeAll(String clustername)	Removes all files for the given cluster name
JDBC_PING	setClearSql(String c)
JDBC_PING	setConnectionDriver(String c)
JDBC_PING	setConnectionPassword(String c)
JDBC_PING	setConnectionUrl(String c)
JDBC_PING	setConnectionUsername(String c)
JDBC_PING	setContainsSql(String c)
JDBC_PING	setDataSource(DataSource ds)
JDBC_PING	setDatasourceInjecterClass(String d)
JDBC_PING	setDatasourceJndiName(String d)
JDBC_PING	setDeleteSingleSql(String d)
JDBC_PING	setInitializeSql(String i)
JDBC_PING	setInsertSingleSql(String i)
JDBC_PING	setSelectAllPingdataSql(String s)
protected static void	validateDatasourceJndiName(String name)
protected void	verifyConfigurationParameters()
protected void	write(List<PingData> list, String clustername)
protected void	writeToDB(PingData data, String clustername, boolean overwrite)

Methods inherited from class FILE_PING

addressToFilename, deleteFile, down, findMembers, getInfoWriterMaxWritesAfterView, getInfoWriterSleepTime, getLocation, handleView, isDynamic, isInfoWriterRunning, read, read, registerShutdownHook, registerShutdownHook, removeAllDataOnViewChange, removeAllDataOnViewChange, removeOldCoordsOnViewChange, removeOldCoordsOnViewChange, resetStats, setInfoWriterMaxWritesAfterView, setInfoWriterSleepTime, setLocation, start, startInfoWriter, stop, stopInfoWriter, updateStoreOnViewChange, updateStoreOnViewChange, write, writeAll, writeAll, writeDataOnFind, writeDataOnFind, writeInfo

Methods inherited from class Discovery

addDiscoveryResponseToCaches, addResponse, addResponse, addressAsString, addToCache, asyncDiscovery, asyncDiscovery, asyncDiscoveryUseSeparateThread, asyncDiscoveryUseSeparateThread, breakOnCoordResponse, breakOnCoordResponse, callFindMembersInAllDiscoveryProtocols, clearRequestFutures, deserialize, discoveryRequestReceived, discoveryRspExpiryTime, discoveryRspExpiryTime, disseminateDiscoveryInformation, dumpCache, findInitialMembersAsString, findMembers, findTopmostDiscoveryProtocol, getClusterName, getCurrentCoord, getNumberOfDiscoveryRequestsSent, getView, getViewId, handle, handleConnect, handleDisconnect, handleDiscoveryResponse, handleDiscoveryResponse, isCoord, isMergeRunning, marshal, marshal, marshal, maxRankToReply, maxRankToReply, numDiscoveryRuns, numDiscoveryRuns, print, providedUpServices, readPingData, returnEntireCache, returnEntireCache, sendCacheInformation, sendCacheOnJoin, sendCacheOnJoin, sendDiscoveryResponse, sendDiscoveryResponse, serializeWithoutView, setClusterName, staggerTimeout, staggerTimeout, startCacheDissemination, transportSupportsMulticasting, up, up, up, useDiskCache, useDiskCache, weedOutCompletedDiscoveryResponses

Methods inherited from class Protocol

accept, addPolicy, addr, addr, afterCreationHook, destroy, down, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, policies, previewWarning, previewWarning, providedDownServices, removePolicy, requiredDownServices, requiredUpServices, resetStatistics, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, statsEnabled, toString

Methods inherited from class Object

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

Field Details

connection_url

protected String connection_url

connection_username

protected String connection_username

connection_password

protected String connection_password

connection_driver

protected String connection_driver

initialize_sql

protected String initialize_sql

insert_single_sql

protected String insert_single_sql

delete_single_sql

protected String delete_single_sql

clear_sql

protected String clear_sql

select_all_pingdata_sql

protected String select_all_pingdata_sql

contains_sql

protected String contains_sql

datasource_jndi_name

protected String datasource_jndi_name

datasource_injecter_class

protected String datasource_injecter_class

dataSource

protected DataSource dataSource

Constructor Details

JDBC_PING

public JDBC_PING()

Method Details

createRootDir

protected void createRootDir()

Overrides:

createRootDir in class FILE_PING

setDataSource

public JDBC_PING setDataSource(DataSource ds)

getDataSource

public DataSource getDataSource()

getConnectionUrl

public String getConnectionUrl()

setConnectionUrl

public JDBC_PING setConnectionUrl(String c)

getConnectionUsername

public String getConnectionUsername()

setConnectionUsername

public JDBC_PING setConnectionUsername(String c)

getConnectionPassword

public String getConnectionPassword()

setConnectionPassword

public JDBC_PING setConnectionPassword(String c)

getConnectionDriver

public String getConnectionDriver()

setConnectionDriver

public JDBC_PING setConnectionDriver(String c)

getInitializeSql

public String getInitializeSql()

setInitializeSql

public JDBC_PING setInitializeSql(String i)

getInsertSingleSql

public String getInsertSingleSql()

setInsertSingleSql

public JDBC_PING setInsertSingleSql(String i)

getDeleteSingleSql

public String getDeleteSingleSql()

setDeleteSingleSql

public JDBC_PING setDeleteSingleSql(String d)

getClearSql

public String getClearSql()

setClearSql

public JDBC_PING setClearSql(String c)

getSelectAllPingdataSql

public String getSelectAllPingdataSql()

setSelectAllPingdataSql

public JDBC_PING setSelectAllPingdataSql(String s)

getContainsSql

public String getContainsSql()

setContainsSql

public JDBC_PING setContainsSql(String c)

getDatasourceJndiName

public String getDatasourceJndiName()

setDatasourceJndiName

public JDBC_PING setDatasourceJndiName(String d)

getDatasourceInjecterClass

public String getDatasourceInjecterClass()

setDatasourceInjecterClass

public JDBC_PING setDatasourceInjecterClass(String d)

init

public void init()
          throws Exception

Description copied from class: Protocol

Called after a protocol has been created and before the protocol is started. Attributes are already set. Other protocols are not yet connected and events cannot yet be sent.

Specified by:

init in interface Lifecycle

Overrides:

init in class FILE_PING

Throws:

Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the the channel constructor will throw an exception

write

protected void write(List<PingData> list,
 String clustername)

Overrides:

write in class FILE_PING

writeToDB

protected void writeToDB(PingData data,
 String clustername,
 boolean overwrite)

contains

protected boolean contains(String cluster_name,
 Address addr)

remove

protected void remove(String clustername,
 Address addr)

Overrides:

remove in class FILE_PING

removeAll

protected void removeAll(String clustername)

Description copied from class: FILE_PING

Removes all files for the given cluster name

Overrides:

removeAll in class FILE_PING

readAll

protected void readAll(List<Address> members,
 String clustername,
 Responses responses)

Overrides:

readAll in class FILE_PING

prepareStatement

protected static final PreparedStatement prepareStatement(Connection connection,
 String sql,
 int resultSetType,
 int resultSetConcurrency)
                                                   throws SQLException

Throws:

SQLException

readAll

protected void readAll(Connection connection,
 List<Address> members,
 String clustername,
 Responses rsps)
                throws SQLException

Throws:

SQLException

attemptSchemaInitialization

protected void attemptSchemaInitialization()

loadDriver

protected void loadDriver()

injectDataSource

protected DataSource injectDataSource(String ds_class)
                               throws Exception

Throws:

Exception

getConnection

protected Connection getConnection()

insert

protected void insert(Connection connection,
 PingData data,
 String clustername,
 String address)
               throws SQLException

Throws:

SQLException

delete

protected void delete(Connection connection,
 String clustername,
 String addressToDelete)
               throws SQLException

Throws:

SQLException

delete

protected void delete(String clustername,
 String addressToDelete)
               throws SQLException

Throws:

SQLException

clearTable

protected void clearTable(String clustername)

closeConnection

protected void closeConnection(Connection connection)

getDataSourceFromJNDI

protected DataSource getDataSourceFromJNDI(String name)

validateDatasourceJndiName

protected static void validateDatasourceJndiName(String name)

verifyConfigurationParameters

protected void verifyConfigurationParameters()

assertNonNull

protected static void assertNonNull(String... strings)

main

public static void main(String[] args)
                 throws ClassNotFoundException

Throws:

ClassNotFoundException