jadex.base.relay

Class RelayHandler

java.lang.Object

jadex.base.relay.RelayHandler

public class RelayHandler
extends java.lang.Object

Basic relay functionality to be used with or without servlet.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Byte,jadex.bridge.service.types.message.ICodec>	codecs The available codecs for awareness infos (cached for speed).
protected jadex.platform.service.message.transport.httprelaymtp.RelayConnectionManager	conman The connection manager for communicating with remote peers.
protected jadex.bridge.service.types.message.ICodec[]	defcodecs The default codecs (used for relay-to-relay communication).
protected java.util.Map<java.lang.String,jadex.commons.collection.IBlockingQueue<Message>>	map The relay map (id -> queue for pending requests).
protected PeerList	peers The peer list.
protected java.util.Map<java.lang.Object,PlatformInfo>	platforms Info about connected platforms.
protected RelayServerSettings	settings The settings loaded from file.
protected StatsDB	statsdb The statistics database (if any).
static java.io.File	SYSTEMDIR The directory for settings and statistics.

Constructor Summary

Constructors

Constructor and Description
RelayHandler() Initialize the handler.

Method Summary

Modifier and Type	Method and Description
void	dispose() Cleanup on shutdown.
jadex.platform.service.message.transport.httprelaymtp.RelayConnectionManager	getConnectionManager() Get the connection manager.
PeerHandler[]	getCurrentPeers() Get the current peers.
PlatformInfo[]	getCurrentPlatforms() Get the current platforms
static java.util.logging.Logger	getLogger() Get the logger.
PeerList	getPeerList() Get the peer list.
RelayServerSettings	getSettings() Get the settings.
StatsDB	getStatisticsDB() Get the statistics database (if any).
void	handleAwareness(java.io.InputStream in) Called when an awareness info is received from a connected platform.
void	handleConnection(java.lang.String id, java.io.OutputStream out) Called when a platform registers itself at the relay.
void	handleMessage(java.io.InputStream in, java.lang.String protocol) Called when a message should be sent.
void	handleOffline(java.lang.String hostip, java.io.InputStream in) Called when an offline status change is posted by a platform.
void	handlePlatform(java.io.InputStream in) Called when a single platform info is received from a peer relay server.
void	handlePlatforms(java.io.InputStream in) Called when platform infos are received from a peer relay server.
java.lang.String	handleServersRequest(java.lang.String requesturl, java.lang.String peerurl, java.lang.String peerid, int peerstate, boolean initial) Get the available servers as comma-separated list of URLs.
void	handleSyncRequest(java.lang.String peerid, int startid, int cnt, java.io.OutputStream out) Send requested db entries.
void	initConnection(java.lang.String id, java.lang.String hostip, java.lang.String hostname, java.lang.String protocol) Called when a platform registers itself at the relay.
protected static byte[]	readData(java.io.InputStream is, int length) Read data into a byte array.
static java.lang.String	readString(java.io.InputStream in) Read a string from the given stream.
protected void	sendAwarenessInfos(jadex.bridge.service.types.awareness.AwarenessInfo awainfo, jadex.bridge.service.types.message.ICodec[] pcodecs, boolean local, boolean initial) Send awareness messages for a new or changed awareness info.
void	sendPlatformInfo(PlatformInfo info) Send a single platform info to all peer relay servers.
void	sendPlatformInfos(PeerHandler peer, PlatformInfo[] infos) Send platform infos to a peer relay server.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEMDIR

public static final java.io.File SYSTEMDIR

The directory for settings and statistics.

settings

protected RelayServerSettings settings

The settings loaded from file.

map

protected java.util.Map<java.lang.String,jadex.commons.collection.IBlockingQueue<Message>> map

The relay map (id -> queue for pending requests).

platforms

protected java.util.Map<java.lang.Object,PlatformInfo> platforms

Info about connected platforms.

codecs

protected java.util.Map<java.lang.Byte,jadex.bridge.service.types.message.ICodec> codecs

The available codecs for awareness infos (cached for speed).

defcodecs

protected jadex.bridge.service.types.message.ICodec[] defcodecs

The default codecs (used for relay-to-relay communication).

peers

protected PeerList peers

