org.apache.jackrabbit.spi.commons.logging.WriterLogWriterProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.jackrabbit.spi.commons.logging;

import java.io.Writer;

import org.apache.jackrabbit.spi.Batch;
import org.apache.jackrabbit.spi.IdFactory;
import org.apache.jackrabbit.spi.NameFactory;
import org.apache.jackrabbit.spi.PathFactory;
import org.apache.jackrabbit.spi.QValueFactory;
import org.apache.jackrabbit.spi.RepositoryService;
import org.apache.jackrabbit.spi.SessionInfo;

/**
 * {@link LogWriterProvider} instance which provides {@link WriterLogWriter}s.
 */
public class WriterLogWriterProvider implements LogWriterProvider {

    /**
     * internal writer
     */
    private final Writer log;

    /**
     * Creates a new WriterLogWriterProvider based on the given writer
     * @param log the writer
     */
    public WriterLogWriterProvider(Writer log) {
        this.log = log;
    }

    /**
     * Returns a {@link WriterLogWriter} if the logger for 
     * service.getClass() has debug level enabled. Returns
     * null otherwise.
     * {@inheritDoc}
     */
    public LogWriter getLogWriter(RepositoryService service) {
        return getLogWriterInternal(log, service);
    }

    /**
     * Returns a {@link WriterLogWriter} if the logger for 
     * nameFactory.getClass() has debug level enabled. Returns
     * null otherwise.
     * {@inheritDoc}
     */
    public LogWriter getLogWriter(NameFactory nameFactory) {
        return getLogWriterInternal(log, nameFactory);
    }

    /**
     * Returns a {@link WriterLogWriter} if the logger for 
     * pathFactory.getClass() has debug level enabled. Returns
     * null otherwise.
     * {@inheritDoc}
     */
    public LogWriter getLogWriter(PathFactory pathFactory) {
        return getLogWriterInternal(log, pathFactory);
    }

    /**
     * Returns a {@link WriterLogWriter} if the logger for 
     * idFactory.getClass() has debug level enabled. Returns
     * null otherwise.
     * {@inheritDoc}
     */
    public LogWriter getLogWriter(IdFactory idFactory) {
        return getLogWriterInternal(log, idFactory);
    }

    /**
     * Returns a {@link WriterLogWriter} if the logger for 
     * valueFactory.getClass() has debug level enabled. Returns
     * null otherwise.
     * {@inheritDoc}
     */
    public LogWriter getLogWriter(QValueFactory valueFactory) {
        return getLogWriterInternal(log, valueFactory);
    }

    /**
     * Returns a {@link WriterLogWriter} if the logger for 
     * sessionInfo.getClass() has debug level enabled. Returns
     * null otherwise.
     * {@inheritDoc}
     */
    public LogWriter getLogWriter(SessionInfo sessionInfo) {
        return getLogWriterInternal(log, sessionInfo);
    }

    /**
     * Returns a {@link WriterLogWriter} if the logger for 
     * batch.getClass() has debug level enabled. Returns
     * null otherwise.
     * {@inheritDoc}
     */
    public LogWriter getLogWriter(Batch batch) {
        return getLogWriterInternal(log, batch);
    }

    // -----------------------------------------------------< private >---

    private static LogWriter getLogWriterInternal(Writer log, Object object) {
        return new WriterLogWriter(log, object.getClass().getSimpleName());
    }

}