org.jgroups

Class JChannelFactory

java.lang.Object

org.jgroups.JChannelFactory

All Implemented Interfaces:

ChannelFactory

Deprecated.

Might get removed in 3.0. Use your own method of injecting channels

@Deprecated
public class JChannelFactory
extends Object
implements ChannelFactory

JChannelFactory creates pure Java implementations of the Channel interface. See JChannel for a discussion of channel properties.

See Also:

JChannelFactory

Constructor Summary

Constructors

Constructor and Description
JChannelFactory() Deprecated. Constructs a JChannelFactory instance that contains no protocol stack configuration.
JChannelFactory(Element properties) Deprecated. Constructs a JChannelFactory instance that utilizes the specified file for protocl stack configuration.
JChannelFactory(File properties) Deprecated. Constructs a JChannelFactory instance that utilizes the specified file for protocl stack configuration.
JChannelFactory(String properties) Deprecated. Constructs a JChannel instance with the protocol stack configuration based upon the specified properties parameter.
JChannelFactory(URL properties) Deprecated. Constructs a JChannelFactory instance that utilizes the specified file for protocl stack configuration.

Method Summary

Modifier and Type	Method and Description
void	clearConfigurations() Deprecated. Removes all configurations
void	create() Deprecated.
Channel	createChannel() Deprecated. Creates a JChannel implementation of the Channel interface using the protocol stack configuration information specfied during construction of an instance of this factory.
Channel	createChannel(Object properties) Deprecated. JChannel's conversion to type-specific construction, and the subsequent deprecation of its JChannel(Object) constructor, necessitate the deprecation of this factory method as well. Type-specific protocol stack configuration should be specfied during construction of an instance of this factory.
Channel	createChannel(String stack_name) Deprecated.
Channel	createMultiplexerChannel(String stack_name, String id) Deprecated. Use a shared transport instead of the multiplexer
Channel	createMultiplexerChannel(String stack_name, String id, boolean register_for_state_transfer, String substate_id) Deprecated. Use a shared transport instead of the multiplexer
void	destroy() Deprecated.
String	dumpChannels() Deprecated.
String	dumpConfiguration() Deprecated.
String	getConfig(String stack_name) Deprecated. Returns the stack configuration as a string (to be fed into new JChannel()).
String	getDomain() Deprecated.
String	getMultiplexerConfig() Deprecated. Use a shared transport instead of the multiplexer
MBeanServer	getServer() Deprecated.
boolean	hasMuxChannel(String stack_name, String id) Deprecated. Use a shared transport instead of the multiplexer
boolean	isExposeChannels() Deprecated.
boolean	isExposeProtocols() Deprecated.
boolean	removeConfig(String stack_name) Deprecated.
void	setDomain(String domain) Deprecated.
void	setExposeChannels(boolean expose_channels) Deprecated.
void	setExposeProtocols(boolean expose_protocols) Deprecated.
void	setMultiplexerConfig(Element properties) Deprecated. Use a shared transport instead of the multiplexer
void	setMultiplexerConfig(Element properties, boolean replace) Deprecated. Use a shared transport instead of the multiplexer
void	setMultiplexerConfig(File file) Deprecated. Use a shared transport instead of the multiplexer
void	setMultiplexerConfig(File file, boolean replace) Deprecated. Use a shared transport instead of the multiplexer
void	setMultiplexerConfig(Object properties) Deprecated. Use a shared transport instead of the multiplexer
void	setMultiplexerConfig(Object properties, boolean replace) Deprecated. Use a shared transport instead of the multiplexer
void	setMultiplexerConfig(String properties) Deprecated. Use a shared transport instead of the multiplexer
void	setMultiplexerConfig(String properties, boolean replace) Deprecated. Use a shared transport instead of the multiplexer
void	setMultiplexerConfig(URL url) Deprecated. Use a shared transport instead of the multiplexer
void	setMultiplexerConfig(URL url, boolean replace) Deprecated. Use a shared transport instead of the multiplexer
void	setServer(MBeanServer server) Deprecated.
void	start() Deprecated.
void	stop() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

JChannelFactory

public JChannelFactory()

Deprecated.

Constructs a JChannelFactory instance that contains no protocol stack configuration.

JChannelFactory

