CommonsLog (Carbonado 1.2.3 API)

java.lang.Object
+
- com.amazon.carbonado.repo.logging.CommonsLog
+

+
+
All Implemented Interfaces:
+
Log
+
+
+
+
```
public class CommonsLog
+extends java.lang.Object
+implements Log
```
+
Log implementation that uses Jakarta Commons Logging at debug level.
+
Author:
+
Brian S O'Neill
+

+ +
- + + +
  Constructor Summary
  + + + + + + + + + + + +
  Constructors
  Constructor and Description
  CommonsLog(java.lang.Class clazz)
  CommonsLog(org.apache.commons.logging.Log log)
  +
+ +
- + + +
  Method Summary
  + + + + + + + + + + + + + + +
  Methods
  Modifier and Type Method and Description
  boolean isEnabled()
  void write(java.lang.String message)
  +
  - + + +
    Methods inherited from class java.lang.Object
    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  +
+

Constructors
Constructor and Description
`CommonsLog(java.lang.Class clazz)`
`CommonsLog(org.apache.commons.logging.Log log)`

Methods
Modifier and Type	Method and Description
`boolean`	`isEnabled()`
`void`	`write(java.lang.String message)`

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    CommonsLog
    +
```
public CommonsLog(org.apache.commons.logging.Log log)
```
    +
  + + + +
  - +
    CommonsLog
    +
```
public CommonsLog(java.lang.Class clazz)
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    isEnabled
    +
```
public boolean isEnabled()
```
    +
    +
    Specified by:
    +
    isEnabled in interface Log
    +
    +
  + + + +
  - +
    write
    +
```
public void write(java.lang.String message)
```
    +
    +
    Specified by:
    +
    write in interface Log
    +
    +
  +
+

Methods
Modifier and Type	Method and Description
`boolean`	`isEnabled()`
`void`	`write(java.lang.String message)`

Methods
Modifier and Type	Method and Description
`Log`	`getLog()`

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()
+

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
    +
  +
+

Modifier and Type	Method and Description
`Log`	LoggingRepositoryBuilder.`getLog()` + Return the Log to use. +
`Log`	LogAccessCapability.`getLog()`

Interface	Description
Log	+ Very simple Log interface. +
LogAccessCapability	+ Provides access to the Log. +

Class	Description
CommonsLog	+ Log implementation that uses Jakarta Commons Logging at debug level. +
LoggingRepositoryBuilder	+ Repository implementation which logs activity against it. +

Class CommonsLog

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommonsLog

CommonsLog

Method Detail

isEnabled

write

Interface Log

Method Summary

Method Detail

isEnabled

write

Interface LogAccessCapability

Method Summary

Method Detail

getLog

Class LoggingRepositoryBuilder

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

LoggingRepositoryBuilder

Method Detail

build

setName

getName

setMaster

isMaster

setLog

getLog

setActualRepositoryBuilder

getActualRepositoryBuilder

errorCheck

Uses of Classcom.amazon.carbonado.repo.logging.CommonsLog

Uses of Interfacecom.amazon.carbonado.repo.logging.Log

Uses of Log in com.amazon.carbonado.repo.logging

Uses of Interfacecom.amazon.carbonado.repo.logging.LogAccessCapability

Uses of Classcom.amazon.carbonado.repo.logging.LoggingRepositoryBuilder

com.amazon.carbonado.repo.logging

Interfaces

Classes

Package com.amazon.carbonado.repo.logging

Package com.amazon.carbonado.repo.logging Description

Hierarchy For Package com.amazon.carbonado.repo.logging

Class Hierarchy

Interface Hierarchy

Uses of Packagecom.amazon.carbonado.repo.logging

Uses of Class
com.amazon.carbonado.repo.logging.CommonsLog

Uses of Interface
com.amazon.carbonado.repo.logging.Log

Uses of Interface
com.amazon.carbonado.repo.logging.LogAccessCapability

Uses of Class
com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder

Uses of Package
com.amazon.carbonado.repo.logging