Package org.jgroups.conf

Class ProtocolConfiguration

java.lang.Object

org.jgroups.conf.ProtocolConfiguration

public class ProtocolConfiguration
extends Object

Parses and encapsulates the specification for 1 protocol of the protocol stack, e.g. UNICAST(timeout=5000)

Field Summary

Fields

Modifier and Type	Field	Description
private final ClassLoader	loader
private final Map<String,String>	properties
private String	properties_str
private final String	protocol_name
private List<XmlNode>	subtrees

Constructor Summary

Constructors

Constructor	Description
ProtocolConfiguration(String config_str)	Creates a new ProtocolConfiguration.
ProtocolConfiguration(String protocol_name, Map<String,String> properties)
ProtocolConfiguration(String protocol_name, Map<String,String> properties, ClassLoader loader)

Method Summary

Modifier and Type	Method	Description
void	addSubtree(XmlNode node)
ClassLoader	getClassLoader()
protected static String	getParameterString(String name, String value)
protected static String	getParameterStringXml(String name, String val)
Map<String,String>	getProperties()
String	getProtocolName()
String	getProtocolString()
String	getProtocolString(boolean new_format)
String	getProtocolStringNewXml()
List<XmlNode>	getSubtrees()
boolean	isAssignableProtocol(Class<? extends Protocol> other, Class<?> loadingClass)	Determines if the class other is the same or superclass (or superinterface) as the Protocol configured by this instance.
Class<? extends Protocol>	loadProtocolClass(Class<?> loadingClass)	Load the class of the Protocol configured by this instance.
protected void	parsePropertiesString(Map<String,String> properties)
String	propertiesToString()
void	substituteVariables()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

protocol_name

private final String protocol_name

loader

private final ClassLoader loader

properties_str

private String properties_str

properties

private final Map<String,String> properties

subtrees

private List<XmlNode> subtrees

Constructor Details

ProtocolConfiguration

public ProtocolConfiguration(String config_str)
                      throws Exception

Creates a new ProtocolConfiguration.

Parameters:

config_str - The configuration specification for the protocol, e.g.

VERIFY_SUSPECT(timeout=1500)

Throws:

Exception

ProtocolConfiguration

public ProtocolConfiguration(String protocol_name,
 Map<String,String> properties)

ProtocolConfiguration

public ProtocolConfiguration(String protocol_name,
 Map<String,String> properties,
 ClassLoader loader)

Method Details

addSubtree

public void addSubtree(XmlNode node)

getSubtrees

public List<XmlNode> getSubtrees()

getProtocolName

public String getProtocolName()

getClassLoader

public ClassLoader getClassLoader()

getProperties

public Map<String,String> getProperties()

loadProtocolClass

public Class<? extends Protocol> loadProtocolClass(Class<?> loadingClass)
                                            throws Exception

Load the class of the Protocol configured by this instance.

Parameters:

loadingClass - The Class to fetch the preferred ClassLoader. It can be null.

Returns:

The Class of the Protocol.

Throws:

Exception - If unable to find or load the class.

isAssignableProtocol

public boolean isAssignableProtocol(Class<? extends Protocol> other,
 Class<?> loadingClass)
                             throws Exception

Determines if the class other is the same or superclass (or superinterface) as the Protocol configured by this instance.

Parameters:

other - The Class to check.

loadingClass - The Class to fetch the preferred ClassLoader. It can be null.

Returns:

true if other is the same or superclass/interface as the Protocol configured by this instance.

Throws:

Exception - If unable to find or load the class.

substituteVariables

public void substituteVariables()

toString

public String toString()

Overrides:

toString in class Object

propertiesToString

public String propertiesToString()

getProtocolString

public String getProtocolString(boolean new_format)

getProtocolString

public String getProtocolString()

getProtocolStringNewXml

public String getProtocolStringNewXml()

getParameterString

protected static String getParameterString(String name,
 String value)

getParameterStringXml

protected static String getParameterStringXml(String name,
 String val)

parsePropertiesString

protected void parsePropertiesString(Map<String,String> properties)
                              throws Exception

Throws:

Exception