Class ChannelPool

java.lang.Object

org.jpos.iso.channel.ChannelPool

All Implemented Interfaces:

Cloneable, Configurable, ISOChannel, ISOSource, LogSource

public class ChannelPool
extends Object
implements ISOChannel, LogSource, Configurable, Cloneable

A pool of ISOChannel instances; tries each in order until one connects.

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	logger	Logger for this pool.
protected String	realm	Log realm for this pool.

Fields inherited from interface ISOChannel

CONNECT, RX, SIZEOF_CNT, TX

Modifier and Type	Field	Description
static final int	CONNECT	Counter index for connection events.
static final int	RX	Counter index for received messages.
static final int	SIZEOF_CNT	Number of counters maintained by this channel.
static final int	TX	Counter index for transmitted messages.

Constructor Summary

Constructors

Constructor	Description
ChannelPool()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addChannel(String name)	Adds a channel to the pool by its registered name.
void	addChannel(ISOChannel channel)	Adds a channel to the pool.
Object	clone()	Returns a clone of this channel.
void	connect()	Connects ISOChannel
void	disconnect()	disconnects ISOChannel
ISOChannel	getCurrent()	Returns the currently active channel, trying to connect if necessary.
Logger	getLogger()	Returns the Logger associated with this source.
String	getName()	Returns this channel's registered name.
ISOPackager	getPackager()	Returns the packager used to pack/unpack ISO messages on this channel.
String	getRealm()	Returns the log realm associated with this source.
boolean	isConnected()	Indicates whether this source is currently connected and able to send messages.
ISOMsg	receive()	Receives an ISOMsg
void	reconnect()	Reconnect channel
void	removeChannel(String name)	Removes a channel from the pool by its registered name.
void	removeChannel(ISOChannel channel)	Removes a channel from the pool.
void	send(byte[] b)	sends a byte[] over the TCP/IP session
void	send(ISOMsg m)	sends an ISOMsg over the TCP/IP session
void	setConfiguration(Configuration cfg)	Configures this object with the supplied Configuration.
void	setLogger(Logger logger, String realm)	Attaches a Logger and realm to this log source.
void	setName(String name)	associates this ISOChannel with a name on NameRegistrar
void	setPackager(ISOPackager p)	Associate a packager with this channel
void	setUsable(boolean b)	Marks this channel as usable or not; a non-usable channel will not accept messages.
int	size()	Returns the number of channels in the pool.

Methods inherited from class Object

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

Field Details

logger

protected Logger logger

Logger for this pool.

realm

protected String realm

Log realm for this pool.

Constructor Details

ChannelPool

public ChannelPool()

Default constructor.

Method Details

setPackager

public void setPackager(ISOPackager p)

Description copied from interface: ISOChannel

Associate a packager with this channel

Specified by:

setPackager in interface ISOChannel

Parameters:

p - an ISOPackager

connect

public void connect()
             throws IOException

Description copied from interface: ISOChannel

Connects ISOChannel

Specified by:

connect in interface ISOChannel

Throws:

IOException - on I/O failure

disconnect

public void disconnect()
                throws IOException

Description copied from interface: ISOChannel

disconnects ISOChannel

Specified by:

disconnect in interface ISOChannel

Throws:

IOException - on I/O failure

reconnect

public void reconnect()
               throws IOException

Description copied from interface: ISOChannel

Reconnect channel

Specified by:

reconnect in interface ISOChannel

Throws:

IOException - on I/O failure

isConnected

public boolean isConnected()

Description copied from interface: ISOSource

Indicates whether this source is currently connected and able to send messages.

Specified by:

isConnected in interface ISOChannel

Specified by:

isConnected in interface ISOSource

Returns:

true if Channel is connected and usable

receive

public ISOMsg receive()
               throws IOException,
ISOException

Description copied from interface: ISOChannel

Receives an ISOMsg

Specified by:

