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