patterntesting.runtime.monitor
Interface ClasspathMonitorMBean

All Superinterfaces:

Serializable

All Known Implementing Classes:

ClasspathMonitor

@Description(value="Classpath Monitor to be able to inspect the classpath and to find doublets")
public interface ClasspathMonitorMBean
extends Serializable

All the methods which might help you to find classpath problems are collected in this JMX interface. Most of the methods returns a String because this can be easily shown in the JConsole.

Version:

$Revision: 1.8 $

Author:

oliver

Method Summary

void	addMeAsShutdownHook() To be able to register the instance as shutdown hook you can use this (non static) method.
void	dumpMe() This operation dumps the different MBean attributes to a temporary file with the prefix "cpmon" (for ClasspathMonitor) and the extension ".txt".
String[]	getBootClasspath() Gets the boot classpath.
String	getClassloaderInfo() Returns some information about the classloader.
String[]	getClasspath() Gets the normal classpath which is also available by the system property "java.class.path".
String[]	getClasspathClasses() Looks in the normal classpath after all classes and returns it as String array.
URL	getDoublet(String name, int n) Returns the n'th doublet of the given classname or resource
String[]	getDoubletClasspath() Looks for each found doublet in which classpath it was found.
String[]	getDoublets() Looks for each loaded class if it is a doublet or not.
URL	getFirstDoublet(String name) Returns the first doublet of the given classname or resource.
String[]	getIncompatibleClasses() Incompatible classes are doublets with different serialVersionUID.
String[]	getIncompatibleClasspath()
String[]	getLoadedClasses() Returns the classes which were loaded by the classloader.
String[]	getLoadedPackages() Returns the packages which were loaded by the classloader.
String[]	getManifestEntries(String classname) If a MANIFEST is found for a given class the attributes in this file should be returned as a string array.
int	getNoClasses(String classname) Get the number of different versions of the given class.
int	getNoResources(String name) Get number of resources.
Long	getSerialVersionUID(String classname)
String[]	getUnusedClasses() Returns the classes which are not yet loaded.
String[]	getUnusedClasspath() The unused classpath is this path which are not used in past.
String[]	getUsedClasspath() Gets the loaded classpath (without the bootclasspath) as URI array.
boolean	isClassloaderSupported()
boolean	isDoublet(String name) Is the given classname or resource a doublet, e.g. can it be found several times in the classpath?
boolean	isLoaded(String classname) Is the given classname already loaded?
boolean	isMultiThreadingEnabled() Is multi threading enabled?
boolean	isShutdownHook() Here you can ask if the ClasspathMonitor was already registeres ad shutdown hook.
void	logMe() Prints the different MBean attributes to the log output.
void	removeMeAsShutdownHook() If you want to unregister the instance as shutdown hook you can use this method.
void	setMultiThreadingEnabled(boolean enabled) Here you can enable or disable the multi threading mode.
URI	whichClass(String name) Looks if the given classname can be found in the classpath.
URI	whichResource(String name) Looks if the given resource can be found in the classpath.

Method Detail

whichResource

@Description(value="returns the URI of the given resource")
URI whichResource(String name)

Looks if the given resource can be found in the classpath.
To avoid problems like "java.rmi.UnmarshalException: failed to unmarshal class java.lang.Object; nested exception is: java.io.IOException: unknown protocol: zip" no longer a URL but URI is now returned

Parameters:

name - of a resource e.g. "log4j.properties"

Returns:

URI of the given resource (or null if resource was not found)

whichClass

@Description(value="return the URI if the given class")
URI whichClass(String name)

Looks if the given classname can be found in the classpath.
To avoid problems like "java.rmi.UnmarshalException: failed to unmarshal class java.lang.Object; nested exception is: java.io.IOException: unknown protocol: zip" no longer a URL but URI is now returned

Parameters:

name - of a class e.g. "java.lang.String"

Returns:

URI of the given resource (or null if resource was not found)

getNoResources

@Description(value="how often the given resource is found in the classpath")
int getNoResources(String name)

Get number of resources.

Parameters:

name - of the resource

Returns:

how often the resource was found

getNoClasses

@Description(value="how often the given class is found in the classpath")
int getNoClasses(String classname)

Get the number of different versions of the given class.

Parameters:

classname - the name of the class

Returns:

how often the classname was found in the classpath

isDoublet

@Description(value="is the given classname or resource found more than once in the classpath?")
boolean isDoublet(String name)
                  throws NoSuchElementException

Is the given classname or resource a doublet, e.g. can it be found several times in the classpath? If the classname or resource is not in the classpath a java.util.NoSuchElementException will be thrown.

Parameters:

name - a classname or resource

Returns:

true if more than one classname or resource was found in the classpath

Throws:

NoSuchElementException - if no classname or resource was found

getFirstDoublet

@Description(value="returns the first doublet of the given classname or resource")
URL getFirstDoublet(String name)

Returns the first doublet of the given classname or resource.

Parameters:

name - a classname or resource

Returns:

the first doublet

getDoublets

@Description(value="returns a sorted array of all found doublets")
String[] getDoublets()

Looks for each loaded class if it is a doublet or not.

Returns:

a sorted array with the found doublets

getDoubletClasspath

@Description(value="returns the classpath where doublets were found")
String[] getDoubletClasspath()

Looks for each found doublet in which classpath it was found.

Returns:

the classpath where doublets were found

getDoublet

@Description(value="returns the n\'th doublet of the given classname or resource")
URL getDoublet(String name,
                                int n)

Returns the n'th doublet of the given classname or resource

Parameters:

name - a classname or resource

n - number of wanted doublet

Returns:

the n'th doublet URL

