Package gov.usgs.earthquake.aws

Class TrackingIndex

java.lang.Object

gov.usgs.util.DefaultConfigurable

gov.usgs.earthquake.util.JDBCConnection

gov.usgs.earthquake.aws.TrackingIndex

All Implemented Interfaces:

Configurable, AutoCloseable

public class TrackingIndex
extends JDBCConnection

Tracking index stores component state in a database. Only SQLITE or local development should rely on createSchema. Mysql Schema Example:

 CREATE TABLE IF NOT EXISTS tracking_index
 (id INTEGER PRIMARY KEY AUTO_INCREMENT
 , created VARCHAR(255)
 , name VARCHAR(255)
 , data LONGTEXT
 , UNIQUE KEY name_index (name)
 ) ENGINE=innodb CHARSET=utf8;
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DRIVER	Variable for the default driver
static final String	DEFAULT_TABLE	Variable for the default table
static final String	DEFAULT_URL	Variable for the default URL

Fields inherited from class gov.usgs.earthquake.util.JDBCConnection

DATABASE_SECRET_ARN_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TrackingIndex()	Construct a TrackingIndex using defaults.
TrackingIndex(String driver, String url)	Construct a TrackingIndex with the default table.
TrackingIndex(String driver, String url, String table)	Construct a TrackingIndex with custom driver, url, and table.

Method Summary

Modifier and Type	Method	Description
void	configure(Config config)	Implement Configurable
void	createSchema()	Attempt to create schema.
String	getTable()
javax.json.JsonObject	getTrackingData(String name)	Get tracking data for specified name.
void	removeTrackingData(String name)	Remove tracking data.
boolean	schemaExists()	Check whether schema exists.
void	setTable(String table)
void	setTrackingData(String name, javax.json.JsonObject data)	Add or update tracking data.
void	startup()	After normal startup, check whether schema exists and attempt to create.

Methods inherited from class gov.usgs.earthquake.util.JDBCConnection

beginTransaction, buildUrl, close, commitTransaction, connect, getConnection, getDriver, getUrl, rollbackTransaction, setDriver, setUrl, shutdown, verifyConnection

Methods inherited from class gov.usgs.util.DefaultConfigurable

getName, setName

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_DRIVER

public static final String DEFAULT_DRIVER

Variable for the default driver

See Also:

• Constant Field Values

DEFAULT_TABLE

public static final String DEFAULT_TABLE

Variable for the default table

See Also:

• Constant Field Values

DEFAULT_URL

public static final String DEFAULT_URL

Variable for the default URL

See Also:

• Constant Field Values

Constructor Details

TrackingIndex

public TrackingIndex()

Construct a TrackingIndex using defaults.

TrackingIndex

public TrackingIndex(String driver,
 String url)

Construct a TrackingIndex with the default table.

Parameters:

driver - Driver to use

url - URL to use

TrackingIndex

public TrackingIndex(String driver,
 String url,
 String table)

Construct a TrackingIndex with custom driver, url, and table.

Parameters:

driver - Driver to use

url - URL to use

table - Table to use

Method Details

getTable

public String getTable()

Returns:

table

setTable

public void setTable(String table)

Parameters:

table - Table to set

configure

public void configure(Config config)
               throws Exception

Description copied from class: JDBCConnection

Implement Configurable

Specified by:

configure in interface Configurable

Overrides:

configure in class JDBCConnection

Parameters:

config - Config to set driver and URL in

Throws:

Exception - Exception

startup

public void startup()
             throws Exception

After normal startup, check whether schema exists and attempt to create.

Specified by:

startup in interface Configurable

Overrides:

startup in class JDBCConnection

Throws:

Exception - if error occurs

schemaExists

public boolean schemaExists()
                     throws Exception

Check whether schema exists.

Returns:

boolean

Throws:

Exception - if error occurs

createSchema

public void createSchema()
                  throws Exception

Attempt to create schema. Only supports sqlite or mysql. When not using sqlite, relying on this method is only recommended for local development.

Throws:

Exception - if error occurs

getTrackingData

public javax.json.JsonObject getTrackingData(String name)
                                      throws Exception

Get tracking data for specified name.

Parameters:

name - name of tracking data.

Returns:

null if data not found.

Throws:

Exception - if error occurs

removeTrackingData

public void removeTrackingData(String name)
                        throws Exception

Remove tracking data.

Parameters:

name - name of tracking data.

Throws:

Exception - if error occurs

setTrackingData

public void setTrackingData(String name,
 javax.json.JsonObject data)
                     throws Exception

Add or update tracking data.

Parameters:

name - name of tracking data.

data - data to store.

Throws:

Exception - if error occurs