Package 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
    2. PlainConfigurator - uses the old style strings UDP:FRAG: etc etc
    Version:
    $Id: ConfiguratorFactory.java,v 1.23 2007/06/06 11:02:35 belaban Exp $
    Author:
    Filip Hanik (filip@filip.net), Bela Ban

    • Field Detail

      • JAXP_MISSING_ERROR_MSG

        public static final java.lang.String JAXP_MISSING_ERROR_MSG
        See Also:
        Constant Field Values

    • Constructor Detail

      • ConfiguratorFactory

        protected ConfiguratorFactory()

    • Method Detail

      • getStackConfigurator

        public static ProtocolStackConfigurator getStackConfigurator​(java.io.File file)
                                                      throws ChannelException
        Returns a protocol stack configurator based on the XML configuration provided by the specified File.
        Parameters:
        file - a File with 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​(java.net.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.

      • getStackConfigurator

        public static ProtocolStackConfigurator getStackConfigurator​(org.w3c.dom.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​(java.lang.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.
        Throws:
        ChannelException

      • getStackConfigurator

        public static ProtocolStackConfigurator getStackConfigurator​(java.lang.Object properties)
                                                      throws java.io.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
        Throws:
        java.io.IOException - if it fails to parse the XML content
        java.io.IOException - if the URL is invalid or a the content can not be reached

      • getConfigStream

        public static java.io.InputStream getConfigStream​(java.io.File file)
                                           throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getConfigStream

        public static java.io.InputStream getConfigStream​(java.net.URL url)
                                           throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getConfigStream

        public static java.io.InputStream getConfigStream​(java.lang.String properties)
                                           throws java.io.IOException
        Returns a JGroups XML configuration InputStream based on the provided properties string.
        Parameters:
        properties - a string representing a system resource containing a JGroups XML configuration, a string representing a URL pointing to a JGroups ML configuration, or a string representing a file name that contains a JGroups XML configuration.
        Throws:
        java.io.IOException - if the provided properties string appears to be a valid URL but is unreachable.

      • getConfigStream

        public static java.io.InputStream getConfigStream​(java.lang.Object properties)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • substituteVariables

        public static void substituteVariables​(ProtocolStackConfigurator configurator)
        Replace variables of the form ${var:default} with the getProperty(var, default)
        Parameters:
        configurator -