org.modeshape.persistence.relational

Class RelationalDb

java.lang.Object

org.modeshape.persistence.relational.RelationalDb

All Implemented Interfaces:

Lifecycle, SchematicDb, TransactionListener

public class RelationalDb
extends Object
implements SchematicDb

SchematicDb implementation which stores data in Relational databases.

Since:

5.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RelationalDb(Document configDoc)

Method Summary

Modifier and Type	Method and Description
protected RelationalDbConfig	config()
protected Connection	connectionForActiveTx()
boolean	containsKey(String key) Determine whether the database contains an entry with the supplied key.
protected DataSourceManager	dsManager()
EditableDocument	editContent(String key, boolean createIfMissing) Get an editor for the content of the given entry with the supplied key.
Document	get(String key) Get the document with the supplied key.
String	id() Returns a unique identifier for this schematic DB.
List<String>	keys() Returns a set over all the keys present in the DB.
List<SchematicEntry>	load(Collection<String> keys) Loads a set of documents from the DB returning the corresponding schematic entries.
protected Connection	newConnection(boolean autoCommit, boolean readonly)
void	put(String key, SchematicEntry entry) Stores the supplied schematic entry under the given key.
SchematicEntry	putIfAbsent(String key, Document content) Store the supplied content at the given key.
protected void	releaseConnectionForActiveTx()
boolean	remove(String key) Remove the existing document at the given key.
void	removeAll() Removes all the entries from this DB.
protected <R> R	runWithConnection(org.modeshape.persistence.relational.RelationalDb.SQLFunction<R> function, boolean readonly)
void	start() Announces that the repository is about to start using this DB.
void	stop() Announces that the repository is shutting down and will stop using this DB.
String	toString()
void	txCommitted(String id) Called by ModeShape once an existing transaction has been successfully committed.
void	txRolledback(String id) Called to indicate tha a transaction has been rolled back.
void	txStarted(String id) Called by ModeShape once a ModeShape transaction has been created.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.modeshape.schematic.SchematicDb

getEntry, put, putEntry

Constructor Detail

RelationalDb

protected RelationalDb(Document configDoc)

Method Detail

id

public String id()

Description copied from interface: SchematicDb

Returns a unique identifier for this schematic DB.

Implementations should make sure that the provided id is unique per storage instance. In other words, if two SchematicDb instances of the same type store data in two different places, they should return a different id.

Specified by:

id in interface SchematicDb

Returns:

a String, never null

start

public void start()

Description copied from interface: Lifecycle

Announces that the repository is about to start using this DB.

Specified by:

start in interface Lifecycle

stop

public void stop()

Description copied from interface: Lifecycle

Announces that the repository is shutting down and will stop using this DB.

Specified by:

stop in interface Lifecycle

keys

public List<String> keys()

Description copied from interface: SchematicDb

Returns a set over all the keys present in the DB.

If this method is called within an existing transaction, it should take into account the transient transactional context (i.e. any local but not yet committed changes)

Specified by:

keys in interface SchematicDb

Returns:

a List instance, never null

get

public Document get(String key)

Description copied from interface: SchematicDb

Get the document with the supplied key. This will represent the full SchematicEntry document if one exists.

If this method is called within an existing transaction, it should take into account the transient transactional context (i.e. any local but not yet committed changes)

Specified by:

get in interface SchematicDb

Parameters:

key - the key or identifier for the document

Returns:

the document, or null if there was no document with the supplied key

load

public List<SchematicEntry> load(Collection<String> keys)

Description copied from interface: SchematicDb

Loads a set of documents from the DB returning the corresponding schematic entries.

If this method is called within an existing transaction, it should not take into account the transient transactional context (i.e. any local but not yet committed changes) and should always return the latest persisted information.

Specified by:

load in interface SchematicDb

Parameters:

keys - an Collection of keys; never null

Returns:

a List of entries; never null

put

public void put(String key,
                SchematicEntry entry)

Description copied from interface: SchematicDb

Stores the supplied schematic entry under the given key. If an entry already exists with the same key, it should be overwritten.

Specified by:

put in interface SchematicDb

Parameters:

key - a schematic entry id, never null

entry - a SchematicEntry instance, never null

editContent

public EditableDocument editContent(String key,
                                    boolean createIfMissing)

Description copied from interface: SchematicDb

Get an editor for the content of the given entry with the supplied key.

Specified by:

editContent in interface SchematicDb

Parameters:

key - the key or identifier for the document

createIfMissing - true if a new entry should be created and added to the database if an existing entry does not exist

Returns:

the content document, or null if there was no document with the supplied key and a new one could not be created

putIfAbsent

public SchematicEntry putIfAbsent(String key,
                                  Document content)

Description copied from interface: SchematicDb

Store the supplied content at the given key.

Depending on the actual implementation, this may or may not be thread-safe. ModeShape never assumes this is thread-safe when calling it.

Specified by:

putIfAbsent in interface SchematicDb

Parameters:

key - the key or identifier for the content

content - the content that is to be stored

Returns:

the existing entry for the supplied key, or null if there was no entry and the put was successful

remove

public boolean remove(String key)

Description copied from interface: SchematicDb

Remove the existing document at the given key.

Specified by:

remove in interface SchematicDb

Parameters:

key - the key or identifier for the document

Returns:

true if the removal was successful, false otherwise

removeAll

public void removeAll()

Description copied from interface: SchematicDb

Removes all the entries from this DB.

Specified by:

removeAll in interface SchematicDb

containsKey

public boolean containsKey(String key)

Description copied from interface: SchematicDb

Determine whether the database contains an entry with the supplied key.

If this method is called within an existing transaction, it should take into account the transient transactional context (i.e. any local but not yet committed changes)

Specified by:

containsKey in interface SchematicDb

Parameters:

key - the key or identifier for the document

Returns:

true if the database contains an entry with this key, or false otherwise

txStarted

public void txStarted(String id)

Description copied from interface: TransactionListener

Called by ModeShape once a ModeShape transaction has been created.

Specified by:

txStarted in interface TransactionListener

Parameters:

id - the tx id; never null

txCommitted

public void txCommitted(String id)

Description copied from interface: TransactionListener

Called by ModeShape once an existing transaction has been successfully committed. This may be either a single ModeShape transaction or a longer-spanning user transaction.

Specified by:

txCommitted in interface TransactionListener

Parameters:

id - the tx id; never null

txRolledback

public void txRolledback(String id)

Description copied from interface: TransactionListener

Called to indicate tha a transaction has been rolled back.

Specified by:

txRolledback in interface TransactionListener

Parameters:

id - the tx id; never null

runWithConnection

protected <R> R runWithConnection(org.modeshape.persistence.relational.RelationalDb.SQLFunction<R> function,
                                  boolean readonly)

connectionForActiveTx

protected Connection connectionForActiveTx()

config

protected RelationalDbConfig config()

dsManager

protected DataSourceManager dsManager()

releaseConnectionForActiveTx

protected void releaseConnectionForActiveTx()

newConnection

protected Connection newConnection(boolean autoCommit,
                                   boolean readonly)

toString

public String toString()

Overrides:

toString in class Object