All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class ncsa.habanero.Session

java.lang.Object
   |
   +----ncsa.habanero.ModelObject
           |
           +----ncsa.habanero.Targetable
                   |
                   +----ncsa.habanero.Sharable
                           |
                           +----ncsa.habanero.Session

public class Session

extends Sharable

bSessionInSingleStream

commMgr

infoS

keyGenerator

owner

pm

recordingInProgress

sessionID

startTime

stopped

Session()

This a default constructor for marshalling

Session(String, Arbitrator, SessionParticipant, SessionInfo)

First initialize my superclass.

addCommunicator(Communicator)

addCommunicator(Sharable, Communicator)

addParticipant(SessionParticipant)

Adding a participant requires telling the ParticipantManager to add it.

AddSubModel(ModelObject, Object)

Adds the given object as a child.

addTool(Collobject)

askServer(Answerable)

canAskServer()

changeSessionInfo(SessionInfo)

collobjectQuitting(Collobject)

containsParticipant(SessionParticipant)

countParticipants()

dumpSelf(MarshallOutput, String)

finishCapture(String)

flagStopped()

freezeInput(Sharable)

getHostName()

getInfoAsString()

Returns a string with info about this session

getKeyGenerator()

GetListTool()

getParticipant(String)

Get the participant with the given id.

getParticipantList()

getReplayController()

getReplayMonitor()

getReplaySocketGenerator()

getSessionInfo()

handleNewConnection(MarshallInput, MarshallOutput)

id()

Return my identifier.

invite(SessionParticipant)

isRecording()

isShared()

isStopped()

key()

My identifier is my key in my parent's table of children.

leave(boolean)

makeLocal()

makeMark(String)

newConnection(String, MarshallOutput)

This is called when a participant's arbitrator makes a new connection to any of my children's arbitrators.

notifyCollobjectsRecording(boolean)

owner()

Return the participant who owns me.

postMessage(ServerMessage, Arbitrator)

postMessage(ServerMessage, Arbitrator, String)

queryObserverFactory(Object)

queryToolCount()

readInfo(MarshallInput)

this is the inverse of writeInfo :) returns the session port number

readSession(ObjectInput, boolean)

readTools(Vector)

receiveMulticastInformation(MarshallInput)

this function receives information regarding whether this session can multicast and if so how/where to receive the multicast information

recordActionGranted(ActionGranted)

register(Observer)

Register an observer with the ParticipantManager.

removeAllParticipants()

Really only remove other participants but myself

removeCommunicator(Communicator)

removeParticipant(SessionParticipant)

Removing a participant requires telling the ParticipantManager to remove it.

RemoveSubModel(ModelObject)

Removes the given object from the list of children.

resetVariablesForReplay()

sendMulticastInformation(MarshallOutput)

this function sends enough information so that the sender knows how/where to talk for multicast communication

setKeyGenerator(KeyGen)

setObserverFactory(Object, ObserverFactory)

setOwner(SessionParticipant)

setPort(int, int)

setSingleStreamForCollobjects(boolean)

shutDown()

singleStreamForCollobjects()

startCapture(String, boolean)

startRecording(String)

startReplayArbitrators()

stealCollobject(Session, Collobject)

stop()

stopRecording(SessionParticipant, boolean)

subModels()

thawInput(Sharable)

toolList()

unregister(Observer)

Unregister an observer with the ParticipantManager.

writeInfo(MarshallOutput)

write relevant connection information to the output object.

writeTools(MarshallOutput)

 protected SessionInfo infoS

 protected ParticipantManager pm

 protected String sessionID

 protected SessionParticipant owner

 protected transient Hashtable recordingInProgress

 protected CommManager commMgr

 protected KeyGen keyGenerator

 protected boolean bSessionInSingleStream

 protected Date startTime

 protected transient boolean stopped

 public Session(String id,
                Arbitrator inner,
                SessionParticipant who,
                SessionInfo i)

First initialize my superclass. Then create my arbitrator, which is required to be a special SessionArbitrator, and which wraps the Arbitrator I am passed as an argument. I also store my id and my owner.

 public Session()

This a default constructor for marshalling

 protected boolean addCommunicator(Communicator c)

 protected boolean addCommunicator(Sharable key,
                                   Communicator c)

 protected void removeCommunicator(Communicator c)

 public void collobjectQuitting(Collobject co)

 public String getHostName()

 public void handleNewConnection(MarshallInput in,
                                 MarshallOutput out) throws IOException

 public void postMessage(ServerMessage message,
                         Arbitrator from)

 public void postMessage(ServerMessage message,
                         Arbitrator from,
                         String strWho)

Parameters:

message - the message we want to send

from - the arbitrator sending the message

strWho - the designated receiver

Returns:

sends a message to a specific individual

 public boolean askServer(Answerable a)

 public boolean canAskServer()

 public void startCapture(String key,
                          boolean bArbitratorToo)

Parameters:

key - a description of which recorder should start recording

bArbitratorToo - should the arbitrator record too

Returns:

starts recording

 public void finishCapture(String key)

 protected void resetVariablesForReplay()

Returns:

resets the variables of some arbitrators so that everything can run properly

 protected void readTools(Vector toolNames) throws IOException, ClassNotFoundException

 public void startReplayArbitrators()

Returns:

starts the replay arbitrators

 public void setPort(int nCollobjectNumber,
                     int nPortNumber)

