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
    18  package org.apache.log4j.spi;
    19
    20
    21  import java.io.IOException;
    22
    23  import java.net.URL;
    24
    25  import java.util.Map;
    26  import java.util.Vector;
    27
    28
    29  /**
    30   *  Allow LoggingEvents to be reconstructed from a different format
    31   * (usually XML).
    32   *
    33   *  @author Scott Deboy (sdeboy@apache.org)
    34   */
    35  public interface Decoder {
    36      /**
    37       * Decode events from document.
    38       * @param document document to decode.
    39       * @return list of LoggingEvent instances.
    40       */
    41    Vector decodeEvents(String document);
    42
    43      /**
    44       * Decode event from string.
    45       * @param event string representation of event
    46       * @return event
    47       */
    48    LoggingEvent decode(String event);
    49
    50      /**
    51       * Decode event from document retreived from URL.
    52       * @param url url of document
    53       * @return list of LoggingEvent instances.
    54       * @throws IOException if IO error resolving document.
    55       */
    56    Vector decode(URL url) throws IOException;
    57
    58      /**
    59       * Sets additional properties.
    60       * @param additionalProperties map of additional properties.
    61       */
    62    void setAdditionalProperties(Map additionalProperties);
    63  }