View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements. See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache license, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License. You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the license for the specific language governing permissions and
    15   * limitations under the license.
    16   */
    17  package org.apache.logging.log4j.core.net.server;
    18
    19  import java.io.IOException;
    20  import java.io.InputStream;
    21
    22  import org.apache.logging.log4j.core.LogEvent;
    23  import org.apache.logging.log4j.core.LogEventListener;
    24
    25  /**
    26   * Reads {@link LogEvent}s from the given input stream and logs them as they are discovered on the given logger.
    27   *
    28   * <p>
    29   * Should be stateless.
    30   * </p>
    31   *
    32   * @param <T>
    33   *            The kind of {@link InputStream} to wrap and read.
    34   */
    35  public interface LogEventBridge<T extends InputStream> {
    36
    37      /**
    38       * Reads {@link LogEvent}s from the given input stream and logs them as they are discovered on the given logger.
    39       *
    40       * @param inputStream
    41       *            the input stream to read
    42       * @param logEventListener
    43       *            TODO
    44       * @throws IOException
    45       */
    46      void logEvents(T inputStream, LogEventListener logEventListener) throws IOException;
    47
    48      /**
    49       * Wraps the given stream if needed.
    50       *
    51       * @param inputStream
    52       *            the stream to wrap
    53       * @return the wrapped stream or the given stream.
    54       * @throws IOException
    55       */
    56      T wrapStream(InputStream inputStream) throws IOException;
    57  }