Parameters:

nCollobjectNumber - the number of the collobject

nPortNumber - the number of the new port

Returns:

sets the port of the new arbitrator

 public void readSession(ObjectInput in,
                         boolean bCopyParticipants) throws IOException, ClassNotFoundException

Parameters:

in - the input stream

bCopyParticipants - should the participants be copied too?

Returns:

rereads the object

 public void stealCollobject(Session oldSession,
                             Collobject tool)

Parameters:

oldSession - - the old session

tool - - the collobject we are stealing

Returns:

moves the tool from the old session to the current session

 public synchronized boolean addParticipant(SessionParticipant client)

Adding a participant requires telling the ParticipantManager to add it.

 public synchronized SessionParticipant getParticipant(String id)

Get the participant with the given id.

 public int countParticipants()

Returns:

Return the number of participants.

 public synchronized boolean removeParticipant(SessionParticipant client)

Removing a participant requires telling the ParticipantManager to remove it.

 public synchronized boolean containsParticipant(SessionParticipant p)

 public String id()

Return my identifier.

 public Object key()

My identifier is my key in my parent's table of children.

Overrides:

key in class ModelObject

 protected SubModels subModels()

Overrides:

subModels in class ModelObject

 public SessionParticipant owner()

Return the participant who owns me.

 protected void sendMulticastInformation(MarshallOutput out) throws IOException

this function sends enough information so that the sender knows how/where to talk for multicast communication

 protected void receiveMulticastInformation(MarshallInput in) throws IOException

this function receives information regarding whether this session can multicast and if so how/where to receive the multicast information

 public void writeInfo(MarshallOutput out) throws IOException

write relevant connection information to the output object.

 public int readInfo(MarshallInput in) throws IOException

this is the inverse of writeInfo :) returns the session port number

 public synchronized void newConnection(String participantId,
                                        MarshallOutput connection)

This is called when a participant's arbitrator makes a new connection to any of my children's arbitrators. It tries to find the SessionParticipant object representing that participant, and adds the connection information to it.

 public synchronized void flagStopped()

 public synchronized void shutDown()

Returns:

shuts down the session

Overrides:

shutDown in class Sharable

 public boolean isStopped()

Overrides:

isStopped in class Sharable

 public void setOwner(SessionParticipant p)

 public synchronized void RemoveSubModel(ModelObject inObject)

Removes the given object from the list of children.

Overrides:

RemoveSubModel in class ModelObject

 protected synchronized void AddSubModel(ModelObject inObject,
                                         Object key)

Adds the given object as a child.

Overrides:

AddSubModel in class ModelObject

 public int queryToolCount()

 public void addTool(Collobject c)

Parameters:

c - the new tool's collobject

Returns:

adds the tool

 public SessionInfo getSessionInfo()

 public Enumeration getParticipantList()

 public Enumeration GetListTool()

 public Vector toolList()

 protected void writeTools(MarshallOutput out) throws IOException

 public void changeSessionInfo(SessionInfo is)

 public void leave(boolean quitSession)

Returns:

stops the session

 public void stop()

Returns:

stops the session

 public boolean isShared()

 public boolean invite(SessionParticipant p)

 protected void removeAllParticipants()

Really only remove other participants but myself

 public void makeLocal()

 public void startRecording(String participantId)

 public void stopRecording(SessionParticipant participant,
                           boolean doSend)

 public synchronized void recordActionGranted(ActionGranted a)

 public boolean isRecording()

 public void freezeInput(Sharable toFreeze)

 public void thawInput(Sharable toThaw)

 public synchronized void dumpSelf(MarshallOutput out,
                                   String toWho) throws IOException

Overrides:

dumpSelf in class Sharable

 public void register(Observer toRegister)

Register an observer with the ParticipantManager.

 public void unregister(Observer toRegister)

Unregister an observer with the ParticipantManager.

 public void setObserverFactory(Object key,
                                ObserverFactory newFactory)

Parameters:

key - the key to look up the factory

newFactory - the new recording factory for this session

Returns:

adds the factory to the vector of factories

 public ObserverFactory queryObserverFactory(Object key)

Parameters:

key - the key to look up the factory

Returns:

the factory that is doing the recording

 public void makeMark(String key)

Parameters:

key - the observer to make a mark in

Returns:

creates a mark in the appropriate observer's files

 public void notifyCollobjectsRecording(boolean bWay)

Parameters:

bWay - are we recording or not

Returns:

notifies all collobjects that someone is recording

 public ReplayMonitor getReplayMonitor()

Returns:

the factory that is doing the recording

 public ReplaySocketGenerator getReplaySocketGenerator()

Returns:

the factory that is doing the recording

 public ReplayController getReplayController()

Returns:

the replay controller

 public KeyGen getKeyGenerator()

Returns:

the key generator for this session

 public void setKeyGenerator(KeyGen newKeyGen)

Parameters:

newKeyGen - the new key generator

Returns:

sets the key generator

 public boolean singleStreamForCollobjects()

Returns:

whether we are working with a single stream or not

 protected synchronized String getInfoAsString()

Returns a string with info about this session

 public void setSingleStreamForCollobjects(boolean bWay)

Parameters:

bWay - the way we are setting the variable

Returns:

sets the variable for a single stream or not

All Packages  Class Hierarchy  This Package  Previous  Next  Index