net.shibboleth.utilities.java.support.velocity.SLF4JLogChute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.saml.opensaml.integration Show documentation
Liferay SAML OpenSAML Integration
There is a newer version: 6.2.20
Show newest version
/*
 * Licensed to the University Corporation for Advanced Internet Development,
 * Inc. (UCAID) under one or more contributor license agreements.  See the
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID 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 net.shibboleth.utilities.java.support.velocity;

import org.apache.velocity.runtime.RuntimeServices;
import org.apache.velocity.runtime.log.LogChute;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Redirects Velocity's LogChute messages to SLF4J.
 *
 * To use, first set up SLF4J, then tell Velocity to use
 * this class for logging by adding the following to your velocity.properties:
 *
 * 
 * runtime.log.logsystem.class = edu.internet2.middleware.shibboleth.common.util.Slf4jLogChute
 * 
 * 
 *
 * You may also set this property to specify what log/name Velocity's
 * messages should be logged to (example below is default).
 * 
 * runtime.log.logsystem.slf4j.name = org.apache.velocity
 * 
 * 
 */
public class SLF4JLogChute implements LogChute {

    /** Property key for specifying the name for the log instance. */
    public static final String LOGCHUTE_SLF4J_NAME = "runtime.log.logsystem.slf4j.name";
    
    /** Default name for the commons-logging instance. */
    public static final String DEFAULT_LOG_NAME = "org.apache.velocity";
    
    /** The Slf4J Logger instance. */
    private Logger log;
    
    /** {@inheritDoc} */
    public void init(final RuntimeServices rs) throws Exception {
        String name = (String) rs.getProperty(LOGCHUTE_SLF4J_NAME);
        if (name == null) {
            name = DEFAULT_LOG_NAME;
        }
        log = LoggerFactory.getLogger(name);
        log(LogChute.DEBUG_ID, "SLF4JLogChute name is '" + name + "'");
    }

    /** {@inheritDoc} */
    public boolean isLevelEnabled(final int level) {
        switch (level) {
            case LogChute.DEBUG_ID:
                return log.isDebugEnabled();
            case LogChute.INFO_ID:
                return log.isInfoEnabled();
            case LogChute.TRACE_ID:
                return log.isTraceEnabled();
            case LogChute.WARN_ID:
                return log.isWarnEnabled();
            case LogChute.ERROR_ID:
                return log.isErrorEnabled();
            default:
                return true;
        }
    }

    /** {@inheritDoc} */
    public void log(final int level, final String message) {
        switch (level) {
            case LogChute.ERROR_ID:
                log.error(message);
                break;
            case LogChute.WARN_ID:
                log.warn(message);
                break;
            case LogChute.INFO_ID:
                log.info(message);
                break;
            case LogChute.TRACE_ID:
                log.trace(message);
                break;
            case LogChute.DEBUG_ID:
            default:
                log.debug(message);
        }
    }

    /** {@inheritDoc} */
    public void log(final int level, final String message, final Throwable t) {
        switch (level) {
            case LogChute.ERROR_ID:
                log.error(message, t);
                break;
            case LogChute.WARN_ID:
                log.warn(message, t);
                break;
            case LogChute.INFO_ID:
                log.info(message, t);
                break;
            case LogChute.TRACE_ID:
                log.trace(message, t);
                break;
            case LogChute.DEBUG_ID:
            default:
                log.debug(message, t);
        }
    }

}