001: package org.enhydra.snapper.api.logging;
002:
003: import java.util.*;
004: import org.enhydra.snapper.api.RootException;
005:
006: /**
007: * LoggingManager handles logging in Shark.
008: *
009: * @author Sasa Bojanic
010: * @author Vladimir Puskas
011: * @author Tanja Jovanovic
012: * @author Igor Smirnov
013: */
014: public interface LoggingManager {
015:
016: /**
017: * Method configure is called at Shark start up, to configure
018: * implementation of LoggingManager.
019: *
020: * @param cus an instance of CallbackUtilities used to get
021: * properties for configuring logging in Shark.
022: */
023: void configure(Properties prop);
024:
025: /**
026: * Log a message object with the <i>ERROR</i> Level.
027: *
028: * @param msg the message to log.
029: *
030: */
031: void error(String msg);
032:
033: /**
034: * Log a message object with the <i>ERROR</i> Level.
035: *
036: * @param msg the message to log.
037: * @param ex the exception to log, including its stack trace.
038: *
039: */
040: void error(String msg, RootException ex);
041:
042: /**
043: * Log a message object with the <i>ERROR</i> Level.
044: *
045: * @param channel the log channel to be used for logging.
046: * @param msg the message to log.
047: *
048: */
049: void error(String channel, String msg);
050:
051: /**
052: * Log a message object with the <i>ERROR</i> Level.
053: *
054: * @param channel the log channel to be used for logging.
055: * @param msg the message to log.
056: * @param ex the exception to log, including its stack trace.
057: *
058: */
059: void error(String channel, String msg, RootException ex);
060:
061: /**
062: * Log a message object with the <i>WARN</i> Level.
063: *
064: * @param msg the message to log.
065: *
066: */
067: void warn(String msg);
068:
069: /**
070: * Log a message object with the <i>WARN</i> Level.
071: *
072: * @param msg the message to log.
073: * @param ex the exception to log, including its stack trace.
074: *
075: */
076: void warn(String msg, RootException ex);
077:
078: /**
079: * Log a message object with the <i>WARN</i> Level.
080: *
081: * @param channel the log channel to be used for logging.
082: * @param msg the message to log.
083: *
084: */
085: void warn(String channel, String msg);
086:
087: /**
088: * Log a message object with the <i>WARN</i> Level.
089: *
090: * @param channel the log channel to be used for logging.
091: * @param msg the message to log.
092: * @param ex the exception to log, including its stack trace.
093: *
094: */
095: void warn(String channel, String msg, RootException ex);
096:
097: /**
098: * Log a message object with the <i>INFO</i> Level.
099: *
100: * @param msg the message to log.
101: *
102: */
103: void info(String msg);
104:
105: /**
106: * Log a message object with the <i>INFO</i> Level.
107: *
108: * @param msg the message to log.
109: * @param ex the exception to log, including its stack trace.
110: *
111: */
112: void info(String msg, RootException ex);
113:
114: /**
115: * Log a message object with the <i>INFO</i> Level.
116: *
117: * @param channel the log channel to be used for logging.
118: * @param msg the message to log.
119: *
120: */
121: void info(String channel, String msg);
122:
123: /**
124: * Log a message object with the <i>INFO</i> Level.
125: *
126: * @param channel the log channel to be used for logging.
127: * @param msg the message to log.
128: * @param ex the exception to log, including its stack trace.
129: *
130: */
131: void info(String channel, String msg, RootException ex);
132:
133: /**
134: * Log a message object with the <i>DEBUG</i> level.
135: *
136: * @param msg the message to log.
137: *
138: */
139: void debug(String msg);
140:
141: /**
142: * Log a message object with the <i>DEBUG</i> level.
143: *
144: * @param msg the message to log.
145: * @param ex the exception to log, including its stack trace.
146: *
147: */
148: void debug(String msg, RootException ex);
149:
150: /**
151: * Log a message object with the <i>DEBUG</i> level.
152: *
153: * @param channel the log channel to be used for logging.
154: * @param msg the message to log.
155: *
156: */
157: void debug(String channel, String msg);
158:
159: /**
160: * Log a message object with the <i>DEBUG</i> level.
161: *
162: * @param channel the log channel to be used for logging.
163: * @param msg the message to log.
164: * @param ex the exception to log, including its stack trace.
165: *
166: */
167: void debug(String channel, String msg, RootException ex);
168:
169: }
|