org.universAAL.ri.gateway

Class Session

java.lang.Object

org.universAAL.ri.gateway.Session

All Implemented Interfaces:

OperationChainManager, MessageReceiver, MessageSender

public class Session
extends Object
implements MessageSender, MessageReceiver, OperationChainManager

Representation of a one to one link between 2 ASGs. It is in charge of connecting the communication layer with the Importer and proxies.

Version:

$LastChangedRevision$ ($LastChangedDate$)

Author:

amedrano, Stefano "Kismet" Lenzi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Session.SessionStatusEvent

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	log

Constructor Summary

Constructors

Constructor and Description
Session(Configuration config, ProxyPool proxyPool)
Session(Configuration config, ProxyPool proxyPool, ServerSocketCommunicationHandler com)

Method Summary

Modifier and Type	Method and Description
boolean	addSessionEventListener(SessionEventListener listener) Add a listener even it has not been already added
boolean	getCacheBeforeConnect() Get the configuration that states that the gateway should cache messages before actual connection.
SocketCipher	getCipher()
Configuration	getConfiguration()
ParameterCheckOpertaionChain	getExportOperationChain() The security checks that a BusMember has to pass in order to be allowed to be exported.
ParameterCheckOpertaionChain	getImportOperationChain() The security checks that a ImportRequest has to pass in order to be allowed to create a proxy for it.
MessageOperationChain	getIncomingMessageOperationChain() The security checks that an incoming WrappedBusMessage has to pass in order to be allowed to interpreted by the proxy.
MessageOperationChain	getOutgoingMessageOperationChain() The security checks that an outgoing WrappedBusMessage has to pass in order to be allowed to transmitted to peer.
String	getScope()
SessionEvent.SessionStatus	getStatus()
long	getTimeout() Gets timeout configuration for session.
void	handleMessage(Message msg) Receives the Message from the communication layer, delivering it to the appropriate subcomponent.
boolean	isActive()
void	removeImports() To be called when the session is to be closed.
boolean	removeSessionEventListener(SessionEventListener listener) Remove a listener from the listeners if and only if the listener has already been added
void	send(Message message) Send Asynchronously a Message independent of which level it is, to a remote ASG.
Message	sendRequest(Message message) Send a request Synchronously to which a response is expected.
void	setScope(String scope)
void	setStatus(SessionEvent.SessionStatus status)
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final Logger log

Constructor Detail

Session

public Session(Configuration config,
               ProxyPool proxyPool,
               ServerSocketCommunicationHandler com)

Session

public Session(Configuration config,
               ProxyPool proxyPool)

Method Detail

setScope

public void setScope(String scope)

Parameters:

scope - the String representing the scope of this Session. At the moment the Scope is represented by the SpaceId of the Space that we are connected to

getScope

public String getScope()

Returns:

the String representing the scope of this Session. At the moment the Scope is represented by the SpaceId of the Space that we are connected to

getConfiguration

public Configuration getConfiguration()

send

public void send(Message message)

Description copied from interface: MessageSender

Send Asynchronously a Message independent of which level it is, to a remote ASG.
It may also used to send responses.

Specified by:

send in interface MessageSender

sendRequest

public Message sendRequest(Message message)
                    throws TimeoutException

Description copied from interface: MessageSender

Send a request Synchronously to which a response is expected.

Specified by:

sendRequest in interface MessageSender

Parameters:

message - to send, typically a request message

Returns:

the response message, typically a response message.

Throws:

TimeoutException

getImportOperationChain

public ParameterCheckOpertaionChain getImportOperationChain()

Description copied from interface: OperationChainManager

The security checks that a ImportRequest has to pass in order to be allowed to create a proxy for it.

Specified by:

getImportOperationChain in interface OperationChainManager

Returns:

getExportOperationChain

public ParameterCheckOpertaionChain getExportOperationChain()

Description copied from interface: OperationChainManager

The security checks that a BusMember has to pass in order to be allowed to be exported.

Specified by:

getExportOperationChain in interface OperationChainManager

Returns:

getIncomingMessageOperationChain

public MessageOperationChain getIncomingMessageOperationChain()

Description copied from interface: OperationChainManager

The security checks that an incoming WrappedBusMessage has to pass in order to be allowed to interpreted by the proxy.

Specified by:

getIncomingMessageOperationChain in interface OperationChainManager

Returns:

getOutgoingMessageOperationChain

public MessageOperationChain getOutgoingMessageOperationChain()

Description copied from interface: OperationChainManager

The security checks that an outgoing WrappedBusMessage has to pass in order to be allowed to transmitted to peer.

Specified by:

getOutgoingMessageOperationChain in interface OperationChainManager

Returns:

handleMessage

public void handleMessage(Message msg)

Receives the Message from the communication layer, delivering it to the appropriate subcomponent.

Specified by:

handleMessage in interface MessageReceiver

getCipher

public SocketCipher getCipher()

stop

public void stop()

addSessionEventListener

public boolean addSessionEventListener(SessionEventListener listener)

Add a listener even it has not been already added

Parameters:

listener - the listener to add

Returns:

true if the listener has been registered

removeSessionEventListener

public boolean removeSessionEventListener(SessionEventListener listener)

Remove a listener from the listeners if and only if the listener has already been added

Parameters:

listener - the listener to remove

Returns:

true if the listener has been removed

setStatus

public void setStatus(SessionEvent.SessionStatus status)

getStatus

public SessionEvent.SessionStatus getStatus()

isActive

public boolean isActive()

Returns:

removeImports

public void removeImports()

To be called when the session is to be closed.
Removes all associations in all proxies with the session, and closes those left orphan.

Parameters:

session -

getTimeout

public long getTimeout()

Gets timeout configuration for session.

Returns:

negative infinite timeout, timeout in milisec IOC

getCacheBeforeConnect

public boolean getCacheBeforeConnect()

Get the configuration that states that the gateway should cache messages before actual connection.

Returns:

true IFF the messages should be cached before connection