Class PADChannel

java.lang.Object

java.util.Observable

org.jpos.iso.BaseChannel

org.jpos.iso.channel.PADChannel

All Implemented Interfaces:

Cloneable, Configurable, ExceptionHandlerAware, BaseChannelMBean, ClientChannel, FactoryChannel, FilteredChannel, ISOChannel, ISOSource, ServerChannel, ISOMsgMetrics.Source, LogSource

public class PADChannel
extends BaseChannel

Implements an ISOChannel suitable to be used to connect to an X.25 PAD.

See Also:

• ISOMsg
• ISOException
• ISOChannel

Field Summary

Fields inherited from class BaseChannel

cnt, header, incomingFilters, logger, originalRealm, outgoingFilters, overrideHeader, packager, realm, serverIn, serverInLock, serverOut, serverOutLock, serverSocket, socketFactory, usable

Modifier and Type	Field	Description
protected int[]	cnt	Message counters array.
protected byte[]	header	Message header bytes.
protected List<ISOFilter>	incomingFilters	Incoming and outgoing filter chains.
protected Logger	logger	The logger for this channel.
protected String	originalRealm	The original realm before any override.
protected List<ISOFilter>	outgoingFilters	Incoming and outgoing filter chains.
protected boolean	overrideHeader	When true, this channel's own header overrides the message's header.
protected ISOPackager	packager	The packager used to pack/unpack ISO messages.
protected String	realm	The realm string for this channel.
protected DataInputStream	serverIn	Input stream for reading from the connected socket.
protected Lock	serverInLock	Lock guarding BaseChannel.serverIn and read operations.
protected DataOutputStream	serverOut	Output stream for writing to the connected socket.
protected Lock	serverOutLock	Lock guarding BaseChannel.serverOut and write operations.
protected ServerSocket	serverSocket	Server socket used when this channel acts as a server.
protected ISOClientSocketFactory	socketFactory	Optional factory for creating client sockets.
protected boolean	usable	Whether this channel is in a usable state.

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
PADChannel()	No-args constructor
PADChannel(String host, int port, ISOPackager p)	Constructs client ISOChannel
PADChannel(ISOPackager p)	Construct server ISOChannel
PADChannel(ISOPackager p, ServerSocket serverSocket)	constructs a server ISOChannel associated with a Server Socket

Method Summary

Modifier and Type	Method	Description
ISOMsg	receive()	Waits and receive an ISOMsg over the TCP/IP session
void	send(ISOMsg m)	Sends the specified ISOMsg over this ISOChannel.
void	setConfiguration(Configuration cfg)	Implements Configurable Properties: host - destination host (if ClientChannel) port - port number (if ClientChannel) local-iface - local interfase to use (if ClientChannel) local-port - local port to bind (if ClientChannel) (host not present indicates a ServerChannel)
void	setHeader(String header)	Sets the message header from a hex string.

Methods inherited from class BaseChannel

accept, addFilter, addFilter, addIncomingFilter, addOutgoingFilter, applyIncomingFilters, applyIncomingFilters, applyOutgoingFilters, applyTimeout, clone, closeSocket, connect, connect, createISOMsg, createMsg, disconnect, getBytes, getChannel, getConfiguration, getCounters, getDynamicHeader, getDynamicPackager, getDynamicPackager, getDynamicPackager, getExceptionHandlers, getHeader, getHeaderLength, getHeaderLength, getHeaderLength, getHost, getIncomingFilters, getISOMsgMetrics, getLogger, getMaxPacketLength, getMessage, getMessageLength, getMessageTrailer, getMessageTrailler, getName, getOriginalRealm, getOutgoingFilters, getPackager, getPort, getRealm, getServerSocket, getSocket, getSocketFactory, getSoLingerSeconds, getTimeout, incrementMsgInCounter, incrementMsgOutCounter, isConnected, isExpectKeepAlive, isOverrideHeader, isRejected, isSoLingerOn, newSocket, newSocket, pack, postConnectHook, readHeader, reconnect, removeFilter, removeFilter, removeIncomingFilter, removeOutgoingFilter, resetCounters, send, sendKeepAlive, sendMessage, sendMessageHeader, sendMessageLength, sendMessageTrailer, sendMessageTrailler, sendMessageTrailler, setHeader, setHost, setHost, setIncomingFilters, setISOMsgMetrics, setLocalAddress, setLogger, setMaxPacketLength, setName, setOutgoingFilters, setOverrideHeader, setPackager, setPort, setServerSocket, setSocketFactory, setSoLinger, setTimeout, setUsable, shouldIgnore, streamReceive, toEndpoint, unpack

