info.pppc.base.system

Class PluginManager.Session

java.lang.Object

info.pppc.base.system.PluginManager.Session

All Implemented Interfaces:

ISession

Enclosing class:

PluginManager

public final class PluginManager.Session
extends java.lang.Object
implements ISession

The session implementation used by the plug-in manager. At the present time this is a list. If we want to add multicast at a lower level, we would have to transform this into a tree structure.

Author:

Marcus Handte

Constructor Summary

Constructors

Constructor and Description
PluginManager.Session(SystemID target, short ability, boolean remote, boolean incoming) Creates a new session object that denotes a plug-in with the specified ability.

Method Summary

Methods

Modifier and Type	Method and Description
PluginManager.Session	copy(boolean deep) Creates a copy of the session.
short	getAbility() Returns the ability of the session.
ISession	getChild() Returns the child of the session.
java.lang.Object	getLocal() Returns the local data object that has been negotiated during the negotiation phase.
PluginManager.Session	getParent() Returns the parent of the session.
byte[]	getRemote() Returns the remote data that is currently set.
SystemID	getTarget() Returns the target of the session.
boolean	isIncoming() Determines whether the session is incoming.
boolean	isOutgoing() Determines whether the session is outgoing.
void	setChild(PluginManager.Session child) Sets the child of the session.
void	setLocal(java.lang.Object data) Sets the local data object that contains the negotiated connection properties that are required to open a connection.
void	setParent(PluginManager.Session parent) Sets the parent of the session.
void	setRemote(byte[] data) Sets the remote data that will be transfered to the other endpoint.
boolean	supportsRemote() Determines whether it is valid to set and retrieve the remote data bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginManager.Session

public PluginManager.Session(SystemID target,
                     short ability,
                     boolean remote,
                     boolean incoming)

Creates a new session object that denotes a plug-in with the specified ability. The boolean parameter determines whether the plug-in will throw an exception if the remote data is set. Setting remote data is not allowed for transceiver plug-ins.

Parameters:

ability - The ability of the plug-in denoted by this session object.

remote - True if the remote session data can be stored, false if storing remote session data should throw an exception.

target - The remote system that would be the target of the session.

incoming - A flag that indicates whether the specified session is incoming.

Method Detail

getLocal

public java.lang.Object getLocal()

Returns the local data object that has been negotiated during the negotiation phase.

Specified by:

getLocal in interface ISession

Returns:

The local data object negotiated previously.

setLocal

public void setLocal(java.lang.Object data)

Sets the local data object that contains the negotiated connection properties that are required to open a connection.

Specified by:

setLocal in interface ISession

Parameters:

data - The local data object required to open a connection.

setRemote

public void setRemote(byte[] data)

Sets the remote data that will be transfered to the other endpoint. If the remote data cannot be accessed, this method will thrown an exception.

Specified by:

setRemote in interface ISession

Parameters:

data - The remote data to set.

Throws:

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

getRemote

public byte[] getRemote()

Returns the remote data that is currently set. If the remote data cannot be accessed this method will throw an exception.

Specified by:

getRemote in interface ISession

Returns:

The remote data that has been set previously.

Throws:

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

supportsRemote

public boolean supportsRemote()

Determines whether it is valid to set and retrieve the remote data bytes.

Specified by:

supportsRemote in interface ISession

Returns:

True if the remote data can be accessed, false otherwise.

isIncoming

public boolean isIncoming()

Determines whether the session is incoming.

Specified by:

isIncoming in interface ISession

Returns:

True if it is incoming, false otherwise.

isOutgoing

public boolean isOutgoing()

Determines whether the session is outgoing.

Specified by:

isOutgoing in interface ISession

Returns:

True if it is outgoing, false otherwise.

setParent

public void setParent(PluginManager.Session parent)

Sets the parent of the session. This is the communication layer above this session.

Parameters:

parent - The new parent of the session.

getParent

public PluginManager.Session getParent()

Returns the parent of the session. This is the communication layer above this plug-in.

Returns:

The parent of the session or null if none is set.

setChild

public void setChild(PluginManager.Session child)

Sets the child of the session. This is the communication layer below this session.

Parameters:

child - The new child of the session.

getChild

public ISession getChild()

Returns the child of the session. This is the communication layer below this session.

Specified by:

getChild in interface ISession

Returns:

The child of the session or null if none is set.

getTarget

public SystemID getTarget()

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

Specified by:

getTarget in interface ISession

Returns:

The target device of the session.

getAbility

public short getAbility()

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

Specified by:

getAbility in interface ISession

Returns:

The ability of the session.

copy

public PluginManager.Session copy(boolean deep)

Creates a copy of the session. The copy can either be deep or shallow. If it is deep, the parent and child of the session will be copied recursively. Otherwise the parent and child of the new copy will be null.

Parameters:

deep - A flag that indicates whether the copy should be deep or shallow.

Returns:

The deep or shallow copy of the session.