jadex.platform.service.message.streams

Class AbstractConnectionHandler

java.lang.Object

jadex.platform.service.message.streams.AbstractConnectionHandler

All Implemented Interfaces:

IAbstractConnectionHandler

Direct Known Subclasses:

InputConnectionHandler, OutputConnectionHandler

public class AbstractConnectionHandler
extends java.lang.Object
implements IAbstractConnectionHandler

Abstract base class for connection handlers. Is called from the message service and the connection. Ensures that all calls from threads other than the message service component are scheduled on this thread to avoid multithreading issues in this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractConnectionHandler.ConnectionPanel
static class	AbstractConnectionHandler.SendInfo Struct class that holds send information.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	acktimeout The max delay before an acknowledgement is received.
protected long	alivetime The latest alive time.
protected AbstractConnection	con The connection.
protected long	leasetime The lease time.
protected int	maxresends The maximum number of resends.
protected MessageService	ms The message service.
protected java.util.Map<java.lang.String,java.lang.Object>	nonfunc The non-functional properties.
protected java.util.Map<java.lang.Object,AbstractConnectionHandler.SendInfo>	unacked The unacknowledged messages.

Constructor Summary

Constructors

Constructor and Description
AbstractConnectionHandler(MessageService ms, java.util.Map<java.lang.String,java.lang.Object> nonfunc) Create a new connection handler.
AbstractConnectionHandler(MessageService ms, java.util.Map<java.lang.String,java.lang.Object> nonfunc, int maxresends, long acktimeout, long leasetime) Create a new connection handler.

Method Summary

Modifier and Type	Method and Description
void	ackReceived(java.lang.Object id, java.lang.Object content) Called when an ack was received.
void	close() Close the connection.
protected java.util.TimerTask	createAckTimer(java.lang.Object id) Triggers resends of packets if no ack has been received in acktimeout.
void	createGui()
protected javax.swing.JPanel	createPanel()
protected AbstractSendTask	createTask(java.lang.String type, byte[] content, java.lang.Integer seqnumber, java.util.Map<java.lang.String,java.lang.Object> nonfunc) Create a new task.
protected AbstractSendTask	createTask(java.lang.String type, java.lang.Object content, boolean usecodecs, java.lang.Integer seqnumber, java.util.Map<java.lang.String,java.lang.Object> nonfunc) Create a new task.
jadex.commons.future.IFuture<java.lang.Void>	doClose() Called from connection.
protected byte[]	getCodecIds() Get the codec ids.
protected jadex.bridge.service.types.message.ICodec[]	getCodecs() Get the codecs.
protected AbstractConnection	getConnection() Get the connection.
int	getConnectionId() Get the id.
protected long	getLeasetime() Get the leasetime.
protected byte	getMessageType(java.lang.String type) Get the message type for a given type, e.g.
java.util.Map<java.lang.String,java.lang.Object>	getNonFunctionalProperties() Get the non-functional properties.
protected ITransport[]	getTransports() Get the transports.
void	initReceived() Received the init message.
boolean	isClosed() Get the closed.
boolean	isConnectionAlive() Test if the connection is alive.
void	notifyInited()
protected <E> jadex.commons.future.IFuture<E>	scheduleStep(jadex.bridge.IComponentStep<E> step) Schedule a step on the message service component.
protected jadex.commons.future.IFuture<java.lang.Object>	sendAcknowledgedMessage(AbstractSendTask task, java.lang.Object id) Send a message and wait for an ack.
jadex.commons.future.IFuture<java.lang.Void>	sendAlive() Send alive message.
jadex.commons.future.IFuture<java.lang.Void>	sendInit() Send init message.
protected void	sendTask(AbstractSendTask task) Send a task.
void	setAliveTime(long alivetime) Set the alive time of the other connection side.
void	setConnection(AbstractConnection con) Set the connection (needed as connection and handler need each other).
void	setNonFunctionalProperties(java.util.Map<java.lang.String,java.lang.Object> nonfunc) Set the non-functional properties.

Methods inherited from class java.lang.Object

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

Field Detail

ms

protected MessageService ms

The message service.

con

protected AbstractConnection con

The connection.

alivetime

protected long alivetime

The latest alive time.

leasetime

protected long leasetime

The lease time.

unacked

protected java.util.Map<java.lang.Object,AbstractConnectionHandler.SendInfo> unacked

The unacknowledged messages.

maxresends

protected int maxresends

The maximum number of resends.

acktimeout

protected long acktimeout

The max delay before an acknowledgement is received.

nonfunc

protected java.util.Map<java.lang.String,java.lang.Object> nonfunc

The non-functional properties.

Constructor Detail

AbstractConnectionHandler

public AbstractConnectionHandler(MessageService ms,
                                 java.util.Map<java.lang.String,java.lang.Object> nonfunc)