Modifier and Type	Method	Description
void	accept(ServerSocket s)	Accepts connection
void	addFilter(ISOFilter filter)	Adds a filter to this channel.
void	addFilter(ISOFilter filter, int direction)	Adds a filter to this channel.
void	addIncomingFilter(ISOFilter filter)	Adds a filter to the incoming filter chain.
void	addOutgoingFilter(ISOFilter filter)	Adds a filter to the outgoing filter chain.
protected ISOMsg	applyIncomingFilters(ISOMsg m, byte[] header, byte[] image, LogEvent evt)	Applies all registered incoming filters with the raw message header and image.
protected ISOMsg	applyIncomingFilters(ISOMsg m, LogEvent evt)	Applies all registered incoming filters to the given message.
protected ISOMsg	applyOutgoingFilters(ISOMsg m, LogEvent evt)	Applies all registered outgoing filters to the given message.
protected void	applyTimeout()	sets timeout, and also keep alive
Object	clone()	Returns a clone of this channel.
protected void	closeSocket()	Closes the underlying socket.
void	connect()	Connects client ISOChannel to server
protected void	connect(Socket socket)	setup I/O Streams from socket
protected ISOMsg	createISOMsg()	Creates a new ISOMsg instance; may be overridden to return a subclass.
protected ISOMsg	createMsg()	support old factory method name for backward compatibility
void	disconnect()	disconnects the TCP/IP session.
int	getBytes(byte[] b)	Low level receive
static ISOChannel	getChannel(String name)	Retrieves a channel instance by name from the NameRegistrar.
Configuration	getConfiguration()	Returns the current configuration for this channel.
int[]	getCounters()	Returns the message counters array.
protected ISOHeader	getDynamicHeader(byte[] image)	Allow subclasses to override the Default header on incoming messages.
protected ISOPackager	getDynamicPackager(byte[] image)	allow subclasses to override default packager on incoming messages
protected ISOPackager	getDynamicPackager(byte[] header, byte[] image)	allow subclasses to override default packager on incoming messages
protected ISOPackager	getDynamicPackager(ISOMsg m)	allow subclasses to override default packager on outgoing messages
Map<Class<? extends Exception>, List<ExceptionHandler>>	getExceptionHandlers()	Returns the map of targeted exception handlers, keyed by exception class.
byte[]	getHeader()	Returns the message header bytes.
protected int	getHeaderLength()	Returns the fixed header length for this channel.
protected int	getHeaderLength(byte[] b)	Returns the header length for the given raw message bytes.
protected int	getHeaderLength(ISOMsg m)	Returns the header length for the given ISO message.
String	getHost()	Returns the remote host this client channel connects to.
Collection<ISOFilter>	getIncomingFilters()	Returns all filters in the incoming filter chain.
ISOMsgMetrics	getISOMsgMetrics()	Returns the attached ISOMsgMetrics.
Logger	getLogger()	Returns the Logger associated with this source.
int	getMaxPacketLength()	Returns the maximum packet length accepted by this channel.
protected void	getMessage(byte[] b, int offset, int len)	Reads raw message bytes from the stream into the given buffer.
protected int	getMessageLength()	Reads and returns the message length prefix from the stream.
protected void	getMessageTrailer(ISOMsg m)	Reads the message trailer from the stream and optionally stores it in the given message.
protected void	getMessageTrailler()	Deprecated. use BaseChannel.getMessageTrailer(ISOMsg) instead.
String	getName()	Returns this channel's registered name.
String	getOriginalRealm()	Returns the original realm before any override was applied.
Collection<ISOFilter>	getOutgoingFilters()	Returns all filters in the outgoing filter chain.
ISOPackager	getPackager()	Returns the packager used to pack/unpack ISO messages on this channel.
int	getPort()	Returns the remote port this client channel connects to.
String	getRealm()	Returns the log realm associated with this source.
ServerSocket	getServerSocket()	Returns the current server socket.
Socket	getSocket()	Returns the current connected socket.
ISOClientSocketFactory	getSocketFactory()	Gets the ISOClientSocketFactory (may be null)
int	getSoLingerSeconds()	Returns the SO_LINGER timeout in seconds.
int	getTimeout()	Returns the socket read timeout in milliseconds.
protected void	incrementMsgInCounter(ISOMsg m)	Increments the incoming message counter for the given message.
protected void	incrementMsgOutCounter(ISOMsg m)	Increments the outgoing message counter for the given message.
boolean	isConnected()	Indicates whether this source is currently connected and able to send messages.
boolean	isExpectKeepAlive()	Returns whether this channel expects keep-alive messages.
boolean	isOverrideHeader()	Returns whether the channel header overrides the message header.
protected boolean	isRejected(byte[] b)	Returns whether the given raw message should be rejected.
boolean	isSoLingerOn()	Returns whether SO_LINGER is enabled on the socket.
protected Socket	newSocket(String[] hosts, int[] ports, LogEvent evt)	Creates a new socket connected to one of the given hosts/ports.
protected Socket	newSocket(String host, int port)	factory method pattern (as suggested by Vincent.Greene@amo.com)
protected byte[]	pack(ISOMsg m)	Packs the given ISOMsg into raw bytes using this channel's packager.
protected void	postConnectHook()	Hook called after a successful connection.
protected byte[]	readHeader(int hLen)	Reads in a message header.
void	reconnect()	Issues a disconnect followed by a connect
void	removeFilter(ISOFilter filter)	Removes a filter from this channel.
void	removeFilter(ISOFilter filter, int direction)	Removes a filter from this channel.
void	removeIncomingFilter(ISOFilter filter)	Removes a filter from the incoming filter chain.
void	removeOutgoingFilter(ISOFilter filter)	Removes a filter from the outgoing filter chain.
void	resetCounters()	reset stat info
void	send(byte[] b)	sends a byte[] over the TCP/IP session
void	sendKeepAlive()	Sends a high-level keep-alive message (zero length)
protected void	sendMessage(byte[] b, int offset, int len)	Writes the given bytes to the output stream.
protected void	sendMessageHeader(ISOMsg m, int len)	Sends the message header bytes.
protected void	sendMessageLength(int len)	Sends the message length prefix; default implementation is a no-op.
protected void	sendMessageTrailer(ISOMsg m, byte[] b)	Sends the message trailer bytes.
protected void	sendMessageTrailler(ISOMsg m, byte[] b)	Deprecated. use BaseChannel.sendMessageTrailer(ISOMsg, byte[]) instead.
protected void	sendMessageTrailler(ISOMsg m, int len)	Deprecated. use sendMessageTrailer(ISOMsg m, byte[] b) instead.
void	setHeader(byte[] header)	Sets the message header bytes for this channel.
void	setHost(String host)	Sets the remote host name or address.
void	setHost(String host, int port)	initialize an ISOChannel
void	setIncomingFilters(Collection filters)	Replaces the entire incoming filter chain with the given collection.
void	setISOMsgMetrics(ISOMsgMetrics metrics)	Sets the ISOMsgMetrics instance.
void	setLocalAddress(String iface, int port)	initialize an ISOChannel
void	setLogger(Logger logger, String realm)	Attaches a Logger and realm to this log source.
void	setMaxPacketLength(int maxPacketLength)	Sets the maximum packet length accepted by this channel.
void	setName(String name)	associates this ISOChannel with a name using NameRegistrar
void	setOutgoingFilters(Collection filters)	Replaces the entire outgoing filter chain with the given collection.
void	setOverrideHeader(boolean overrideHeader)	Controls whether this channel's own header overrides the message header.
void	setPackager(ISOPackager p)	set Packager for channel
void	setPort(int port)	Sets the remote port number.
void	setServerSocket(ServerSocket sock)	Associates this ISOChannel with a server socket
void	setSocketFactory(ISOClientSocketFactory socketFactory)	Sets the specified Socket Factory to create sockets
void	setSoLinger(boolean on, int linger)	Socket SO_LINGER option to use when closing the socket.
void	setTimeout(int timeout)	sets socket timeout (as suggested by Leonard Thomas <leonard@rhinosystemsinc.com>)
void	setUsable(boolean b)	Marks this channel as usable or not; a non-usable channel will not accept messages.
protected boolean	shouldIgnore(byte[] b)	Returns whether the given raw message should be silently ignored.
protected byte[]	streamReceive()	Reads raw bytes from the stream for protocols without explicit length framing.
protected String	toEndpoint(Socket socket)	Returns a human-readable endpoint string for the given socket.
protected void	unpack(ISOMsg m, byte[] b)	Unpacks raw bytes into the given ISOMsg using this channel's packager.

