info.pppc.base.system

Interface ISession

All Known Implementing Classes:

PluginManager.Session

public interface ISession

The session is used to create a communication stack and to request new stacks. Additionally it is used to transfer some session data to a remote plug-in. A semantic plug-in can reuse the context to create multiple stacks with the same connection properties.

Author:

Marcus Handte

Method Summary

Methods

Modifier and Type	Method and Description
short	getAbility() Returns the ability of the session.
ISession	getChild() Returns the child session bound to this session.
java.lang.Object	getLocal() Returns some local parameters that have been set previously.
byte[]	getRemote() Returns the remote parameters that are set at this session.
SystemID	getTarget() Returns the target of the session.
boolean	isIncoming() Determines whether the session specification denotes an incoming session specification.
boolean	isOutgoing() Determines whether the session specification denotes an outgoing session.
void	setLocal(java.lang.Object data) Sets the local parameters during the negotiation phase.
void	setRemote(byte[] data) Sets the remote parameters that are transfered to a remote plug-in whenever the session is opened.
boolean	supportsRemote() Determines whether the session specification supports remote parameters.

Method Detail

getLocal

java.lang.Object getLocal()

Returns some local parameters that have been set previously. These parameters are not transfered to a remote plug-in.

Returns:

The local data that has been negotiated previously.

setLocal

void setLocal(java.lang.Object data)

Sets the local parameters during the negotiation phase. These parameters are not transfered to a remote plug-in.

Parameters:

data - The local parameters to set.

setRemote

void setRemote(byte[] data)

Sets the remote parameters that are transfered to a remote plug-in whenever the session is opened. Note that this option is not available for transceiver plug-ins. A plug-in can determine the validity of this call by checking the value of the is remote method.

Parameters:

data - The remote data that is transfered to the other end point.

Throws:

java.lang.RuntimeException - Thrown if the remote data cannot be accessed.

getRemote

byte[] getRemote()

Returns the remote parameters that are set at this session. Note that this option is not available for transceiver plug-ins. A plug-in can determine the validity of this call by checking the value of the is remote method.

Returns:

The remote data that is set at this plug-in.

Throws:

java.lang.RuntimeException - Thrown if the remote data cannot be accessed.

supportsRemote

boolean supportsRemote()

Determines whether the session specification supports remote parameters. Most session specifications support remote parameters. The only session specification that does not support remote parameters is the one used for transceiver plug-ins. However, transceiver plug-ins can serialize their remote parameters before any connector is passed to the broker. Thus, transceiver plug-ins can perform their own initialization without remote data.

Returns:

True if the session supports remote parameters, false otherwise.

isIncoming

boolean isIncoming()

Determines whether the session specification denotes an incoming session specification. This means that this session data has been created by some remote plug-in. Note that incoming session specifications cannot be used to initialize connectors. However, semantic plug-ins can use the plug-in manager's prepare session method to transform an incoming session into an outgoing.

Returns:

True if the session is incoming, false if it is outgoing.

isOutgoing

boolean isOutgoing()

Determines whether the session specification denotes an outgoing session. Outgoing sessions can be used to initialize connectors.

Returns:

True if the session is outgoing, false otherwise.

getTarget

SystemID getTarget()

Returns the target of the session. This is the device id of the device for which this session has been created.

Returns:

The target device of the session.

getAbility

short getAbility()

Returns the ability of the session. This is the ability of the plug-in that is bound to this session.

Returns:

The ability of the session.

getChild

ISession getChild()

Returns the child session bound to this session. This is the session that represents the plug-in below the current session. If no session is bound, the method returns null.

Returns:

The child session or null, if there is none.