| java.lang.Object
 org.datashare.objects.DefaultObjectInfo
org.datashare.SessionInfo
| Field Summary | |
| boolean | privateSession
true indicates that only the owner and those in the Session can see it,
false is the default and means that all clients/users can see the Session. | | boolean | saveData
| | final static long | serialVersionUID
this allows us to serialize this class without 'marshalling' errors, and to
invalidate instances that are 'different' (too old or new). |
| Method Summary | |
| public void | addChannel(ChannelInfo channel)
| | public boolean | getAutoDelete()
if true, indicates that any Channels in this Session will be deleted once the last Consumer leaves, note
that at least one consumer must leave first (implying that at least one Consumer must have joined). | | public DataShareConnectionDescriptor[] | getChannelConnectionDescriptors()
| | public Hashtable | getChannelTable()
| | public String | getDatabaseID()
Retrieves the ADSKey String for this instance. | | public String | getInfo()
| | public String | getOwnerName()
| | public boolean | getPrivate()
| | public String | getSessionDescription()
| | public String | getType()
| | public boolean | isSubSet(SessionInfo sessionInfo)
used to determine if a session already exists, compares session name,
session description, clientClass, and any channels in the object (sessionInfo) must also exist in
this instance as determined by having the same name. | | public void | removeChannel(ChannelInfo channel)
| | public void | setAutoDelete()
when called, causes any Channels in this Session to be deleted once the last Consumer leaves, note
that at least one consumer must leave first (implying that at least one Consumer must have joined). | | public void | setCreationDate(Date date)
allows us to set a creation date, used only when an instance is created to replicate
the original SessionInfo, as in the case of retrieving the Session information from
history to make a new SessionInfo look like the original one. | | public void | setDatabaseID(String ak)
Sets the ADSKey String for this instance to the provided parameter value. | | public void | setSessionDescription(String sessionDescription)
|
| privateSession | | boolean privateSession(Code) | | true indicates that only the owner and those in the Session can see it,
false is the default and means that all clients/users can see the Session.
Note that this must be set after the instance is created because it is not
a parameter of the constructor.
|
| saveData | | boolean saveData(Code) | | set to the server's value of saveData, saves data about the Session, not the data in it's channel(s)
|
| serialVersionUID | | final static long serialVersionUID(Code) | | this allows us to serialize this class without 'marshalling' errors, and to
invalidate instances that are 'different' (too old or new).
|
| SessionInfo | | public SessionInfo(String sessionName, String sessionDescription, String owningClientName, String clientClass, boolean saveData)(Code) | | class constructor, assigns a keyValue automatically
Parameters:
sessionName - the Session name for this instance, must be unique on Server
Parameters:
sessionDescription - a description for this session
Parameters:
owningClientKey - the client userName that created this Session
Parameters:
saveData - used to determine if the server is creating/saving data |
| addChannel | | public void addChannel(ChannelInfo channel)(Code) | | adds a Channel to this Session
Parameters:
channel - the channel to be added to this session |
| getAutoDelete | | public boolean getAutoDelete()(Code) | | if true, indicates that any Channels in this Session will be deleted once the last Consumer leaves, note
that at least one consumer must leave first (implying that at least one Consumer must have joined).
|
| getChannelConnectionDescriptors | | public DataShareConnectionDescriptor[] getChannelConnectionDescriptors()(Code) | | returns the DataShareConnectionDescriptors for all channels in this Session
|
| getChannelTable | | public Hashtable getChannelTable()(Code) | | returns the Hashtable of Channels for this Session
all Channels in this Session |
| getDatabaseID | | public String getDatabaseID()(Code) | | Retrieves the ADSKey String for this instance. Should always be checked for null.
Also realize that this method may block until the ADSKey value is available.
the ADSKey String that was previously set for this instance. |
| getInfo | | public String getInfo()(Code) | | Should return as much info about this Session as possible
a String with this Session name and other relevant comments |
| getOwnerName | | public String getOwnerName()(Code) | | allows the owner of this Session to be retreived
the Client that requested the creation of this Session |
| getPrivate | | public boolean getPrivate()(Code) | | if return value is true, this is a private Session
|
| getSessionDescription | | public String getSessionDescription()(Code) | | allows the description for this Session to be retreived
the description of the purpose for the creation of this Session |
| getType | | public String getType()(Code) | | returns 'Session' string, used when this class is accessed as its superclass
to determine which subclass this class is
sessionType attribute (final static) |
| isSubSet | | public boolean isSubSet(SessionInfo sessionInfo)(Code) | | used to determine if a session already exists, compares session name,
session description, clientClass, and any channels in the object (sessionInfo) must also exist in
this instance as determined by having the same name. This instance may contain additional channels
and still be considered equal to the object (sessionInfo).
|
| removeChannel | | public void removeChannel(ChannelInfo channel)(Code) | | removes a Channel from this Session
Parameters:
channel - the channel to be removed from this session |
| setAutoDelete | | public void setAutoDelete()(Code) | | when called, causes any Channels in this Session to be deleted once the last Consumer leaves, note
that at least one consumer must leave first (implying that at least one Consumer must have joined).
|
| setCreationDate | | public void setCreationDate(Date date)(Code) | | allows us to set a creation date, used only when an instance is created to replicate
the original SessionInfo, as in the case of retrieving the Session information from
history to make a new SessionInfo look like the original one.
|
| setDatabaseID | | public void setDatabaseID(String ak)(Code) | | Sets the ADSKey String for this instance to the provided parameter value.
The ADSKey String is the value provided when the EJB was created for this instance.
Parameters:
ak - the value to save as the ID for this instance |
| setSessionDescription | | public void setSessionDescription(String sessionDescription)(Code) | | allows the description for this Session to be saved
Parameters:
sessionDescription - the purpose for the creation of this Session |
|
|