Methods inherited from class Observable

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

Methods inherited from class Object

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

Methods inherited from interface ExceptionHandlerAware

addHandler, addHandler, handle, removeHandler, removeHandler, removeHandlers

Modifier and Type	Method	Description
default void	addHandler(ExceptionHandler handler)	Add a handler to the default pipeline.
default void	addHandler(ExceptionHandler handler, Class<? extends Exception> clazz)	Add a handler to an exception specific pipeline.
default Exception	handle(Exception e)	Execute the pipeline by starting with the specific pipeline for the exception followed by the default pipeline.
default void	removeHandler(ExceptionHandler handler)	Remove a handler from the default pipeline.
default void	removeHandler(ExceptionHandler handler, Class<? extends Exception> clazz)	Remove a handler from an exception specific handler pipeline.
default void	removeHandlers(Class<? extends Exception> clazz)	Remove all handler for a specific exception handling pipeline.

Constructor Details

PADChannel

public PADChannel()

No-args constructor

PADChannel

public PADChannel(String host,
 int port,
 ISOPackager p)

Constructs client ISOChannel

Parameters:

host - server TCP Address

port - server port number

p - an ISOPackager

See Also:

• ISOPackager

PADChannel

public PADChannel(ISOPackager p)
           throws IOException

Construct server ISOChannel

