public class EnvironmentCheck extends Object
Usage-command line:
java org.apache.xalan.xslt.EnvironmentCheck [-out outFile]
Usage-from program:
boolean environmentOK =
(new EnvironmentCheck()).checkEnvironment(yourPrintWriter);
Usage-from stylesheet:
<?xml version="1.0"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
xmlns:xalan="http://xml.apache.org/xalan"
exclude-result-prefixes="xalan">
<xsl:output indent="yes"/>
<xsl:template match="/">
<xsl:copy-of select="xalan:checkEnvironment()"/>
</xsl:template>
</xsl:stylesheet>
Xalan users reporting problems are encouraged to use this class to see if there are potential problems with their actual Java environment before reporting a bug. Note that you should both check from the JVM/JRE's command line as well as temporarily calling checkEnvironment() directly from your code, since the classpath may differ (especially for servlets, etc).
Also see http://xml.apache.org/xalan-j/faq.html
Note: This class is pretty simplistic: results are not necessarily definitive nor will it find all problems related to environment setup. Also, you should avoid calling this in deployed production code, both because it is quite slow and because it forces classes to get loaded.
Note: This class explicitly has very limited compile-time dependencies to enable easy compilation and usage even when Xalan, DOM/SAX/JAXP, etc. are not present.
Note: for an improved version of this utility, please see the xml-commons' project Which utility which does the same kind of thing but in a much simpler manner.
Modifier and Type | Field and Description |
---|---|
static String |
CLASS_NOTPRESENT
Marker that a class or .jar was not found.
|
static String |
CLASS_PRESENT
Marker that a class or .jar was found.
|
static String |
ERROR
Prefixed to hash keys that signify serious problems.
|
static String |
ERROR_FOUND
Value for any error found.
|
static String |
FOUNDCLASSES
Prefixed to hash keys that signify .jars found in classpath.
|
String[] |
jarNames
Listing of common .jar files that include Xalan-related classes.
|
protected PrintWriter |
outWriter
Simple PrintWriter we send output to; defaults to System.out.
|
static String |
VERSION
Prefixed to hash keys that signify version numbers.
|
static String |
WARNING
Added to descriptions that signify potential problems.
|
Constructor and Description |
---|
EnvironmentCheck() |
Modifier and Type | Method and Description |
---|---|
void |
appendEnvironmentReport(Node container,
Document factory,
Hashtable h)
Stylesheet extension entrypoint: Dump a basic Xalan
environment report from getEnvironmentHash() to a Node.
|
protected boolean |
appendFoundJars(Node container,
Document factory,
Vector v,
String desc)
Print out report of .jars found in a classpath.
|
protected void |
checkAntVersion(Hashtable h)
Report product version information from Ant.
|
protected void |
checkDOMVersion(Hashtable h)
Report version info from DOM interfaces.
|
boolean |
checkEnvironment(PrintWriter pw)
Programmatic entrypoint: Report on basic Java environment
and CLASSPATH settings that affect Xalan.
|
protected void |
checkJAXPVersion(Hashtable h)
Report version information about JAXP interfaces.
|
protected void |
checkParserVersion(Hashtable h)
Report product version information from common parsers.
|
protected Vector |
checkPathForJars(String cp,
String[] jars)
Cheap-o listing of specified .jars found in the classpath.
|
protected void |
checkProcessorVersion(Hashtable h)
Report product version information from Xalan-J.
|
protected void |
checkSAXVersion(Hashtable h)
Report version info from SAX interfaces.
|
protected void |
checkSystemProperties(Hashtable h)
Fillin hash with info about SystemProperties.
|
protected String |
getApparentVersion(String jarName,
long jarSize)
Cheap-o method to determine the product version of a .jar.
|
Hashtable |
getEnvironmentHash()
Fill a hash with basic environment settings that affect Xalan.
|
protected boolean |
logFoundJars(Vector v,
String desc)
Print out report of .jars found in a classpath.
|
protected void |
logMsg(String s)
Bottleneck output: calls outWriter.println(s).
|
static void |
main(String[] args)
Command line runnability: checks for [-out outFilename] arg.
|
protected boolean |
writeEnvironmentReport(Hashtable h)
Dump a basic Xalan environment report to outWriter.
|
public static final String ERROR
public static final String WARNING
public static final String ERROR_FOUND
public static final String VERSION
public static final String FOUNDCLASSES
public static final String CLASS_PRESENT
public static final String CLASS_NOTPRESENT
public String[] jarNames
protected PrintWriter outWriter
public static void main(String[] args)
Command line entrypoint; Sets output and calls
checkEnvironment(PrintWriter)
.
args
- command line argspublic boolean checkEnvironment(PrintWriter pw)
Note that this class is not advanced enough to tell you everything about the environment that affects Xalan, and sometimes reports errors that will not actually affect Xalan's behavior. Currently, it very simplistically checks the JVM's environment for some basic properties and logs them out; it will report a problem if it finds a setting or .jar file that is likely to cause problems.
Advanced users can peruse the code herein to help them investigate potential environment problems found; other users may simply send the output from this tool along with any bugs they submit to help us in the debugging process.
pw
- PrintWriter to send output to; can be sent to a
file that will look similar to a Properties file; defaults
to System.out if nullgetEnvironmentHash()
public Hashtable getEnvironmentHash()
Worker method called from various places.
Various system and CLASSPATH, etc. properties are put into
the hash as keys with a brief description of the current state
of that item as the value. Any serious problems will be put in
with a key that is prefixed with 'ERROR.'
so it
stands out in any resulting report; also a key with just that
constant will be set as well for any error.
Note that some legitimate cases are flaged as potential errors - namely when a developer recompiles xalan.jar on their own - and even a non-error state doesn't guaruntee that everything in the environment is correct. But this will help point out the most common classpath and system property problems that we've seen.
protected boolean writeEnvironmentReport(Hashtable h)
This dumps a simple header and then each of the entries in the Hashtable to our PrintWriter; it does special processing for entries that are .jars found in the classpath.
h
- Hashtable of items to report on; presumably
filled in by our various check*() methodsfor an equivalent that appends to a Node instead
protected boolean logFoundJars(Vector v, String desc)
v
- Vector of Hashtables of .jar file infodesc
- description to print out in headercheckPathForJars(String, String[])
public void appendEnvironmentReport(Node container, Document factory, Hashtable h)
Copy of writeEnvironmentReport that creates a Node suitable for other processing instead of a properties-like text output.
container
- Node to append our report tofactory
- Document providing createElement, etc. servicesh
- Hash presumably from getEnvironmentHash()
for an equivalent that writes to a PrintWriter instead
protected boolean appendFoundJars(Node container, Document factory, Vector v, String desc)
container
- Node to append our report tofactory
- Document providing createElement, etc. servicesv
- Vector of Hashtables of .jar file infodesc
- description to print out in headercheckPathForJars(String, String[])
protected void checkSystemProperties(Hashtable h)
h
- Hashtable to put information injarNames
,
checkPathForJars(String, String[])
protected Vector checkPathForJars(String cp, String[] jars)
cp
- classpath to searchjars
- array of .jar base filenames to look forjarNames
,
logFoundJars(Vector, String)
,
appendFoundJars(Node, Document, Vector, String )
,
getApparentVersion(String, long)
protected String getApparentVersion(String jarName, long jarSize)
jarName
- base filename of the .jarfilejarSize
- size of the .jarfileprotected void checkJAXPVersion(Hashtable h)
h
- Hashtable to put information inprotected void checkProcessorVersion(Hashtable h)
h
- Hashtable to put information inprotected void checkParserVersion(Hashtable h)
h
- Hashtable to put information inprotected void checkAntVersion(Hashtable h)
h
- Hashtable to put information inprotected void checkDOMVersion(Hashtable h)
h
- Hashtable to put information inprotected void checkSAXVersion(Hashtable h)
h
- Hashtable to put information inprotected void logMsg(String s)
s
- String to printCopyright © 2018 JBoss by Red Hat. All rights reserved.