Class ISOServer

java.lang.Object

java.util.Observable

org.jpos.iso.ISOServer

All Implemented Interfaces:

Runnable, Observer, Configurable, ISOServerMBean, ISOServerSocketFactory, Loggeable, LogSource

public class ISOServer
extends Observable
implements LogSource, Runnable, Observer, ISOServerMBean, Configurable, Loggeable, ISOServerSocketFactory

Accept ServerChannel sessions and forwards them to ISORequestListeners

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ISOServer.Session	Handles the ISO 8583 exchange for a single accepted server connection.

Field Summary

Fields

Modifier and Type	Field	Description
protected Configuration	cfg	The server configuration.
protected Collection	clientIncomingFilters	Outgoing and incoming filter chains for client channels.
protected Collection	clientOutgoingFilters	Outgoing and incoming filter chains for client channels.
protected ISOChannel	clientSideChannel	The channel template used for client-side connections.
static final int	DEFAULT_MAX_SESSIONS	Default maximum number of concurrent sessions.
protected boolean	ignoreISOExceptions	If true, ISOExceptions are silently ignored.
static final String	LAST	Realm suffix used for the last connected channel.
protected long	lastTxn	Timestamp of the last transaction processed.
protected List<ISORequestListener>	listeners	Registered ISO request listeners.
protected Logger	logger	The logger for this server.
protected String	realm	The realm string for this server.
protected String	realmChannel	The realm string for channel sessions.
protected List<ISOServerEventListener>	serverListeners	Registered server event listeners.
protected ISOServerSocketFactory	socketFactory	Optional factory for creating server sockets.

Constructor Summary

Constructors

Constructor	Description
ISOServer(int port, ServerChannel clientSide, int maxSessions)	Constructs an ISOServer on the given port.

Method Summary

Modifier and Type	Method	Description
void	addISORequestListener(ISORequestListener l)	add an ISORequestListener
void	addServerEventListener(ISOServerEventListener listener)	Registers a listener for server events.
ServerSocket	createServerSocket(int port)	Create a server socket on the specified port (port 0 indicates an anonymous port).
protected ISOServer.Session	createSession(ServerChannel channel)	Creates a new server session for the given channel.
void	dump(PrintStream p, String indent)	Dumps a human-readable representation of this object to the print stream.
void	fireEvent(EventObject event)	Dispatches an event to all registered server event listeners.
int	getActiveConnections()	Returns the current number of active (in-use) connections.
int	getConnectionCount()	Returns the cumulative number of connections accepted by this server.
int	getConnections()	Returns the current number of active accepted connections.
int[]	getCounters()	Returns an array of [rx, tx, connected] counters across all active channels.
String	getCountersAsString()	Returns a human-readable string summarising RX/TX/connection counters.
String	getCountersAsString(String isoChannelName)	Returns counters as a string for the named channel.
long	getIdleTimeInMillis()	Returns the idle time in milliseconds.
ISOChannel	getISOChannel(String name)	Returns the ISOChannel registered under the given name.
String	getISOChannelNames()	Returns the names of connected ISO channels.
ISOChannel	getLastConnectedISOChannel()	Returns the most recently accepted ISOChannel.
long	getLastTxnTimestampInMillis()	Returns the timestamp of the last transaction in milliseconds.
Logger	getLogger()	Returns the Logger associated with this source.
String	getName()	Returns this server's registered name.
int	getPort()	Returns the port this server is listening on.
String	getRealm()	Returns the log realm associated with this source.
int	getRXCounter()	Returns the receive counter.
static ISOServer	getServer(String name)	Returns the ISOServer registered under the given name.
ISOServerSocketFactory	getSocketFactory()	Gets the ISOClientSocketFactory (may be null)
int	getTXCounter()	Returns the transmit counter.
void	removeISORequestListener(ISORequestListener l)	remove an ISORequestListener
void	removeServerEventListener(ISOServerEventListener listener)	Unregisters a previously added server event listener.
void	resetCounters()	Resets all server counters.
void	run()
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 ISOServer with a name using NameRegistrar
void	setSocketFactory(ISOServerSocketFactory socketFactory)	Sets the specified Socket Factory to create sockets
void	shutdown()	Shutdown this server
void	update(Observable o, Object arg)

