This repository has been archived by the owner on Sep 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 573
/
INSTALL
126 lines (89 loc) · 3.8 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
===========
Using log4j
===========
1) First untar or unzip the distribution file.
2) Assuming you chose to extract the distribution in to the
PATH_OF_YOUR_CHOICE, untarring the distribution file should create
a logging-log4j-VERSION directory, where VERSION is the log4j
version number, under PATH_OF_YOUR_CHOICE. We will refer to the
directory PATH_OF_YOUR_CHOICE/logging-log4j-VERSION/ as $LOG4J_HOME/.
3) Assuming you are using log4j version 1.2, add
$LOG4J_HOME/dist/lib/log4j-1.2.jar to your CLASSPATH,
4) You can now test your installation by first compiling the following
simple program.
import org.apache.log4j.Logger;
import org.apache.log4j.BasicConfigurator;
public class Hello {
static Logger logger = Logger.getLogger(Hello.class);
public
static
void main(String argv[]) {
BasicConfigurator.configure();
logger.debug("Hello world.");
logger.info("What a beatiful day.");
}
}
After compilation, try it out by issuing the command
java Hello
You should see log statements appearing on the console.
5) Refer to the javadoc documentation and the user manual on how to
include log statements in your own code.
=========
JAR files
=========
The log4j distribution comes with one jar file: log4j-VERSION.jar
under the LOG4J_HOME/dist/lib/ directory.
This jar file contains all the class files of the log4j project,
except test cases and classes from the "examples" and
"org.apache.log4j.performance" packages.
==================
log4j dependencies
==================
Log4j targets JDK 1.2 or later with the following additional requirements:
----------------------------
Package org.apache.log4j.xml
----------------------------
The DOMConfigurator is based on the DOM Level 1 API. The
DOMConfigurator.configure(Element) method will work with any
XML parser that will pass it a DOM tree.
The DOMConfigurator.configure(String filename) method and its variants
require a JAXP compatible XMLparser, for example the Apache Xerces
parser. Compiling the DOMConfigurator requires the presence of a
JAXP parser in the classpath.
------------
SMTPAppender
------------
The SMTPAppender relies on the JavaMail API. It has been tested with
JavaMail API version 1.2. The JavaMail API requires the
JavaBeans Activation Framework package. You can download the
JavaMail API at:
http://java.sun.com/products/javamail/
and the JavaBeans Activation Framework at:
http://java.sun.com/beans/glasgow/jaf.html
-----------
JMSAppender
-----------
The JMSAppender requires the JMS API as well as JNDI. The JMS API
is usually bundled with the products of the vendors listed under
http://java.sun.com/products/jms/vendors.html
-----------------------
JUnit testing framework
-----------------------
Log4j uses the JUnit framework version 3.8.1 for internal unit
testing. If you want to compile the source code in the tests/
directory, then you will need JUnit. JUnit is available from:
http://www.junit.org
==============
Building log4j
==============
Like most Java applications today, log4j relies on ANT as its build
tool. ANT is available from "http://ant.apache.org/". ANT
requires a build file called build.xml which is part of this
distribution. Required components from other projects are specified in
the build.properties and example of which is supplied in the
build.properties.sample file.
In case of problems send an e-mail note to
log4j-user@logging.apache.org. Please do not directly e-mail any
log4j developers. The answer to your question might be useful to other
users. Moreover, there are many knowledgeable users on the log4j-user
mailing lists who can quickly answer your questions.