public JChannelFactory(File properties)
                throws ChannelException

Deprecated.

Constructs a JChannelFactory instance that utilizes the specified file for protocl stack configuration.

Parameters:

properties - a file containing a JGroups XML protocol stack configuration.

Throws:

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

JChannelFactory

public JChannelFactory(Element properties)
                throws ChannelException

Deprecated.

Constructs a JChannelFactory instance that utilizes the specified file for protocl stack configuration.

Parameters:

properties - a XML element containing a JGroups XML protocol stack configuration.

Throws:

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

JChannelFactory

public JChannelFactory(URL properties)
                throws ChannelException

Deprecated.

Constructs a JChannelFactory instance that utilizes the specified file for protocl stack configuration.

Parameters:

properties - a URL pointing to a JGroups XML protocol stack configuration.

Throws:

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

JChannelFactory

public JChannelFactory(String properties)
                throws ChannelException

Deprecated.

Constructs a JChannel instance with the protocol stack configuration based upon the specified properties parameter.

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 - if problems occur during the interpretation of the protocol stack configuration.

Method Detail

setMultiplexerConfig

public void setMultiplexerConfig(Object properties)
                          throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Description copied from interface: ChannelFactory

Initializes the factory.

Specified by:

setMultiplexerConfig in interface ChannelFactory

Parameters:

properties -

Throws:

Exception

ChannelException

setMultiplexerConfig

public void setMultiplexerConfig(Object properties,
                                 boolean replace)
                          throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Parameters:

properties -

replace -

Throws:

Exception

setMultiplexerConfig

public void setMultiplexerConfig(File file)
                          throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Description copied from interface: ChannelFactory

Initializes the factory from a file. Example: conf/stacks.xml

Specified by:

setMultiplexerConfig in interface ChannelFactory

Parameters:

file -

Throws:

Exception

ChannelException

setMultiplexerConfig

public void setMultiplexerConfig(File file,
                                 boolean replace)
                          throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Parameters:

file -

replace -

Throws:

Exception

setMultiplexerConfig

public void setMultiplexerConfig(Element properties)
                          throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Specified by:

setMultiplexerConfig in interface ChannelFactory

Parameters:

properties -

Throws:

Exception

setMultiplexerConfig

public void setMultiplexerConfig(Element properties,
                                 boolean replace)
                          throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Parameters:

properties -

replace -

Throws:

Exception

setMultiplexerConfig

public void setMultiplexerConfig(URL url)
                          throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Specified by:

setMultiplexerConfig in interface ChannelFactory

Parameters:

url -

Throws:

Exception

setMultiplexerConfig

public void setMultiplexerConfig(URL url,
                                 boolean replace)
                          throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Parameters:

url -

replace -

Throws:

Exception

setMultiplexerConfig

public void setMultiplexerConfig(String properties)
                          throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Specified by:

setMultiplexerConfig in interface ChannelFactory

Parameters:

properties -

Throws:

Exception

setMultiplexerConfig

public void setMultiplexerConfig(String properties,
                                 boolean replace)
                          throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Parameters:

properties -

replace -

Throws:

Exception

getConfig

public String getConfig(String stack_name)
                 throws Exception

Deprecated.

Returns the stack configuration as a string (to be fed into new JChannel()). Throws an exception if the stack_name is not found. One of the setMultiplexerConfig() methods had to be called beforehand

Returns:

The protocol stack config as a plain string

Throws:

Exception

getMultiplexerConfig

public String getMultiplexerConfig()

Deprecated. Use a shared transport instead of the multiplexer

Returns:

Returns all configurations

clearConfigurations

public void clearConfigurations()

Deprecated.

Removes all configurations

removeConfig

public boolean removeConfig(String stack_name)

Deprecated.

getServer

public MBeanServer getServer()

Deprecated.

setServer

public void setServer(MBeanServer server)

Deprecated.

getDomain

public String getDomain()

Deprecated.

setDomain

public void setDomain(String domain)

Deprecated.

isExposeChannels

public boolean isExposeChannels()

Deprecated.

setExposeChannels

public void setExposeChannels(boolean expose_channels)

Deprecated.

isExposeProtocols

public boolean isExposeProtocols()

Deprecated.

setExposeProtocols

