summaryrefslogtreecommitdiff
path: root/src/main/java/com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.java
blob: e7724837594bb55dfff2f7f87a4794b13b7798f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * Copyright 2006-2012 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.amazon.carbonado.repo.logging;

import java.util.Collection;

import java.util.concurrent.atomic.AtomicReference;

import com.amazon.carbonado.ConfigurationException;
import com.amazon.carbonado.Repository;
import com.amazon.carbonado.RepositoryBuilder;
import com.amazon.carbonado.RepositoryException;
import com.amazon.carbonado.TriggerFactory;

import com.amazon.carbonado.spi.AbstractRepositoryBuilder;

/**
 * Repository implementation which logs activity against it. By default, all
 * logged messages are at the debug level.
 *
 * <p>
 * The following extra capabilities are supported:
 * <ul>
 * <li>{@link LogAccessCapability}
 * </ul>
 *
 * Example:
 *
 * <pre>
 * LoggingRepositoryBuilder loggingBuilder = new LoggingRepositoryBuilder();
 * loggingBuilder.setActualRepositoryBuilder(...);
 * Repository repo = loggingBuilder.build();
 * </pre>
 *
 * @author Brian S O'Neill
 */
public class LoggingRepositoryBuilder extends AbstractRepositoryBuilder {
    private String mName;
    private Boolean mMaster;
    private Log mLog;
    private RepositoryBuilder mRepoBuilder;

    public LoggingRepositoryBuilder() {
    }

    public Repository build(AtomicReference<Repository> rootRef) throws RepositoryException {
        if (mName == null) {
            if (mRepoBuilder != null) {
                mName = mRepoBuilder.getName();
            }
        }

        assertReady();

        if (mLog == null) {
            mLog = new CommonsLog(LoggingRepository.class);
        }

        String originalName = mRepoBuilder.getName();
        boolean originalIsMaster = mRepoBuilder.isMaster();

        boolean enabled = mLog.isEnabled();
        boolean master = mMaster != null ? mMaster : originalIsMaster;

        Repository actual;
        try {
            if (enabled) {
                mRepoBuilder.setName("Logging " + mName);
            }
            mRepoBuilder.setMaster(master);
            for (TriggerFactory factory : getTriggerFactories()) {
                mRepoBuilder.addTriggerFactory(factory);
            }
            actual = mRepoBuilder.build(rootRef);
        } finally {
            mRepoBuilder.setName(originalName);
            mRepoBuilder.setMaster(originalIsMaster);
        }

        if (!enabled) {
            return actual;
        }

        Repository repo = new LoggingRepository(rootRef, actual, mLog);
        rootRef.set(repo);
        return repo;
    }

    public void setName(String name) {
        mName = name;
    }

    public String getName() {
        return mName;
    }

    public void setMaster(boolean master) {
        mMaster = master;
    }

    public boolean isMaster() {
        return mMaster != null ? mMaster
            : (mRepoBuilder != null ? mRepoBuilder.isMaster() : false);
    }

    /**
     * Set the Log to use. If null, use default. Log must be enabled when build
     * is called, or else no logging is ever performed.
     */
    public void setLog(Log log) {
        mLog = log;
    }

    /**
     * Return the Log to use. If null, use default.
     */
    public Log getLog() {
        return mLog;
    }

    /**
     * Set the Repository to wrap all calls to.
     */
    public void setActualRepositoryBuilder(RepositoryBuilder builder) {
        mRepoBuilder = builder;
    }

    /**
     * Returns the Repository that all calls are wrapped to.
     */
    public RepositoryBuilder getActualRepositoryBuilder() {
        return mRepoBuilder;
    }

    @Override
    public void errorCheck(Collection<String> messages) throws ConfigurationException {
        super.errorCheck(messages);
        if (mRepoBuilder == null) {
            messages.add("Actual repository builder must be set");
        }
    }
}