EclipseLink 1.0_1.0M2 API Reference - Incubation

org.eclipse.persistence.sessions.remote
Class SessionAnnouncement

java.lang.Object
  extended by org.eclipse.persistence.sessions.remote.SessionAnnouncement
All Implemented Interfaces:
java.io.Serializable

Deprecated. since OracleAS TopLink 10g (10.1.3). This class is replaced by CommandManager

public class SessionAnnouncement
extends java.lang.Object
implements java.io.Serializable

INTERNAL: Message sent over the multicast group that identifies the session to which this announcement applies. Also specified in each announcement is the host from which this announcement originates, and an id identifiying the sending VM on that host.

See Also:
Serialized Form

Constructor Summary
SessionAnnouncement(byte[] bytes)
          Deprecated. INTERNAL: Builds a SessionAnnouncement to use in the communication framework.
SessionAnnouncement(java.lang.String sessionIdentifier, java.lang.String jndiHostURL, java.lang.String applicationName)
          Deprecated. INTERNAL: Builds a SessionAnnouncement to use in the communication framework.
 
Method Summary
 java.lang.String getApplicationName()
          Deprecated.  
 java.lang.String getJNDIHostURL()
          Deprecated. PUBLIC: Use this method to retreive the JNDI service URL for transmission
 java.lang.String getSessionId()
          Deprecated. PUBLIC: This method must return the value that will uniquely identify the Session that is sending the message and must be the value that is used to store the dispatcher in the JNDI service.
 void readFromBytes(byte[] bytes)
          Deprecated. INTERNAL: Initialize the instance fields from the bytes.
 void setJNDIHostURL(java.lang.String jndiHostURL)
          Deprecated. PUBLIC: Use this method to set the JNDI service URL for transmission
 void setSessionId(java.lang.String sessionId)
          Deprecated. PUBLIC: This method stores the session ID for this announcement This value represents the Unique identifier for the session
 byte[] toBytes()
          Deprecated. Convert the instance fields to bytes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SessionAnnouncement

public SessionAnnouncement(byte[] bytes)
                    throws SynchronizationException
Deprecated. 
INTERNAL: Builds a SessionAnnouncement to use in the communication framework. This constructor is used when receiving a message

Throws:
SynchronizationException

SessionAnnouncement

public SessionAnnouncement(java.lang.String sessionIdentifier,
                           java.lang.String jndiHostURL,
                           java.lang.String applicationName)
Deprecated. 
INTERNAL: Builds a SessionAnnouncement to use in the communication framework. This constructor is used when creating a message

Method Detail

setSessionId

public void setSessionId(java.lang.String sessionId)
Deprecated. 
PUBLIC: This method stores the session ID for this announcement This value represents the Unique identifier for the session

Parameters:
sessionId -
SBGen:
Method set sessionId

getSessionId

public java.lang.String getSessionId()
Deprecated. 
PUBLIC: This method must return the value that will uniquely identify the Session that is sending the message and must be the value that is used to store the dispatcher in the JNDI service.

SBGen:
Method get sessionId

readFromBytes

public void readFromBytes(byte[] bytes)
Deprecated. 
INTERNAL: Initialize the instance fields from the bytes. Assumptions: - Same character converters exist on the reading and storing sides Byte map: 1 byte = size of session id string (sessionIdLength) sessionIdLength bytes = session id string 1 byte = size of JNDI Service URL (jndiServiceURLLength) jndiServiceURLLength bytes = JNDI Service URL string


toBytes

public byte[] toBytes()
Deprecated. 
Convert the instance fields to bytes. Assumptions: - Same character converters exist on the reading and storing sides - host name converted to bytes < 256 bytes Byte map: 1 byte = size of session id string (sessionIdLength) sessionIdLength bytes = session id string 1 byte = size of host name (nameLength) nameLength bytes = host name string


getApplicationName

public java.lang.String getApplicationName()
Deprecated. 

getJNDIHostURL

public java.lang.String getJNDIHostURL()
Deprecated. 
PUBLIC: Use this method to retreive the JNDI service URL for transmission

SBGen:
Method get jndiHostURL

setJNDIHostURL

public void setJNDIHostURL(java.lang.String jndiHostURL)
Deprecated. 
PUBLIC: Use this method to set the JNDI service URL for transmission

SBGen:
Method set jndiHostURL

EclipseLink 1.0_1.0M2 API Reference - Incubation