getLoadedPackages

@Description(value="returns an array of all loaded packages")
String[] getLoadedPackages()

Returns the packages which were loaded by the classloader. The loaded packages are returned as string array so that it can be displayed by the 'jconsole'.

Returns:

the packages as string array

getLoadedClasses

@Description(value="returns an array of all loaded classes")
String[] getLoadedClasses()

Returns the classes which were loaded by the classloader. The loaded packages are returned as string array so that it can be displayed by the 'jconsole'.

Returns:

the classes as string array

isLoaded

@Description(value="is the given classname already loaded?")
boolean isLoaded(String classname)

Is the given classname already loaded?

Parameters:

classname - the name of the class

Returns:

true if given classname is already loaded

getUnusedClasses

@Description(value="returns all classes which are not yet loaded")
String[] getUnusedClasses()

Returns the classes which are not yet loaded. These are the classes returned by getClasspathClasses() but not by getLoadedClasses().

Returns:

the classes which are not yet loaded

getUsedClasspath

@Description(value="returns the classpath with the loaded classes")
String[] getUsedClasspath()

Gets the loaded classpath (without the bootclasspath) as URI array.

Returns:

the loaded classpath (sorted)

getUnusedClasspath

@Description(value="returns the classpath which were not yet used")
String[] getUnusedClasspath()

The unused classpath is this path which are not used in past.

Returns:

the unused classpath (sorted)

getBootClasspath

@Description(value="return ths boot classpath")
String[] getBootClasspath()

Gets the boot classpath.

Returns:

boot classpath

getClasspath

@Description(value="returns the complete classpath which is seen by the application")
String[] getClasspath()

Gets the normal classpath which is also available by the system property "java.class.path".

Returns:

the classpath as String array

getClasspathClasses

@Description(value="returns all classes of the classpath")
String[] getClasspathClasses()

Looks in the normal classpath after all classes and returns it as String array.

Returns:

all found classes in the classpath

getSerialVersionUID

@Description(value="returns the servialSerialVersionUID of the given class")
Long getSerialVersionUID(String classname)
                         throws IllegalAccessException

Parameters:

classname - the name of the class

Returns:

the serialVersionUID of the given class (or null if the class does not have one)

Throws:

IllegalAccessException - e.g. if there is no SerialVersionUID

getManifestEntries

@Description(value="return the manifest entries for the given class")
String[] getManifestEntries(String classname)

If a MANIFEST is found for a given class the attributes in this file should be returned as a string array. E.g. for commons-lang-2.3.jar the string array may looks like

 Manifest-Version: 1.0
 Ant-Version: Apache Ant 1.6.5
 Created-By: 1.3.1_09-85 ("Apple Computer, Inc.")
 Package: org.apache.commons.lang
 Extension-Name: commons-lang
 Specification-Version: 2.3
 Specification-Vendor: Apache Software Foundation
 Specification-Title: Commons Lang
 Implementation-Version: 2.3
 Implementation-Vendor: Apache Software Foundation
 Implementation-Title: Commons Lang
 Implementation-Vendor-Id: org.apache
 X-Compile-Source-JDK: 1.3
 X-Compile-Target-JDK: 1.1
 

Parameters:

classname - the name of the class

Returns:

the attribute entries of the Manifest (or emtpy array if no Manifest or no attributes are found)

getIncompatibleClasses

@Description(value="returns the doublet classes with different serialVersionUIDs")
String[] getIncompatibleClasses()

Incompatible classes are doublets with different serialVersionUID.

Returns:

doublet classes with different serialVersionUID

getIncompatibleClasspath

@Description(value="returns the classpath where incompatible classes were found")
String[] getIncompatibleClasspath()

Returns:

the classpathes where incompatible classes were found

isClassloaderSupported

@Description(value="returns true for classloader which are known and tested")
boolean isClassloaderSupported()

Returns:

true if it is a known classloader

getClassloaderInfo

@Description(value="retuns some infos about the found classloader")
String getClassloaderInfo()

Returns some information about the classloader. At least the user should be informed if it is a unknown classloader which is not supported or not tested.

Returns:

e.g. "unknown classloader xxx - classpath can be wrong"

logMe

@Description(value="logs all attributes to the log output")
void logMe()

Prints the different MBean attributes to the log output.

dumpMe

@Description(value="dumps all attributs to the temporary file \'cpmon...txt\'")
void dumpMe()

This operation dumps the different MBean attributes to a temporary file with the prefix "cpmon" (for ClasspathMonitor) and the extension ".txt".

addMeAsShutdownHook

@Description(value="to register ClasspathMonitor as shutdown hook")
void addMeAsShutdownHook()

To be able to register the instance as shutdown hook you can use this (non static) method.

Since:

1.0

removeMeAsShutdownHook

@Description(value="to de-register ClasspathMonitor as shutdown hook")
void removeMeAsShutdownHook()

If you want to unregister the instance as shutdown hook you can use this method.

Since:

1.0

isShutdownHook

@Description(value="returns true if ClasspathMonitor was registered as shutdown hook")
boolean isShutdownHook()

Here you can ask if the ClasspathMonitor was already registeres ad shutdown hook.

Returns:

true if it is registered as shutdown hook.

Since:

1.0

isMultiThreadingEnabled

boolean isMultiThreadingEnabled()

Is multi threading enabled?

Returns:

true if multi threading is enabled for this class.

Since:

0.9.7

setMultiThreadingEnabled

@Description(value="expermimental, don\'t change it!")
void setMultiThreadingEnabled(boolean enabled)

Here you can enable or disable the multi threading mode.

Parameters:

enabled - true, if multithreading should be enabled

Since:

0.9.7