receive in interface ISOChannel

Returns:

the Message received

Throws:

IOException - on I/O failure

ISOException - on ISO packing/unpacking failure

send

public void send(ISOMsg m)
          throws IOException,
ISOException

Description copied from interface: ISOChannel

sends an ISOMsg over the TCP/IP session

Specified by:

send in interface ISOChannel

Specified by:

send in interface ISOSource

Parameters:

m - the Message to be sent

Throws:

IOException - on I/O failure

ISOException - on ISO packing/unpacking failure

send

public void send(byte[] b)
          throws IOException,
ISOException

Description copied from interface: ISOChannel

sends a byte[] over the TCP/IP session

Specified by:

send in interface ISOChannel

Parameters:

b - the byte array to be sent

Throws:

IOException - on I/O failure

ISOException - on ISO packing/unpacking failure

setUsable

public void setUsable(boolean b)

Description copied from interface: ISOChannel

Marks this channel as usable or not; a non-usable channel will not accept messages.

Specified by:

setUsable in interface ISOChannel

Parameters:

b - - usable state

setName

public void setName(String name)

Description copied from interface: ISOChannel

associates this ISOChannel with a name on NameRegistrar

Specified by:

setName in interface ISOChannel

Parameters:

name - name to register

See Also:

• NameRegistrar

getName

public String getName()

Description copied from interface: ISOChannel

Returns this channel's registered name.

Specified by:

getName in interface ISOChannel

Returns:

this ISOChannel's name ("" if no name was set)

getPackager

public ISOPackager getPackager()

Description copied from interface: ISOChannel

Returns the packager used to pack/unpack ISO messages on this channel.

Specified by:

getPackager in interface ISOChannel

Returns:

current packager

setLogger

public void setLogger(Logger logger,
 String realm)

Description copied from interface: LogSource

Attaches a Logger and realm to this log source.

Specified by:

setLogger in interface LogSource

Parameters:

logger - the logger to use

realm - the log realm (diagnostic label)

getRealm

public String getRealm()

Description copied from interface: LogSource

Returns the log realm associated with this source.

Specified by:

getRealm in interface LogSource

Returns:

log realm

getLogger

public Logger getLogger()

Description copied from interface: LogSource

Returns the Logger associated with this source.

Specified by:

getLogger in interface LogSource

Returns:

the Logger

setConfiguration

public void setConfiguration(Configuration cfg)
                      throws ConfigurationException

Description copied from interface: Configurable

Configures this object with the supplied Configuration.

Specified by:

setConfiguration in interface Configurable

Parameters:

cfg - Configuration object

Throws:

ConfigurationException - if the configuration is invalid

addChannel

public void addChannel(ISOChannel channel)

Adds a channel to the pool.

Parameters:

channel - the channel to add

addChannel

public void addChannel(String name)
                throws NameRegistrar.NotFoundException

Adds a channel to the pool by its registered name.

Parameters:

name - the NameRegistrar name of the channel to add

Throws:

NameRegistrar.NotFoundException - if name not found

removeChannel

public void removeChannel(ISOChannel channel)

Removes a channel from the pool.

Parameters:

channel - the channel to remove

removeChannel

public void removeChannel(String name)
                   throws NameRegistrar.NotFoundException

Removes a channel from the pool by its registered name.

Parameters:

name - the channel name to remove

Throws:

NameRegistrar.NotFoundException - if name not found

size

public int size()

Returns the number of channels in the pool.

Returns:

channel count

getCurrent

public ISOChannel getCurrent()
                      throws IOException

Returns the currently active channel, trying to connect if necessary.

Returns:

the active ISOChannel

Throws:

IOException - if no channel can be connected

clone

public Object clone()

Description copied from interface: ISOChannel

Returns a clone of this channel.

Specified by:

clone in interface ISOChannel

Overrides:

clone in class Object

Returns:

a deep copy of this ISOChannel