Create a new connection handler.

AbstractConnectionHandler

public AbstractConnectionHandler(MessageService ms,
                                 java.util.Map<java.lang.String,java.lang.Object> nonfunc,
                                 int maxresends,
                                 long acktimeout,
                                 long leasetime)

Create a new connection handler.

Method Detail

setConnection

public void setConnection(AbstractConnection con)

Set the connection (needed as connection and handler need each other). The connections uses this method to set itself as connection in their constructor.

Specified by:

setConnection in interface IAbstractConnectionHandler

initReceived

public void initReceived()

Received the init message.

ackReceived

public void ackReceived(java.lang.Object id,
                        java.lang.Object content)

Called when an ack was received. The id is used to identify the original message task. This will cancel the timer (resending) task and call the future of sendAcknowledgedMessage().

close

public void close()

Close the connection. Notifies the other side that the connection has been closed.

setAliveTime

public void setAliveTime(long alivetime)

Set the alive time of the other connection side.

Parameters:

alivetime - The alive time.

isConnectionAlive

public boolean isConnectionAlive()

Test if the connection is alive.

Returns:

True, if is alive.

isClosed

public boolean isClosed()

Get the closed.

Returns:

The closed.

getConnectionId

public int getConnectionId()

Get the id.

Returns:

the id.

doClose

public jadex.commons.future.IFuture<java.lang.Void> doClose()

Called from connection. Initiates closing procedure (is different for initiator and participant).

Specified by:

doClose in interface IAbstractConnectionHandler

sendInit

public jadex.commons.future.IFuture<java.lang.Void> sendInit()

Send init message.

Specified by:

sendInit in interface IAbstractConnectionHandler

sendAlive

public jadex.commons.future.IFuture<java.lang.Void> sendAlive()

Send alive message.

notifyInited

public void notifyInited()

Specified by:

notifyInited in interface IAbstractConnectionHandler

getConnection

protected AbstractConnection getConnection()

Get the connection.

Returns:

The connection.

getCodecs

protected jadex.bridge.service.types.message.ICodec[] getCodecs()

Get the codecs.

Returns:

The codecs.

getCodecIds

protected byte[] getCodecIds()

Get the codec ids.

Returns:

The codec ids.

getTransports

protected ITransport[] getTransports()

Get the transports.

Returns:

The transports.

getNonFunctionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getNonFunctionalProperties()

Get the non-functional properties.

Specified by:

getNonFunctionalProperties in interface IAbstractConnectionHandler

Returns:

The non-functional properties.

setNonFunctionalProperties

public void setNonFunctionalProperties(java.util.Map<java.lang.String,java.lang.Object> nonfunc)

Set the non-functional properties.

Parameters:

nonfunc - The non-functional properties.

getMessageType

protected byte getMessageType(java.lang.String type)

Get the message type for a given type, e.g. init, close (defined in StreamSendTask).

Parameters:

type - The message type.

Returns:

The message type for message sending.

createTask

protected AbstractSendTask createTask(java.lang.String type,
                                      byte[] content,
                                      java.lang.Integer seqnumber,
                                      java.util.Map<java.lang.String,java.lang.Object> nonfunc)

Create a new task.

Parameters:

type - The message type.

content - The content.

seqnumber - The sequence number.

Returns:

The task for sending the message.

createTask

protected AbstractSendTask createTask(java.lang.String type,
                                      java.lang.Object content,
                                      boolean usecodecs,
                                      java.lang.Integer seqnumber,
                                      java.util.Map<java.lang.String,java.lang.Object> nonfunc)

Create a new task.

Parameters:

type - The message type.

content - The content.

usecodecs - Flag if codecs should be used to encode the content.

seqnumber - The sequence number.

Returns:

The task for sending the message.

sendTask

protected void sendTask(AbstractSendTask task)

Send a task.

Parameters:

task - The task.

sendAcknowledgedMessage

protected jadex.commons.future.IFuture<java.lang.Object> sendAcknowledgedMessage(AbstractSendTask task,
                                                                                 java.lang.Object id)

Send a message and wait for an ack. Automatically resends messages () if not is ack is received within acktimeout.

Parameters:

task - The send task.

id - The id of the call (e.g. sequence number).

Returns:

Exception if sending and resending failed.

getLeasetime

protected long getLeasetime()

Get the leasetime.

Returns:

the leasetime.

scheduleStep

protected <E> jadex.commons.future.IFuture<E> scheduleStep(jadex.bridge.IComponentStep<E> step)

Schedule a step on the message service component.

createAckTimer

protected java.util.TimerTask createAckTimer(java.lang.Object id)

Triggers resends of packets if no ack has been received in acktimeout.

Parameters:

id - The message id.

Returns:

The timer.

createGui

public void createGui()

createPanel

protected javax.swing.JPanel createPanel()