Parameters:

p - an ISOPackager

Throws:

IOException - on I/O error

See Also:

• ISOPackager

PADChannel

public PADChannel(ISOPackager p,
 ServerSocket serverSocket)
           throws IOException

constructs a server ISOChannel associated with a Server Socket

Parameters:

p - an ISOPackager

serverSocket - where to accept a connection

Throws:

IOException - on I/O error

See Also:

• ISOPackager

Method Details

receive

public ISOMsg receive()
               throws IOException,
ISOException

Description copied from class: BaseChannel

Waits and receive an ISOMsg over the TCP/IP session

Specified by:

receive in interface ISOChannel

Overrides:

receive in class BaseChannel

Returns:

the Message received

Throws:

IOException - on I/O error

ISOException - on ISO processing error

send

public void send(ISOMsg m)
          throws IOException,
ISOException

Description copied from class: BaseChannel

Sends the specified ISOMsg over this ISOChannel.

This method performs the following steps:

• Verifies the channel is connected.
• Sets the message direction to ISOMsg.OUTGOING.
• Retrieves and sets a dynamic packager for the message.
• Applies all registered outgoing filters, allowing them to modify or veto the message.
• Packs the message and writes its length, header, body, and trailer to the underlying stream, protected by a locking mechanism to ensure thread safety.
• Flushes the output stream and increments message counters.
• Notifies observers of the sent message.
• Logs both the message and the send operation through ChannelEvent and LogEvent.

If a ISOFilter.VetoException is thrown by a filter, the message is not sent, and the exception is logged.

Specified by:

send in interface ISOChannel

Specified by:

send in interface ISOSource

Overrides:

send in class BaseChannel

Parameters:

m - the ISO message to be sent. The message will be modified in-place: its direction and packager will be updated, and filters may alter its content.

Throws:

IOException - if the channel is not connected, if the output stream fails, if locking times out, or if an unexpected I/O error occurs.

ISOException - if packing the message fails or other ISO-specific issues occur.

See Also:

• ISOMsg
• ISOPackager
• ISOFilter
• ChannelEvent
• LogEvent

setConfiguration

public void setConfiguration(Configuration cfg)
                      throws ConfigurationException

Description copied from class: BaseChannel

Implements Configurable
Properties:

• host - destination host (if ClientChannel)
• port - port number (if ClientChannel)
• local-iface - local interfase to use (if ClientChannel)
• local-port - local port to bind (if ClientChannel)

(host not present indicates a ServerChannel)

Specified by:

setConfiguration in interface Configurable

Overrides:

setConfiguration in class BaseChannel

Parameters:

cfg - Configuration

Throws:

ConfigurationException - if configuration is invalid

setHeader

public void setHeader(String header)

Description copied from class: BaseChannel

Sets the message header from a hex string.

Overrides:

setHeader in class BaseChannel

Parameters:

header - Hex representation of header