View Javadoc
1 /* ====================================================================
2 * License:
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
14 * distribution.
15 *
16 * 3. The end-user documentation included with the redistribution,
17 * if any, must include the following acknowledgment:
18 * "This product includes software developed by
19 * Robert Half International (http://www.rhi.com/)."
20 * Alternately, this acknowledgment may appear in the software itself,
21 * if and wherever such third-party acknowledgments normally appear.
22 *
23 * 4. The names "Parc", "RHI", and "Robert Half International" must
24 * not be used to endorse or promote products derived from this
25 * software without prior written permission. For written
26 * permission, please contact pete.mckinstry@rhi.com.
27 *
28 * 5. Products derived from this software may not be called "PARC",
29 * nor may "PARC" appear in their name, without prior written
30 * permission of Robert Half International.
31 *
32 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
33 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
35 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
36 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
38 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
39 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
40 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
41 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
42 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 * SUCH DAMAGE.
44 * ====================================================================
45 *
46 */
47 package com.rhi.architecture.logging;
48
49 import com.rhi.architecture.config.ConfigurationException;
50 import com.rhi.architecture.resource.Resource;
51
52 /***
53 * LogFactory - create Factory for a certain logging library.
54 *
55 * @author Pete McKinstry
56 * @version 1.0
57 */
58 public abstract class LogFactory implements Resource {
59
60 /***
61 * key used by ResourceContext to find LogFactory type & used by clients
62 * to retrieve the currently loaded LogFactory.
63 */
64 public static final String KEY = "Resource.LogFactory";
65
66 /***
67 * Get default logger. This method exists to support backward
68 * compatibility prior to the factory class. Prefer
69 * getLogger(String type) instead.
70 *
71 * @return Logger
72 * @throws ConfigurationException
73 */
74 public abstract Logger getDefaultLogger()
75 throws ConfigurationException;
76
77 /***
78 * Get a logger instance for the provided type.
79 *
80 * @param type
81 * @return Logger
82 * @throws ConfigurationException
83 */
84 public abstract Logger getLogger(String type)
85 throws ConfigurationException;
86
87 /***
88 * Get a logger instance for the provided type.
89 *
90 * @param type
91 * @return Logger
92 * @throws ConfigurationException
93 */
94 public Logger getLogger(Class type) throws ConfigurationException {
95 return getLogger(type.getName());
96 }
97
98
99 /***
100 * Get a LogFactory based on the implementation class name
101 * provided as a parameter.
102 *
103 * @param factoryImpl - the class name (fully qualified
104 * for the LogFactory sub-class that implements the provided
105 * functionality.
106 * @return LogFactory
107 * @throws ConfigurationException
108 *
109 * @since 1.0
110 */
111 public static LogFactory getFactory(String factoryImpl)
112 throws ConfigurationException {
113 LogFactory factory = null;
114 try {
115 if (factoryImpl == null) {
116 throw new ConfigurationException("LogFactory className == null");
117 }
118 Class type = Class.forName(factoryImpl);
119 Object obj = type.newInstance();
120 factory = (LogFactory) obj;
121 }
122 catch (ClassCastException cce) {
123 throw new ConfigurationException(
124 "LogFactory.getFactory(): "
125 + "LogFactory class name is not a LogFactory sub-class.",
126 cce);
127 }
128 catch (ClassNotFoundException cnfe) {
129 throw new ConfigurationException(
130 "LogFactory.getFactory(): "
131 + "LogFactory implementation class not found in classpath.",
132 cnfe);
133 }
134 catch (InstantiationException ie) {
135 throw new ConfigurationException(
136 "LogFactory.getFactory(): "
137 + "No default constructor for LogFactory",
138 ie);
139 }
140 catch (IllegalAccessException iae) {
141 throw new ConfigurationException(
142 "LogFactory.getFactory(): "
143 + "Cannot invoke default constructor on LogFactory. "
144 + "Check that it's visibility is public.",
145 iae);
146 }
147 return factory;
148 }
149
150 }
This page was automatically generated by Maven