LoggingManager


1   package org.enhydra.shark.api.internal.logging;
2   
3   import org.enhydra.shark.api.RootException;
4   import org.enhydra.shark.api.internal.working.CallbackUtilities;
5   
6   /**
7    * LoggingManager handles logging in Shark.
8    *
9    * @author Sasa Bojanic
10   * @author Vladimir Puskas
11   * @author Tanja Jovanovic
12   */
13  public interface LoggingManager {
14    
15     /**
16      * Method configure is called at Shark start up, to configure
17      * implementation of LoggingManager.
18      *
19      * @param cus an instance of CallbackUtilities used to get
20      *            properties for configuring logging in Shark.
21      *
22      * @exception RootException Thrown if configuring doesn't succeed.
23      */
24     void configure (CallbackUtilities cus) throws RootException;
25     
26     /**
27      * Log a message object with the <i>ERROR</i> Level.
28      *
29      * @param msg the message to log.
30      *
31      * @exception RootException If something unexpected happens.
32      *
33      */
34     void error (String   msg) throws RootException;
35     
36     /**
37      * Log a message object with the <i>ERROR</i> Level.
38      *
39      * @param msg the message to log.
40      * @param ex the exception to log, including its stack trace. 
41      *
42      * @exception   RootException If something unexpected happens.
43      *
44      */
45     void error (String   msg, RootException ex) throws RootException;
46     
47     /**
48      * Log a message object with the <i>ERROR</i> Level.
49      *
50      * @param channel the log channel to be used for logging. 
51      * @param msg the message to log.
52      *
53      * @exception   RootException If something unexpected happens.
54      *
55      */
56     void error (String   channel, String   msg) throws RootException;
57     
58     /**
59      * Log a message object with the <i>ERROR</i> Level.
60      *
61      * @param channel the log channel to be used for logging. 
62      * @param msg the message to log.
63      * @param ex the exception to log, including its stack trace. 
64      *
65      * @exception   RootException If something unexpected happens.
66      *
67      */
68     void error (String   channel, String   msg, RootException ex) throws RootException;
69  
70     /**
71      * Log a message object with the <i>WARN</i> Level.
72      *
73      * @param msg the message to log.
74      *
75      * @exception   RootException If something unexpected happens.
76      *
77      */
78     void warn (String   msg) throws RootException;
79  
80     /**
81      * Log a message object with the <i>WARN</i> Level.
82      *
83      * @param msg the message to log.
84      * @param ex the exception to log, including its stack trace. 
85      *
86      * @exception   RootException If something unexpected happens.
87      *
88      */
89     void warn (String   msg, RootException ex) throws RootException;
90  
91     /**
92      * Log a message object with the <i>WARN</i> Level.
93      *
94      * @param channel the log channel to be used for logging. 
95      * @param msg the message to log.
96      *
97      * @exception   RootException If something unexpected happens.
98      *
99      */
100    void warn (String   channel,String   msg) throws RootException;
101 
102    /**
103     * Log a message object with the <i>WARN</i> Level.
104     *
105     * @param channel the log channel to be used for logging. 
106     * @param msg the message to log.
107     * @param ex the exception to log, including its stack trace. 
108     *
109     * @exception   RootException If something unexpected happens.
110     *
111     */
112    void warn (String   channel, String   msg, RootException ex) throws RootException;
113 
114    /**
115     * Log a message object with the <i>INFO</i> Level.
116     *
117     * @param msg the message to log.
118     *
119     * @exception   RootException If something unexpected happens.
120     *
121     */
122    void info (String   msg) throws RootException;
123 
124   /**
125     * Log a message object with the <i>INFO</i> Level.
126     *
127     * @param msg the message to log.
128     * @param ex the exception to log, including its stack trace. 
129     *
130     * @exception   RootException If something unexpected happens.
131     *
132     */
133    void info (String   msg, RootException ex) throws RootException;
134 
135    /**
136     * Log a message object with the <i>INFO</i> Level.
137     *
138     * @param channel the log channel to be used for logging. 
139     * @param msg the message to log.
140     *
141     * @exception   RootException If something unexpected happens.
142     *
143     */
144    void info (String   channel, String   msg) throws RootException;
145 
146    /**
147     * Log a message object with the <i>INFO</i> Level.
148     *
149     * @param channel the log channel to be used for logging. 
150     * @param msg the message to log.
151     * @param ex the exception to log, including its stack trace. 
152     *
153     * @exception   RootException If something unexpected happens.
154     *
155     */
156    void info (String   channel, String   msg, RootException ex) throws RootException;
157 
158    /**
159     * Log a message object with the <i>DEBUG</i> level.
160     *
161     * @param msg the message to log.
162     *
163     * @exception   RootException If something unexpected happens.
164     *
165     */
166    void debug (String   msg) throws RootException;
167 
168    /**
169     * Log a message object with the <i>DEBUG</i> level.
170     *
171     * @param msg the message to log.
172     * @param ex the exception to log, including its stack trace. 
173     *
174     * @exception   RootException If something unexpected happens.
175     *
176     */
177    void debug (String   msg, RootException ex) throws RootException;
178 
179    /**
180     * Log a message object with the <i>DEBUG</i> level.
181     *
182     * @param channel the log channel to be used for logging. 
183     * @param msg the message to log.
184     *
185     * @exception   RootException If something unexpected happens.
186     *
187     */
188    void debug (String   channel, String   msg) throws RootException;
189 
190    /**
191     * Log a message object with the <i>DEBUG</i> level.
192     *
193     * @param channel the log channel to be used for logging. 
194     * @param msg the message to log.
195     * @param ex the exception to log, including its stack trace. 
196     *
197     * @exception   RootException If something unexpected happens.
198     *
199     */
200    void debug (String   channel, String   msg, RootException ex) throws RootException;
201 
202 
203 }
204 
205
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags