com.amazon.carbonado.repo.logging

Class LoggingRepositoryBuilder

java.lang.Object

com.amazon.carbonado.spi.AbstractRepositoryBuilder

com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder

All Implemented Interfaces:

RepositoryBuilder

public class LoggingRepositoryBuilder
extends AbstractRepositoryBuilder

Repository implementation which logs activity against it. By default, all logged messages are at the debug level.

The following extra capabilities are supported:

• LogAccessCapability

Example:

 LoggingRepositoryBuilder loggingBuilder = new LoggingRepositoryBuilder();
 loggingBuilder.setActualRepositoryBuilder(...);
 Repository repo = loggingBuilder.build();
 

Author:

Brian S O'Neill

Constructor Summary

Constructors

Constructor and Description
LoggingRepositoryBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
Repository	build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) Builds a repository instance.
void	errorCheck(java.util.Collection<java.lang.String> messages) This method is called by assertReady, and subclasses must override to perform custom checks.
RepositoryBuilder	getActualRepositoryBuilder() Returns the Repository that all calls are wrapped to.
Log	getLog() Return the Log to use.
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.
void	setActualRepositoryBuilder(RepositoryBuilder builder) Set the Repository to wrap all calls to.
void	setLog(Log log) Set the Log to use.
void	setMaster(boolean master) 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, getTriggerFactories, removeTriggerFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingRepositoryBuilder

public LoggingRepositoryBuilder()

Method Detail

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

setName

public void setName(java.lang.String name)

Description copied from interface: RepositoryBuilder

Set name for the repository, which is required.

getName

public java.lang.String getName()

Description copied from interface: RepositoryBuilder

Returns the name of the repository.

setMaster

public void setMaster(boolean master)

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

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

setLog

public void setLog(Log log)

Set the Log to use. If null, use default. Log must be enabled when build is called, or else no logging is ever performed.

getLog

public Log getLog()

Return the Log to use. If null, use default.

setActualRepositoryBuilder

public void setActualRepositoryBuilder(RepositoryBuilder builder)

Set the Repository to wrap all calls to.

getActualRepositoryBuilder

public RepositoryBuilder getActualRepositoryBuilder()

Returns the Repository that all calls are wrapped to.

errorCheck

public void errorCheck(java.util.Collection<java.lang.String> messages)
                throws ConfigurationException

Description copied from class: AbstractRepositoryBuilder

This method is called by assertReady, and subclasses must override to perform custom checks. Be sure to call super.errorCheck as well.

Overrides:

errorCheck in class AbstractRepositoryBuilder

Parameters:

messages - add any error messages to this list

Throws:

ConfigurationException - if error checking indirectly caused another exception