Log4J Appender to create per-request logs
[java-idp.git] / src / edu / internet2 / middleware / commons / log4j / WrappedLog.java
1 /*
2  * WrappedLog.java
3  * 
4  * IOU object for some Log data.
5  * 
6  * This interface is implemented, for example, by the 
7  * SimpleAppenderContextImpl.WrappedStringLog class.
8  * 
9  * 
10  * --------------------
11  * Copyright 2002, 2004 
12  * Yale University
13  * University Corporation for Advanced Internet Development, Inc. 
14  * All rights reserved
15  * Your permission to use this code is governed by "The Shibboleth License".
16  * A copy may be found at http://shibboleth.internet2.edu/license.html
17  */
18 package edu.internet2.middleware.commons.log4j;
19
20 /**
21  * Wrapper to abstract the ThreadLocal log storage.
22  * 
23  * <p>In most cases, the log data will just be a string kept in memory.
24  * However, one could imagine it would be a file on disk, or an EhCache
25  * hybrid where the last 100 are kept in memory and the overflow of 
26  * less recently used are written to disk. So after logging is done, we
27  * return this IOU that will fetch the log data later when you want
28  * to display it.
29  * 
30  * @author Howard Gilbert
31  */
32 public interface WrappedLog {
33     
34     String getLogData();
35
36 }