org.jgroups.conf
Class ClassConfigurator

java.lang.Object
  org.jgroups.conf.ClassConfigurator

public class ClassConfigurator
extends java.lang.Object

This class will be replaced with the class that read info from the magic number configurator that reads info from the xml file. The name and the relative path of the magic number map file can be specified as value of the property org.jgroups.conf.magicNumberFile. It must be relative to one of the classpath elements, to allow the classloader to locate the file. If a value is not specified, MagicNumberReader.MAGIC_NUMBER_FILE is used, which defaults to "jg-magic-map.xml".

Author:

Filip Hanik, Bela Ban

See Also:

MagicNumberReader

Field Summary

protected static org.apache.commons.logging.Log

log

Constructor Summary

ClassConfigurator()

Method Summary

static void	add(short magic, java.lang.Class clazz) Method to register a user-defined header with jg-magic-map at runtime
static java.lang.Class	get(short magic) Returns a class for a magic number.
static java.lang.Class	get(java.lang.String clazzname) Loads and returns the class from the class name
static short	getMagicNumber(java.lang.Class clazz) Returns the magic number for the class.
protected static void	init()
static java.lang.String	printClassMap()
static java.lang.String	printMagicMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

protected static final org.apache.commons.logging.Log log

Constructor Detail

ClassConfigurator

public ClassConfigurator()

Method Detail

init

protected static void init()
                    throws ChannelException

Throws:

ChannelException

add

public static void add(short magic,
                       java.lang.Class clazz)
                throws java.lang.IllegalArgumentException

Method to register a user-defined header with jg-magic-map at runtime

Parameters:

magic - The magic number. Needs to be > 1024

clazz - The class. Usually a subclass of Header

Throws:

java.lang.IllegalArgumentException - If the magic number is already taken, or the magic number is <= 1024

get

public static java.lang.Class get(short magic)

Returns a class for a magic number. Returns null if no class is found

Parameters:

magic - the magic number that maps to the class

Returns:

a Class object that represents a class that implements java.io.Externalizable

get

public static java.lang.Class get(java.lang.String clazzname)

Loads and returns the class from the class name

Parameters:

clazzname - a fully classified class name to be loaded

Returns:

a Class object that represents a class that implements java.io.Externalizable

getMagicNumber

public static short getMagicNumber(java.lang.Class clazz)

Returns the magic number for the class.

Parameters:

clazz - a class object that we want the magic number for

Returns:

the magic number for a class, -1 if no mapping is available

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

printMagicMap

public static java.lang.String printMagicMap()

printClassMap

public static java.lang.String printClassMap()