EclipseLink 1.0_1.0M2 API Reference - Incubation

org.eclipse.persistence.sessions.remote.jms
Class JMSClusteringService

java.lang.Object
  extended by java.lang.Thread
      extended by org.eclipse.persistence.sessions.remote.AbstractClusteringService
          extended by org.eclipse.persistence.sessions.remote.AbstractJNDIClusteringService
              extended by org.eclipse.persistence.sessions.remote.jms.JMSClusteringService
All Implemented Interfaces:
java.lang.Runnable
Direct Known Subclasses:
JMSPublishingOnlyClusteringService

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

public class JMSClusteringService
extends AbstractJNDIClusteringService

PURPOSE:To Provide a framework for offering customers the ability to automatically connect multiple sessions for synchrnization.

Descripton:This object will connect the TopLink Session to an existing JMS Topic from an existing JMS Connection Factory.

See Also:
CacheSynchronizationManager
Author:
Gordon Yorke

Nested Class Summary
 
Nested classes/interfaces inherited from class java.lang.Thread
java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
 
Field Summary
protected  java.lang.String connectionFactoryName
          Deprecated.  
protected  TopicConnection listeningConnection
          Deprecated.  
protected  java.lang.String topicName
          Deprecated.  
 
Fields inherited from class org.eclipse.persistence.sessions.remote.AbstractJNDIClusteringService
contextProperties, localContext, password, userName
 
Fields inherited from class org.eclipse.persistence.sessions.remote.AbstractClusteringService
announcementDelay, applicationName, communicationSocket, DEFAULT_MULTICAST_GROUP, DEFAULT_MULTICAST_PORT, DEFAULT_RECV_BUFFER_SIZE, dispatcher, localHostURL, multicastGroupAddress, multicastPort, reconnectionPolicy, session, sessionId, stopListening, timeToLive
 
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
 
Constructor Summary
JMSClusteringService(Session session)
          Deprecated. PUBLIC: Creates a JMSClusteringService
 
Method Summary
 void connectBackToRemote(RemoteConnection connection)
          Deprecated. INTERNAL: This method is called by the cache synchronization manager when this server should connect back ('handshake') to the server from which this remote connection came.
 RemoteConnection createRemoteConnection()
          Deprecated. ADVANCED: This method should return a remote connection of the appropraite type for use in the synchronization
 RemoteConnection createRemoteConnection(java.lang.String sessionId, java.lang.String jndiHostURL)
          Deprecated. ADVANCED: This method should return a remote connection of the appropraite type for use in the synchronization Not Used
 void deregisterDispatcher()
          Deprecated. ADVANCED: This method will deregister the dispatcher for this session from JNDI on the specified host.
 java.net.MulticastSocket getCommunicationSocket()
          Deprecated. ADVANCED: Returns the socket that will be used for the multicast communication.
 java.lang.Object getDispatcher()
          Deprecated. ADVANCED: This is the object that will be placed in JNDI to provide remote synchronization services Not Used.
 RemoteConnection getLocalRemoteConnection()
          Deprecated. ADVANCED: This method should return a Remote Connection of the appropriate type that references the Remote dispatcher for this Session NOT USED
 java.lang.String getTopicConnectionFactoryName()
          Deprecated. PUBLIC: Use this method to get the Connection Factory Name for the JMS Topic connections
 java.lang.String getTopicName()
          Deprecated. PUBLIC: return the JMS Topic name for the Topic that this clustering service will be connecting to.
 void initialize()
          Deprecated. INTERNAL: Initializes the clustering service and starts again
 void registerDispatcher()
          Deprecated. ADVANCED: This method will register the dispatcher for this session in JNDI on the specified host.
 void retreiveRemoteSessions()
          Deprecated. INTERNAL: Use this method to notify the SynchronizationManager that we have to connect to a new Session that has just joined the network
 void run()
          Deprecated. This is the main execution method of this class.
 void setTopicConnectionFactoryName(java.lang.String connectionFactoryName)
          Deprecated. PUBLIC: Use this method to set the Connection Factory Name for the JMS Topic connections
 void setTopicName(java.lang.String topicName)
          Deprecated. PUBLIC: sets the JMS Topic name for the Topic that this clustering service will be connecting to.
 void stopListening()
          Deprecated. ADVANCED: Uses to stop the Listener thread for a dropped session
 
Methods inherited from class org.eclipse.persistence.sessions.remote.AbstractJNDIClusteringService
getContext, getContext, getInitialContextProperties, getLocalContext, getPassword, getUserName, setContext, setInitialContextFactoryName, setInitialContextProperties, setLocalHostURL, setPassword, setUserName
 