The peer list.

statsdb

protected StatsDB statsdb

The statistics database (if any).

conman

protected jadex.platform.service.message.transport.httprelaymtp.RelayConnectionManager conman

The connection manager for communicating with remote peers.

Constructor Detail

RelayHandler

public RelayHandler()

Initialize the handler.

Method Detail

dispose

public void dispose()

Cleanup on shutdown.

getSettings

public RelayServerSettings getSettings()

Get the settings.

getConnectionManager

public jadex.platform.service.message.transport.httprelaymtp.RelayConnectionManager getConnectionManager()

Get the connection manager.

getPeerList

public PeerList getPeerList()

Get the peer list.

initConnection

public void initConnection(java.lang.String id,
                           java.lang.String hostip,
                           java.lang.String hostname,
                           java.lang.String protocol)

Called when a platform registers itself at the relay. Initializes required data structures, such that messages can be queued.

handleConnection

public void handleConnection(java.lang.String id,
                             java.io.OutputStream out)

Called when a platform registers itself at the relay. Blocks the thread until the platform disconnects.

handleMessage

public void handleMessage(java.io.InputStream in,
                          java.lang.String protocol)
                   throws java.lang.Exception

Called when a message should be sent.

Throws:

java.lang.Exception

handleAwareness

public void handleAwareness(java.io.InputStream in)
                     throws java.lang.Exception

Called when an awareness info is received from a connected platform.

Throws:

java.lang.Exception

handleOffline

public void handleOffline(java.lang.String hostip,
                          java.io.InputStream in)
                   throws java.lang.Exception

Called when an offline status change is posted by a platform.

Throws:

java.lang.Exception

handlePlatform

public void handlePlatform(java.io.InputStream in)
                    throws java.lang.Exception

Called when a single platform info is received from a peer relay server.

Throws:

java.lang.Exception

handlePlatforms

public void handlePlatforms(java.io.InputStream in)
                     throws java.lang.Exception

Called when platform infos are received from a peer relay server.

Throws:

java.lang.Exception

handleSyncRequest

public void handleSyncRequest(java.lang.String peerid,
                              int startid,
                              int cnt,
                              java.io.OutputStream out)
                       throws java.lang.Exception

Send requested db entries.

Throws:

java.lang.Exception

getCurrentPlatforms

public PlatformInfo[] getCurrentPlatforms()

Get the current platforms

getStatisticsDB

public StatsDB getStatisticsDB()

Get the statistics database (if any).

getCurrentPeers

public PeerHandler[] getCurrentPeers()

Get the current peers.

handleServersRequest

public java.lang.String handleServersRequest(java.lang.String requesturl,
                                             java.lang.String peerurl,
                                             java.lang.String peerid,
                                             int peerstate,
                                             boolean initial)

Get the available servers as comma-separated list of URLs. Also updates the known peers, if necessary.

Parameters:

requesturl - Public URL of this relay server as known from the received request.

peerurl - URL of a remote peer if sent as part of the request (or null).

peerstate - Latest DB id if sent as part of the request (or -1).

initial - True when remote peer recovers from failure (or false).

sendPlatformInfo

public void sendPlatformInfo(PlatformInfo info)

Send a single platform info to all peer relay servers.

sendPlatformInfos

public void sendPlatformInfos(PeerHandler peer,
                              PlatformInfo[] infos)

Send platform infos to a peer relay server.

sendAwarenessInfos

protected void sendAwarenessInfos(jadex.bridge.service.types.awareness.AwarenessInfo awainfo,
                                  jadex.bridge.service.types.message.ICodec[] pcodecs,
                                  boolean local,
                                  boolean initial)

Send awareness messages for a new or changed awareness info.

readString

public static java.lang.String readString(java.io.InputStream in)
                                   throws java.io.IOException

Read a string from the given stream.

Parameters:

in - The input stream.

Returns:

The string.

Throws:

java.io.IOException - when the stream is closed.

readData

protected static byte[] readData(java.io.InputStream is,
                                 int length)
                          throws java.io.IOException

Read data into a byte array.

Throws:

java.io.IOException

getLogger

public static java.util.logging.Logger getLogger()

Get the logger.