KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > portlet > PortletLog


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Apache" and "Apache Software Foundation" and
27  * "Apache Jetspeed" must not be used to endorse or promote products
28  * derived from this software without prior written permission. For
29  * written permission, please contact apache@apache.org.
30  *
31  * 5. Products derived from this software may not be called "Apache" or
32  * "Apache Jetspeed", nor may "Apache" appear in their name, without
33  * prior written permission of the Apache Software Foundation.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Apache Software Foundation. For more
51  * information on the Apache Software Foundation, please see
52  * <http://www.apache.org/>.
53  */
54
55 package org.apache.jetspeed.portlet;
56
57 /**
58  ** The <CODE>PortletLog</CODE> provides the portlet with the ability
59  ** to log information, warning, or error texts. The log is
60  ** maintained by the portlet container. The type and location of
61  ** of the log is a matter of implementation. Also, whether logging
62  ** is enabled or not is at the discretion of the portlet container.
63  **
64  ** <PRE>
65  ** ...
66  **
67  ** PortletLog log = iContext.getLog ();
68  **
69  ** if (log.isWarnEnabled())
70  ** log.warn ("Can access the content source");
71  **
72  ** ...
73  ** </PRE>
74  **
75  ** @author <A HREF="mailto:tboehme@us.ibm.com">Thomas F. Boehme</A>
76  **/
77
78 public interface PortletLog
79 {
80
81     /**
82      ** Returns whether the debug level of the portlet log is enabled.
83      **
84      ** @return <CODE>true</CODE> if the log is enabled, <BR>
85      ** <CODE>false</CODE>
86      **/
87
88     public boolean isDebugEnabled ();
89
90     /**
91      ** Logs the given informational text in the portlet log.
92      **
93      ** @param aText
94      ** the informational text to log
95      **/
96
97     public void debug (String JavaDoc text);
98
99     /**
100      ** Returns whether the info level of the portlet log is enabled.
101      **
102      ** @return <CODE>true</CODE> if the log is enabled, <BR>
103      ** <CODE>false</CODE>
104      **/
105
106     public boolean isInfoEnabled ();
107
108     /**
109      ** Logs the given informational text in the portlet log.
110      **
111      ** @param aText
112      ** the informational text to log
113      **/
114
115     public void info (String JavaDoc text);
116
117     /**
118      ** Returns whether the warn level of the portlet log is enabled.
119      **
120      ** @return <CODE>true</CODE> if the log is enabled, <BR>
121      ** <CODE>false</CODE>
122      **/
123
124     public boolean isWarnEnabled ();
125
126     /**
127      ** Logs the given warning text in the portlet log.
128      **
129      ** @param text
130      ** the warning text to log
131      **/
132
133     public void warn (String JavaDoc text);
134
135     /**
136      ** Returns whether the error level of the portlet log is enabled.
137      **
138      ** @return <CODE>true</CODE> if the log is enabled, <BR>
139      ** <CODE>false</CODE>
140      **/
141
142     public boolean isErrorEnabled ();
143
144     /**
145      ** Logs the given error text in the portlet log.
146      **
147      ** @param text
148      ** the error text to log
149      **
150      ** @see #error(String,Throwable)
151      **/
152
153     public void error (String JavaDoc text);
154
155     /**
156      ** Logs the given error text, cause, and a stack trace in
157      ** the portlet log.
158      **
159      ** @param text
160      ** the error text to log
161      ** @param cause
162      ** the cause for logging
163      **
164      ** @see #error(String)
165      **/
166
167     public void error (String JavaDoc text, Throwable JavaDoc cause);
168 }
169
Popular Tags