Methods inherited from class org.eclipse.persistence.sessions.remote.AbstractClusteringService
announceSession, buildSessionId, getAnnouncementDelay, getApplicationName, getLocalHostURL, getMulticastGroupAddress, getMulticastPort, getReconnectPolicy, getSession, getSessionId, getTimeToLive, listen, receivedAnnouncement, reconnect, setAnnouncementDelay, setApplicationName, setDispatcher, setMulticastGroupAddress, setMulticastPort, setReconnectPolicy, setSession, setSessionId, setTimeToLive
 
Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

topicName

protected java.lang.String topicName
Deprecated. 

connectionFactoryName

protected java.lang.String connectionFactoryName
Deprecated. 

listeningConnection

protected TopicConnection listeningConnection
Deprecated. 
Constructor Detail

JMSClusteringService

public JMSClusteringService(Session session)
Deprecated. 
PUBLIC: Creates a JMSClusteringService

SBGen:
Constructor
Method Detail

connectBackToRemote

public void connectBackToRemote(RemoteConnection connection)
                         throws java.lang.Exception
Deprecated. 
INTERNAL: This method is called by the cache synchronization manager when this server should connect back ('handshake') to the server from which this remote connection came.

Overrides:
connectBackToRemote in class AbstractClusteringService
Throws:
java.lang.Exception

createRemoteConnection

public RemoteConnection createRemoteConnection()
                                        throws JMSException,
                                               javax.naming.NamingException
Deprecated. 
ADVANCED: This method should return a remote connection of the appropraite type for use in the synchronization

Throws:
JMSException
javax.naming.NamingException

createRemoteConnection

public RemoteConnection createRemoteConnection(java.lang.String sessionId,
                                               java.lang.String jndiHostURL)
Deprecated. 
ADVANCED: This method should return a remote connection of the appropraite type for use in the synchronization Not Used

Specified by:
createRemoteConnection in class AbstractClusteringService

registerDispatcher

public void registerDispatcher()
Deprecated. 
ADVANCED: This method will register the dispatcher for this session in JNDI on the specified host. It must register the dispatcher under the SessionId

Specified by:
registerDispatcher in class AbstractClusteringService
Parameters:
jndiHostURL - This is the URL that will be used to register the synchronization service not used

deregisterDispatcher

public void deregisterDispatcher()
Deprecated. 
ADVANCED: This method will deregister the dispatcher for this session from JNDI on the specified host. It must deregister the dispatcher under the SessionId

Specified by:
deregisterDispatcher in class AbstractClusteringService
Parameters:
jndiHostURL - This is the URL that will be used to register the synchronization service not used

getCommunicationSocket

public java.net.MulticastSocket getCommunicationSocket()
Deprecated. 
ADVANCED: Returns the socket that will be used for the multicast communication. By default this will be java.net.MulticastSocket Not Used.

Specified by:
getCommunicationSocket in class AbstractClusteringService
SBGen:
Method get communicationSocket

getDispatcher

public java.lang.Object getDispatcher()
                               throws java.rmi.RemoteException
Deprecated. 
ADVANCED: This is the object that will be placed in JNDI to provide remote synchronization services Not Used.

Specified by:
getDispatcher in class AbstractClusteringService
Throws:
java.rmi.RemoteException
SBGen:
Method get dispatcher

getTopicConnectionFactoryName

public java.lang.String getTopicConnectionFactoryName()
Deprecated. 
PUBLIC: Use this method to get the Connection Factory Name for the JMS Topic connections


getTopicName

public java.lang.String getTopicName()
Deprecated. 
PUBLIC: return the JMS Topic name for the Topic that this clustering service will be connecting to.


initialize

public void initialize()
Deprecated. 
INTERNAL: Initializes the clustering service and starts again

Overrides:
initialize in class AbstractClusteringService

run

public void run()
Deprecated. 
This is the main execution method of this class. It will create a socket to listen to and register the dispatcher for this class in JNDI

Specified by:
run in interface java.lang.Runnable
Overrides:
run in class AbstractClusteringService

getLocalRemoteConnection

public RemoteConnection getLocalRemoteConnection()
Deprecated. 
ADVANCED: This method should return a Remote Connection of the appropriate type that references the Remote dispatcher for this Session NOT USED

Specified by:
getLocalRemoteConnection in class AbstractClusteringService

retreiveRemoteSessions

public void retreiveRemoteSessions()
Deprecated. 
INTERNAL: Use this method to notify the SynchronizationManager that we have to connect to a new Session that has just joined the network


setTopicConnectionFactoryName

public void setTopicConnectionFactoryName(java.lang.String connectionFactoryName)
Deprecated. 
PUBLIC: Use this method to set the Connection Factory Name for the JMS Topic connections


setTopicName

public void setTopicName(java.lang.String topicName)
Deprecated. 
PUBLIC: sets the JMS Topic name for the Topic that this clustering service will be connecting to. This is a required setting and must be set.


stopListening

public void stopListening()
Deprecated. 
ADVANCED: Uses to stop the Listener thread for a dropped session

Overrides:
stopListening in class AbstractClusteringService

EclipseLink 1.0_1.0M2 API Reference - Incubation