Package com.coditory.sherlock

Class SqlSherlockBuilder

java.lang.Object

com.coditory.sherlock.SqlSherlockBuilder

public final class SqlSherlockBuilder
extends Object

Builds Sherlock that uses SQL database for locking mechanism.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_LOCKS_TABLE_NAME

Method Summary

Modifier and Type	Method	Description
com.coditory.sherlock.Sherlock	build()
static SqlSherlockBuilder	sqlSherlock()
static com.coditory.sherlock.Sherlock	sqlSherlock(Connection connection)	Deprecated. Use withConnectionPool(DataSource) instead.
static com.coditory.sherlock.Sherlock	sqlSherlock(DataSource connectionPool)
SqlSherlockBuilder	withClock(Clock clock)
SqlSherlockBuilder	withConnection(Connection connection)	Deprecated. Use withConnectionPool(DataSource) instead.
SqlSherlockBuilder	withConnectionPool(DataSource connectionPool)
SqlSherlockBuilder	withLockDuration(Duration arg0)
SqlSherlockBuilder	withLocksTable(String tableName)
SqlSherlockBuilder	withOwnerId(String arg0)
SqlSherlockBuilder	withStaticUniqueOwnerId()
SqlSherlockBuilder	withUniqueOwnerId()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LOCKS_TABLE_NAME

public static final String DEFAULT_LOCKS_TABLE_NAME

See Also:

• Constant Field Values

Method Details

sqlSherlock

public static SqlSherlockBuilder sqlSherlock()

Returns:

new instance of the builder

sqlSherlock

@Deprecated(since="0.4.17")
public static com.coditory.sherlock.Sherlock sqlSherlock(Connection connection)

Deprecated.

Use withConnectionPool(DataSource) instead.

Parameters:

connection - the connection to the database

Returns:

sql sherlock with default configuration

See Also:

• Recovery after DB outage is failing

sqlSherlock

public static com.coditory.sherlock.Sherlock sqlSherlock(DataSource connectionPool)

Parameters:

connectionPool - the connection to the database

Returns:

sql sherlock with default configuration

withConnection

@Deprecated(since="0.4.17")
public SqlSherlockBuilder withConnection(Connection connection)

Deprecated.

Use withConnectionPool(DataSource) instead.

Parameters:

connection - the connection to the database

Returns:

the instance

See Also:

• Recovery after DB outage is failing

withConnectionPool

public SqlSherlockBuilder withConnectionPool(DataSource connectionPool)

Parameters:

connectionPool - the connection pool to the database

Returns:

the instance

withLocksTable

public SqlSherlockBuilder withLocksTable(String tableName)

Parameters:

tableName - the name of the table that stores locks

Returns:

the instance

withClock

public SqlSherlockBuilder withClock(Clock clock)

Parameters:

clock - time provider used in locking mechanism. Default: SherlockDefaults.DEFAULT_CLOCK

Returns:

the instance

build

public com.coditory.sherlock.Sherlock build()

Returns:

sherlock instance

Throws:

IllegalArgumentException - when some required values are missing

withLockDuration

public SqlSherlockBuilder withLockDuration(Duration arg0)

withOwnerId

public SqlSherlockBuilder withOwnerId(String arg0)

withUniqueOwnerId

public SqlSherlockBuilder withUniqueOwnerId()

withStaticUniqueOwnerId

public SqlSherlockBuilder withStaticUniqueOwnerId()