001/** 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.camel.spi; 018 019import org.apache.camel.Exchange; 020import org.apache.camel.LoggingLevel; 021import org.apache.camel.processor.CamelLogProcessor; 022import org.apache.camel.processor.LogProcessor; 023import org.apache.camel.util.CamelLogger; 024import org.slf4j.Marker; 025 026/** 027 * An event listener SPI for logging. Listeners are registered into {@link LogProcessor} and 028 * {@link CamelLogProcessor} so that the logging events are delivered for both of Log Component and Log EIP. 029 * 030 */ 031public interface LogListener { 032 033 /** 034 * Invoked right before Log component or Log EIP logs. 035 * Note that {@link CamelLogger} holds the {@link LoggingLevel} and {@link Marker}. 036 * The listener can check {@link CamelLogger#getLevel()} to see in which log level 037 * this is going to be logged. 038 * 039 * @param exchange camel exchange 040 * @param camelLogger {@link CamelLogger} 041 * @param message log message 042 * @return log message, possibly enriched by the listener 043 */ 044 String onLog(Exchange exchange, CamelLogger camelLogger, String message); 045 046}