public void setExposeProtocols(boolean expose_protocols)

Deprecated.

createChannel

public Channel createChannel(Object properties)
                      throws ChannelException

Deprecated. JChannel's conversion to type-specific construction, and the subsequent deprecation of its JChannel(Object) constructor, necessitate the deprecation of this factory method as well. Type-specific protocol stack configuration should be specfied during construction of an instance of this factory.

Creates a JChannel implementation of the Channel interface.

Specified by:

createChannel in interface ChannelFactory

Parameters:

properties - the protocol stack configuration information; a null value means use the default protocol stack configuration.

Throws:

ChannelException - if the creation of the channel failed.

createChannel

public Channel createChannel()
                      throws ChannelException

Deprecated.

Creates a JChannel implementation of the Channel interface using the protocol stack configuration information specfied during construction of an instance of this factory.

Specified by:

createChannel in interface ChannelFactory

Throws:

ChannelException - if the creation of the channel failed.

createChannel

public Channel createChannel(String stack_name)
                      throws Exception

Deprecated.

Specified by:

createChannel in interface ChannelFactory

Throws:

Exception

createMultiplexerChannel

public Channel createMultiplexerChannel(String stack_name,
                                        String id)
                                 throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Description copied from interface: ChannelFactory

Creates an implementation of the Channel using a given stack name and registering it under a given identity.

Channel has to be created with a unique application id per stack name.

Provided stack name has to be one of the stacks defined in a property file that was passed to setMultiplexerConfig (e.g conf/stacks.xml). If clients attempt to create a Channel for an undefined stack name or they attempt to register a duplicate Channel per stack an Exception will be thrown.

Specified by:

createMultiplexerChannel in interface ChannelFactory

Parameters:

stack_name -

id -

Returns:

Throws:

Exception

ChannelException

See Also:

Multiplexer, MuxChannel

createMultiplexerChannel

public Channel createMultiplexerChannel(String stack_name,
                                        String id,
                                        boolean register_for_state_transfer,
                                        String substate_id)
                                 throws Exception

Deprecated. Use a shared transport instead of the multiplexer

Description copied from interface: ChannelFactory

Creates an implementation of the Channel using a given stack name and registering it under a given identity.

Channel has to be created with a unique application id per stack name.

Provided stack name has to be one of the stacks defined in a property file that was passed to setMultiplexerConfig (e.g conf/stacks.xml). If clients attempt to create a Channel for an undefined stack name or they attempt to register a duplicate Channel per stack an Exception will be thrown.

Rather than having each multiplexed channel do a separate state transfer clients can bundle state transfers for all channels created with the same ChannelFactory. First of all, clients have to create Channels with register_for_state_transfer set to true. After the last Channel that was created with register_for_state_transfer set to true connects and initiates state transfer the actual state transfer for all such channels from this ChannelFactory is executed.

Using bundled state transfers is especially useful with the FLUSH protocol in a stack. Recall that each state transfer triggers a flush and thus instead of doing a separate flush for each Channel created with this ChannelFactory we execute only one flush for all state transfers.

However, be aware of the implication of asynchronous nature of bundled state transfer with the respect of channel connect. Recall that each Channel after it returns from successful getState method can assume that state is available. In case of bundled state transfer, state will be set only after the last Channel registered for the bundled state transfer connects and executes getState.

Specified by:

createMultiplexerChannel in interface ChannelFactory

Parameters:

stack_name -

id -

register_for_state_transfer -

substate_id -

Returns:

Throws:

Exception

ChannelException

See Also:

Multiplexer, MuxChannel

hasMuxChannel

public boolean hasMuxChannel(String stack_name,
                             String id)

Deprecated. Use a shared transport instead of the multiplexer

Returns true if this factory has already registered MuxChannel with given stack_name and an id, false otherwise.

Parameters:

stack_name - name of the stack used

id - service id

Returns:

true if such MuxChannel exists, false otherwise

create

public void create()
            throws Exception

Deprecated.

Throws:

Exception

start

public void start()
           throws Exception

Deprecated.

Throws:

Exception

stop

public void stop()

Deprecated.

destroy

public void destroy()

Deprecated.

dumpConfiguration

public String dumpConfiguration()

Deprecated.

dumpChannels

public String dumpChannels()

Deprecated.