KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > pluto > portlet > admin > PlutoAdminLogger


1 /*
2  * Copyright 2003,2004,2005 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.pluto.portlet.admin;
17
18 import org.apache.commons.logging.Log;
19 import org.apache.commons.logging.LogFactory;
20
21 /**
22  * Class containing convenience logging methods.
23  *
24  * @author Craig Doremus
25  *
26  */
27 public class PlutoAdminLogger {
28     private static Log _log = LogFactory.getLog(PlutoAdminLogger.class);
29     private static final String JavaDoc MSG_SEP = " | ";
30
31
32     /**
33      * Default constructor.
34      *
35      */
36     private PlutoAdminLogger() {
37     }
38
39
40     public static void logMethodStart(String JavaDoc className, String JavaDoc methodName) {
41         if (_log.isInfoEnabled()) {
42             _log.info(getLogMessage(className, methodName, "Start of method . . ."));
43         }
44     }
45
46     public static void logMethodEnd(String JavaDoc className, String JavaDoc methodName) {
47         if (_log.isInfoEnabled()) {
48             _log.info(getLogMessage(className, methodName, ". . .end of method"));
49         }
50     }
51
52     public static void logMethodEnd(String JavaDoc className, String JavaDoc methodName, Object JavaDoc retVal) {
53         if (_log.isInfoEnabled()) {
54             _log.info(getLogMessage(className, methodName, ". . .end of method with return value = " + (retVal == null ? "null" : retVal.toString())));
55         }
56     }
57
58     public static void logParam(String JavaDoc className, String JavaDoc methodName, String JavaDoc paramName, Object JavaDoc paramVal) {
59         if (_log.isInfoEnabled()) {
60             _log.info(getLogMessage(className, methodName, "Parameter '" + paramName + "' has value=" + (paramVal == null ? "null" : paramVal.toString())));
61         }
62     }
63
64     public static void logParam(String JavaDoc className, String JavaDoc methodName, String JavaDoc paramName, int paramVal) {
65         if (_log.isInfoEnabled()) {
66             _log.info(getLogMessage(className, methodName, "Parameter '" + paramName + "' has value=" + paramVal));
67         }
68     }
69
70     public static void logParam(String JavaDoc className, String JavaDoc methodName, String JavaDoc paramName, boolean paramVal) {
71         if (_log.isInfoEnabled()) {
72             _log.info(getLogMessage(className, methodName, "Parameter '" + paramName + "' has value=" + (paramVal ? "true" : "false")));
73         }
74     }
75
76     public static void logVar(String JavaDoc className, String JavaDoc methodName, String JavaDoc varName, Object JavaDoc varVal) {
77         if (_log.isDebugEnabled()) {
78             _log.debug(getLogMessage(className, methodName, "Variable '" + varName + "' has value=" + (varVal == null ? "null" : varVal.toString())));
79         }
80     }
81
82     public static void logVar(String JavaDoc className, String JavaDoc methodName, String JavaDoc varName, int varVal) {
83         if (_log.isDebugEnabled()) {
84             _log.debug(getLogMessage(className, methodName, "Variable '" + varName + "' has value=" + varVal));
85         }
86     }
87
88     public static void logVar(String JavaDoc className, String JavaDoc methodName, String JavaDoc varName, boolean varVal) {
89         if (_log.isDebugEnabled()) {
90             _log.debug(getLogMessage(className, methodName, "Variable '" + varName + "' has value=" + (varVal ? "true" : "false")));
91         }
92     }
93
94     public static void logDebug(String JavaDoc className, String JavaDoc methodName, String JavaDoc msg) {
95         if (_log.isDebugEnabled()) {
96             _log.debug(getLogMessage(className, methodName, msg));
97         }
98     }
99
100     public static void logWarn(String JavaDoc className, String JavaDoc methodName, String JavaDoc msg) {
101         if (_log.isWarnEnabled()) {
102             _log.warn(getLogMessage(className, methodName, msg));
103         }
104     }
105
106     public static void logError(String JavaDoc className, String JavaDoc methodName, String JavaDoc msg, Throwable JavaDoc e) {
107         if (_log.isErrorEnabled()) {
108             _log.error(getLogMessage(className, methodName, msg), e);
109         }
110     }
111
112     public static void logError(String JavaDoc className, String JavaDoc methodName, Throwable JavaDoc e) {
113         if (_log.isErrorEnabled()) {
114             _log.error(getLogMessage(className, methodName, e != null ? e.toString() : ""), e);
115         }
116     }
117
118     public static void logError(String JavaDoc className, String JavaDoc methodName, String JavaDoc msg) {
119         if (_log.isErrorEnabled()) {
120             _log.error(getLogMessage(className, methodName, msg));
121         }
122     }
123
124     private static String JavaDoc getLogMessage(String JavaDoc className, String JavaDoc methodName, String JavaDoc msg) {
125         StringBuffer JavaDoc retMsg = new StringBuffer JavaDoc();
126         if (className == null) {
127             throw new IllegalStateException JavaDoc("Null class name. Please set class name in the constructor.");
128         }
129         if (methodName == null) {
130             throw new IllegalArgumentException JavaDoc("Null method name.");
131         }
132 // if (_logId != null) {
133 // retMsg.append(_logId);
134 // retMsg.append(MSG_SEP);
135 // }
136 retMsg.append(className);
137         retMsg.append(".");
138         retMsg.append(methodName);
139         retMsg.append(MSG_SEP);
140         retMsg.append(msg == null ? "" : msg);
141         return retMsg.toString();
142     }
143 }
144
Popular Tags