Methods inherited from class Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class Object

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

Methods inherited from interface Loggeable

dump

Modifier and Type	Method	Description
default void	dump(PrintStream p, String indent, LogRenderer.Type type)	Dumps a representation of this object using the specified renderer type.

Field Details

clientSideChannel

protected ISOChannel clientSideChannel

The channel template used for client-side connections.

clientOutgoingFilters

protected Collection clientOutgoingFilters

Outgoing and incoming filter chains for client channels.

clientIncomingFilters

protected Collection clientIncomingFilters

Outgoing and incoming filter chains for client channels.

listeners

protected List<ISORequestListener> listeners

Registered ISO request listeners.

DEFAULT_MAX_SESSIONS

public static final int DEFAULT_MAX_SESSIONS

Default maximum number of concurrent sessions.

See Also:

• Constant Field Values

LAST

public static final String LAST

Realm suffix used for the last connected channel.

See Also:

• Constant Field Values

lastTxn

protected long lastTxn

Timestamp of the last transaction processed.

logger

protected Logger logger

The logger for this server.

realm

protected String realm

The realm string for this server.

realmChannel

protected String realmChannel

The realm string for channel sessions.

socketFactory

protected ISOServerSocketFactory socketFactory

Optional factory for creating server sockets.

cfg

protected Configuration cfg

The server configuration.

ignoreISOExceptions

protected boolean ignoreISOExceptions

If true, ISOExceptions are silently ignored.

serverListeners

protected List<ISOServerEventListener> serverListeners

Registered server event listeners.

Constructor Details

ISOServer

public ISOServer(int port,
 ServerChannel clientSide,
 int maxSessions)

Constructs an ISOServer on the given port.

Parameters:

port - port to listen

clientSide - client side ISOChannel, used as a "clonable template" to accept new connections

maxSessions - maximum number of concurrent sessions (0 = unlimited)

Method Details

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

addISORequestListener

public void addISORequestListener(ISORequestListener l)

add an ISORequestListener

Parameters:

l - request listener to be added

See Also:

• ISORequestListener

removeISORequestListener

public void removeISORequestListener(ISORequestListener l)

remove an ISORequestListener

Parameters:

l - a request listener to be removed

See Also:

• ISORequestListener

shutdown

public void shutdown()

Shutdown this server

createServerSocket

public ServerSocket createServerSocket(int port)
                                throws IOException

Description copied from interface: ISOServerSocketFactory

Create a server socket on the specified port (port 0 indicates an anonymous port).

Specified by:

createServerSocket in interface ISOServerSocketFactory

Parameters:

port - the port number

Returns:

the server socket on the specified port

Throws:

IOException - should an I/O error occur

createSession

protected ISOServer.Session createSession(ServerChannel channel)

Creates a new server session for the given channel.

Parameters:

channel - the accepted server channel

Returns:

a new Session

run

public void run()

Specified by:

run in interface Runnable

setName

public void setName(String name)

associates this ISOServer with a name using NameRegistrar

Parameters:

name - name to register

See Also:

• NameRegistrar

getServer

public static ISOServer getServer(String name)
                           throws NameRegistrar.NotFoundException

Returns the ISOServer registered under the given name.

Parameters:

name - the server's registered name

Returns:

ISOServer instance with given name.

Throws:

NameRegistrar.NotFoundException - if not found in registry

See Also:

• NameRegistrar

getName

public String getName()

Returns this server's registered name.

Returns:

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

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

update

public void update(Observable o,
 Object arg)

Specified by:

update in interface Observer

getSocketFactory

public ISOServerSocketFactory getSocketFactory()

