com.amazon.carbonado.repo.map

Class MapRepositoryBuilder

java.lang.Object

com.amazon.carbonado.spi.AbstractRepositoryBuilder

com.amazon.carbonado.repo.map.MapRepositoryBuilder

All Implemented Interfaces:

RepositoryBuilder

public class MapRepositoryBuilder
extends AbstractRepositoryBuilder

Volatile repository implementation backed by a concurrent map. Locks used by repository are coarse, much like table locks. Loads and queries acquire read locks, and modifications acquire write locks. Within transactions, loads and queries always acquire upgradable locks, to reduce the likelihood of deadlock.

This repository supports transactions, which also may be nested. Supported isolation levels are read committed and serializable. Read uncommitted is promoted to read committed, and repeatable read is promoted to serializable.

The following extra capabilities are supported:

• IndexInfoCapability
• ShutdownCapability
• SequenceCapability

Note: This repository uses concurrent navigable map classes, which became available in JDK1.6.

Since:

1.2

Author:

Brian S O'Neill

Constructor Summary

Constructors

Constructor and Description
MapRepositoryBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
Repository	build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) Builds a repository instance.
int	getLockTimeout() Returns the lock timeout.
java.util.concurrent.TimeUnit	getLockTimeoutUnit() Returns the lock timeout unit.
java.lang.String	getName() Returns the name of the repository.
boolean	isMaster() Returns true if repository should assume the role of master, which is true by default.
static Repository	newRepository() Convenience method to build a new MapRepository.
void	setLockTimeout(int timeout, java.util.concurrent.TimeUnit unit) Set the lock timeout.
void	setLockTimeoutMillis(int timeout) Set the lock timeout, in milliseconds.
void	setMaster(boolean b) Set to false if repository should not assume the role of master.
void	setName(java.lang.String name) Set name for the repository, which is required.

Methods inherited from class com.amazon.carbonado.spi.AbstractRepositoryBuilder

addTriggerFactory, assertReady, build, errorCheck, getTriggerFactories, removeTriggerFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

MapRepositoryBuilder

public MapRepositoryBuilder()

Method Detail

newRepository

public static Repository newRepository()

Convenience method to build a new MapRepository.

build

public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
                 throws RepositoryException

Description copied from interface: RepositoryBuilder

Builds a repository instance.

If the repository is being wrapped by a parent repository, the child repository will need to know this fact for some operations to work correctly. Since the parent repository is not built yet, a reference is used instead.

Parameters:

rootRef - reference to root parent repository, to be set by parent repository upon being built

Throws:

ConfigurationException - if there is a problem in the builder's configuration

RepositoryException - if there is a general problem opening the repository

getName

public java.lang.String getName()

Description copied from interface: RepositoryBuilder

Returns the name of the repository.

setName

public void setName(java.lang.String name)

Description copied from interface: RepositoryBuilder

Set name for the repository, which is required.

isMaster

public boolean isMaster()

Description copied from interface: RepositoryBuilder

Returns true if repository should assume the role of master, which is true by default. Repositories that link different repositories together will designate only one as the master.

A master repository is responsible for version and sequence properties. For insert operations, a master repository must set these properties if they are uninitialized. For updates, the version property is checked to see if an OptimisticLockException should be thrown.

See Also:

ReplicatedRepositoryBuilder

setMaster

public void setMaster(boolean b)

Description copied from interface: RepositoryBuilder

Set to false if repository should not assume the role of master. By default, this option is true. Repositories that link different repositories together will designate only one as the master.

A master repository is responsible for version and sequence properties. For insert operations, a master repository must set these properties if they are uninitialized. For updates, the version property is checked to see if an OptimisticLockException should be thrown.

See Also:

ReplicatedRepositoryBuilder

setLockTimeoutMillis

public void setLockTimeoutMillis(int timeout)

Set the lock timeout, in milliseconds. Default value is 500 milliseconds.

setLockTimeout

public void setLockTimeout(int timeout,
                  java.util.concurrent.TimeUnit unit)

Set the lock timeout. Default value is 500 milliseconds.

getLockTimeout

public int getLockTimeout()

Returns the lock timeout. Call getLockTimeoutUnit to get the unit.

getLockTimeoutUnit

public java.util.concurrent.TimeUnit getLockTimeoutUnit()

Returns the lock timeout unit. Call getLockTimeout to get the timeout.