org.avineas.fins.gw

Class Gateway

java.lang.Object

org.avineas.fins.gw.Gateway

public class Gateway
extends java.lang.Object

Class that implements the FINS gateway functionality. It takes care of forwarding FINS messages to the right UDP node/port combination. The resolution of FINS nodes to IP nodes is done using a pre-defined node map that should be configured at bootstrap time, but the gateway is learning itself from frames it receives from remote nodes.
The local nodes should be configured at boot time as well.
If debugging for this object is enabled, all datagram frames are printed to the logger. If info is enabled, only the summary is logged

Since:

6-11-2005

Author:

Arie van Wijngaarden

Constructor Summary

Constructors

Constructor and Description
Gateway()

Method Summary

Methods

Modifier and Type	Method and Description
void	addUnit(Address addr, Unit unit) Add a unit to the unit set, meaning that it is registered to be working with this gateway.
void	destroy() Destroy method for shutting down the thread.
long	getTimeout() Get the time-out time, in ms, in which replies should be received.
int	getTries() Get the number of tries that take place during sending to an other node before the message is considered to be un-deliverable.
void	init() The after properties set method of this gateway.
boolean	removeUnit(Address addr) Remove a unit with a specific address.
void	setPort(int port) Set the local UDP port of this gateway.
void	setRemoteNodes(java.util.Map<java.lang.String,java.lang.String> nodes) Method that is called during bootstrap to set the remote node definition.
void	setTimeout(long timeout) Set the timeout, in ms in which replies should be received back from remote nodes.
void	setTries(int tries) Set the number of times a packet will be sent before it is considered as not deliverable.
void	setUnits(java.util.Map<java.lang.String,Unit> unitMap) Method that should be called at boot strap to set the units that are local to this gateway.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Gateway

public Gateway()

Method Detail

setRemoteNodes

public void setRemoteNodes(java.util.Map<java.lang.String,java.lang.String> nodes)
                    throws java.net.UnknownHostException

Method that is called during bootstrap to set the remote node definition. This is the mapping from FINS nodes to IP/port combinations of the destination gateways.

Parameters:

nodes - A map with FINS node/UDP host/port combinations. Fins nodes should be specified as string value "network/node" the UDP combination as "ipaddress:port", like "0/1" -> "remotehost:9000"

Throws:

java.net.UnknownHostException - In case the IP host is not known

addUnit

public void addUnit(Address addr,
           Unit unit)

Add a unit to the unit set, meaning that it is registered to be working with this gateway.

Parameters:

addr - The address of the unit, should be in unit format like 12/3/1, indicating the network, node and unit respectively

unit - The unit to register with this address

removeUnit

public boolean removeUnit(Address addr)

Remove a unit with a specific address.

Parameters:

addr - The address to remove

Returns:

An indication whether a unit was serving this address

setUnits

public void setUnits(java.util.Map<java.lang.String,Unit> unitMap)

Method that should be called at boot strap to set the units that are local to this gateway. This map should contain a unit as "network/node/unit" string and the value must be a valid Unit implementation. As an alternative, addUnit(Address, Unit) can be used to add units at run-time.

Parameters:

unitMap - The map with FINS unit address/Unit interface combinations

setPort

public void setPort(int port)
             throws java.net.SocketException

Set the local UDP port of this gateway.

Parameters:

port - The UDP port number

Throws:

java.net.SocketException

init

@PostConstruct
public void init()
          throws java.net.SocketException

The after properties set method of this gateway. The method initializes a new thread that continuously reads from the UDP port for getting data for local (or remote) nodes. This method must be called before actual receiving of data can take place.

Throws:

java.net.SocketException

getTimeout

public long getTimeout()

Get the time-out time, in ms, in which replies should be received.

Returns:

The time out value

setTimeout

public void setTimeout(long timeout)

Set the timeout, in ms in which replies should be received back from remote nodes.

Parameters:

timeout - The timeout in ms

getTries

public int getTries()

Get the number of tries that take place during sending to an other node before the message is considered to be un-deliverable.

Returns:

The number of tries, defaults to 3

setTries

public void setTries(int tries)

Set the number of times a packet will be sent before it is considered as not deliverable.

Parameters:

tries - The number of times a packet will be sent and waited for

destroy

@PreDestroy
public void destroy()

Destroy method for shutting down the thread. Must be called on destruction of this gateway.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object