Gets the ISOClientSocketFactory (may be null)

Returns:

the configured server socket factory, or null

Since:

1.3.3

See Also:

• ISOClientSocketFactory

setSocketFactory

public void setSocketFactory(ISOServerSocketFactory socketFactory)

Sets the specified Socket Factory to create sockets

Parameters:

socketFactory - the ISOClientSocketFactory

Since:

1.3.3

See Also:

• ISOClientSocketFactory

getPort

public int getPort()

Description copied from interface: ISOServerMBean

Returns the port this server is listening on.

Specified by:

getPort in interface ISOServerMBean

Returns:

the port number

resetCounters

public void resetCounters()

Description copied from interface: ISOServerMBean

Resets all server counters.

Specified by:

resetCounters in interface ISOServerMBean

getConnectionCount

public int getConnectionCount()

Returns the cumulative number of connections accepted by this server.

Specified by:

getConnectionCount in interface ISOServerMBean

Returns:

number of connections accepted by this server

getLastConnectedISOChannel

public ISOChannel getLastConnectedISOChannel()

Returns the most recently accepted ISOChannel.

Returns:

most recently connected ISOChannel or null

getISOChannel

public ISOChannel getISOChannel(String name)

Returns the ISOChannel registered under the given name.

Parameters:

name - the channel name

Returns:

ISOChannel under the given name

getISOChannelNames

public String getISOChannelNames()

Description copied from interface: ISOServerMBean

Returns the names of connected ISO channels.

Specified by:

getISOChannelNames in interface ISOServerMBean

Returns:

channel names string

getCountersAsString

public String getCountersAsString()

Returns a human-readable string summarising RX/TX/connection counters.

Returns:

counters summary string

getCounters

public int[] getCounters()

Returns an array of [rx, tx, connected] counters across all active channels.

Returns:

int array: [rx, tx, connected]

getTXCounter

public int getTXCounter()

Description copied from interface: ISOServerMBean

Returns the transmit counter.

Specified by:

getTXCounter in interface ISOServerMBean

Returns:

TX count

getRXCounter

public int getRXCounter()

Description copied from interface: ISOServerMBean

Returns the receive counter.

Specified by:

getRXCounter in interface ISOServerMBean

Returns:

RX count

getConnections

public int getConnections()

Returns the current number of active accepted connections.

Returns:

active connection count

getLastTxnTimestampInMillis

public long getLastTxnTimestampInMillis()

Description copied from interface: ISOServerMBean

Returns the timestamp of the last transaction in milliseconds.

Specified by:

getLastTxnTimestampInMillis in interface ISOServerMBean

Returns:

last transaction timestamp

getIdleTimeInMillis

public long getIdleTimeInMillis()

Description copied from interface: ISOServerMBean

Returns the idle time in milliseconds.

Specified by:

getIdleTimeInMillis in interface ISOServerMBean

Returns:

idle time

getCountersAsString

public String getCountersAsString(String isoChannelName)

Description copied from interface: ISOServerMBean

Returns counters as a string for the named channel.

Specified by:

getCountersAsString in interface ISOServerMBean

Parameters:

isoChannelName - the channel name

Returns:

counters string

dump

public void dump(PrintStream p,
 String indent)

Description copied from interface: Loggeable

Dumps a human-readable representation of this object to the print stream.

Specified by:

dump in interface Loggeable

Parameters:

p - the output stream

indent - indentation prefix

addServerEventListener

public void addServerEventListener(ISOServerEventListener listener)

Registers a listener for server events.

Parameters:

listener - the listener to add

removeServerEventListener

public void removeServerEventListener(ISOServerEventListener listener)

Unregisters a previously added server event listener.

Parameters:

listener - the listener to remove

fireEvent

public void fireEvent(EventObject event)

Dispatches an event to all registered server event listeners.

Parameters:

event - the event to dispatch

getActiveConnections

public int getActiveConnections()

Returns the current number of active (in-use) connections.

Returns:

number of active connections