org.jgroups.conf

Class ConfiguratorFactory


public class ConfiguratorFactory
extends java.lang.Object

The ConfigurationFactory is a factory that returns a protocol stack configurator. The protocol stack configurator is an object that read a stack configuration and parses it so that the ProtocolStack can create a stack.
Currently the factory returns one of the following objects:
1. XmlConfigurator - parses XML files that are according to the jgroups-protocol.dtd
2. PlainConfigurator - uses the old style strings UDP:FRAG: etc etc

Version:
1.0

Author:
Filip Hanik (filip@filip.net)

Field Summary

static String
JAXP_MISSING_ERROR_MSG

Constructor Summary

ConfiguratorFactory()

Method Summary

static ProtocolStackConfigurator
getStackConfigurator(Element element)
Returns a protocol stack configurator based on the XML configuration provided by the specified XML element.
static ProtocolStackConfigurator
getStackConfigurator(File file)
Returns a protocol stack configurator based on the XML configuration provided at the specified URL.
static ProtocolStackConfigurator
getStackConfigurator(Object properties)
Deprecated. Used by the JChannel(Object) constructor which has been deprecated.
static ProtocolStackConfigurator
getStackConfigurator(String properties)
Returns a protocol stack configurator based on the provided properties string.
static ProtocolStackConfigurator
getStackConfigurator(URL url)
Returns a protocol stack configurator based on the XML configuration provided at the specified URL.

Field Details

JAXP_MISSING_ERROR_MSG

public static final String JAXP_MISSING_ERROR_MSG

Constructor Details

ConfiguratorFactory

protected ConfiguratorFactory()

Method Details

getStackConfigurator

public static ProtocolStackConfigurator getStackConfigurator(Element element)
            throws ChannelException
Returns a protocol stack configurator based on the XML configuration provided by the specified XML element.

Parameters:
element - a XML element containing a JGroups XML configuration.

Returns:
a ProtocolStackConfigurator containing the stack configuration.

Throws:
ChannelException - if problems occur during the configuration of the protocol stack.


getStackConfigurator

public static ProtocolStackConfigurator getStackConfigurator(File file)
            throws ChannelException
Returns a protocol stack configurator based on the XML configuration provided at the specified URL.

Parameters:

Returns:
a ProtocolStackConfigurator containing the stack configuration.

Throws:
ChannelException - if problems occur during the configuration of the protocol stack.


getStackConfigurator

public static ProtocolStackConfigurator getStackConfigurator(Object properties)
            throws IOException

Deprecated. Used by the JChannel(Object) constructor which has been deprecated.

Returns a protocol stack configurator based on the properties passed in.
If the properties parameter is a plain string UDP:FRAG:MERGE:GMS etc, a PlainConfigurator is returned.
If the properties parameter is a string that represents a url for example http://www.filip.net/test.xml or the parameter is a java.net.URL object, an XmlConfigurator is returned

Parameters:
properties - old style property string, url string, or java.net.URL object

Returns:
a ProtocolStackConfigurator containing the stack configuration


getStackConfigurator

public static ProtocolStackConfigurator getStackConfigurator(String properties)
            throws ChannelException
Returns a protocol stack configurator based on the provided properties string.

Parameters:
properties - an old style property string, a string representing a system resource containing a JGroups XML configuration, a string representing a URL pointing to a JGroups XML XML configuration, or a string representing a file name that contains a JGroups XML configuration.


getStackConfigurator

public static ProtocolStackConfigurator getStackConfigurator(URL url)
            throws ChannelException
Returns a protocol stack configurator based on the XML configuration provided at the specified URL.

Parameters:
url - a URL pointing to a JGroups XML configuration.

Returns:
a ProtocolStackConfigurator containing the stack configuration.

Throws:
ChannelException - if problems occur during the configuration of the protocol stack.


Copyright B) 2001,2002 www.jgroups.com . All Rights Reserved.