EclipseLink 1.0_1.0M2 API Reference - Incubation

org.eclipse.persistence.sessions.remote
Class CacheSynchronizationManager

java.lang.Object
  extended by org.eclipse.persistence.sessions.remote.CacheSynchronizationManager

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

public class CacheSynchronizationManager
extends java.lang.Object

Purpose: Allow for a cluster or group of application servers or TopLink sessions to distributely broadcast cache changes to the other servers to synchronize the state of the cache object.

Description: This allows for applications that require multiple application servers to decrease the possibilty of stale data in the TopLink cache.


Field Summary
protected  AbstractClusteringService clusteringService
          Deprecated. This attribute holds the Synchronization Service
protected  java.lang.Class clusteringServiceClassType
          Deprecated. This attribute holds the reference to the SynchronizationService
protected  boolean isAsynchronous
          Deprecated. This attribute flag is used to determine if the propigation should be synchronous or asynchronous
protected  java.lang.String localHostURL
          Deprecated. The URL of the JNDI host where the Dispatcher will be placed
protected  java.util.Hashtable remoteConnections
          Deprecated. This attribute is used to store the list of RemoteConnections that changes should be sent to
protected  RemoteConnection remoteSessionConnection
          Deprecated. This attribute holds the remoteSessionControllerDispatcher that this Session is making available to other sessions for synchronization
protected  java.lang.Object remoteSessionController
          Deprecated.  
protected  Session session
          Deprecated. This attribute holds a reference back to the session
protected  boolean shouldRemoveConnectionOnError
          Deprecated. This attribute designates if conects to remote servers should be removed if an error occurs The default is true
 
Constructor Summary
CacheSynchronizationManager()
          Deprecated. PUBLIC: Creates a CacheSynchronizationManager.
CacheSynchronizationManager(java.lang.Class clusteringServiceClassType)
          Deprecated. PUBLIC: Creates a CacheSynchronizationManager.
CacheSynchronizationManager(java.lang.Object controller)
          Deprecated. As of version 4.0
 
Method Summary
 void addRemoteConnection(RemoteConnection connection)
          Deprecated. PUBLIC: Add a remote Connection for cache synchronisation.
 void connectToAllRemoteServers()
          Deprecated. PUBLIC: Connect to all known servers, that have been specified through addRemoteConnections.
 AbstractClusteringService getClusteringService()
          Deprecated. INTERNAL: Used to return the running synchronization service
 java.lang.Class getClusteringServiceClassType()
          Deprecated. INTERNAL: Return the class type used ot automatically synchronize distributed sessions
 java.lang.String getclusteringServiceClassTypeName()
          Deprecated. INTERNAL: Get the name of the clusteringServiceClassType as a String.
 java.lang.String getLocalHostURL()
          Deprecated. since 4.5 now set on ClusteringService
 java.util.Hashtable getRemoteConnections()
          Deprecated. PUBLIC: Returns the list of remote connections for cache synchronisation.
 Session getSession()
          Deprecated. INTERNAL: This method returns the session referenced by this policy
 RemoteConnection getSessionRemoteConnection()
          Deprecated. ADVANCED: Returns the remoteSession controller dispatcher that this session has made available for synchronization.
 java.lang.Object getSessionRemoteController()
          Deprecated. Since 4.0
 void initialize()
          Deprecated. ADVANCED: THis method is called during the Login of the session to set up the synchronization service
 boolean isAsynchronous()
          Deprecated. PUBLIC: Return whether the propagation of the change sets should be asynchronous.
 void propagateChanges(UnitOfWorkChangeSet changeSet)
          Deprecated. INTERNAL: Propigate the changes to distributed caches.
 void removeAllRemoteConnections()
          Deprecated. PUBLIC: Remove all remote connections for cache synchronisation.
 void removeRemoteConnection(RemoteConnection connection)
          Deprecated. PUBLIC: Remove a remote connection for cache synchronisation.
 void setClusteringService(AbstractClusteringService clusteringService)
          Deprecated. ADVANCED: Use this method to set the clusteringService used to synchronize the distributed sessions The class supplied must subclass AbstractClusteringService
 void setClusteringServiceClassType(java.lang.Class clusteringServiceClassType)
          Deprecated. ADVANCED: Use this method to set the class type to be used to synchronize the distributed sessions The class supplied must subclass AbstractClusteringService
 void setClusteringServiceClassTypeName(java.lang.String aClassName)
          Deprecated. INTERNAL: Given the name of a class, set my clusteringServiceClassType to point at that class.
 void setIsAsynchronous(boolean isAsynchronous)
          Deprecated. ADVANCED: This method is used to set if the propagation of the change sets should be asynchronous.
 void setLocalHostURL(java.lang.String localHostURL)
          Deprecated. since 4.5 now set on ClusteringService
 void setSession(Session session)
          Deprecated. INTERNAL: Set the session.
 void setSessionRemoteConnection(RemoteConnection remoteSessionConnection)
          Deprecated. ADVANCED: Sets the remoteSession connection that this session will make available for synchronization.
 void setSessionRemoteController(java.lang.Object remoteSessionController)
          Deprecated. As of version 4.0
 void setShouldRemoveConnectionOnError(boolean shouldRemoveConnectionOnError)
          Deprecated. PUBLIC: Allow whether connections to remote servers should be disconnected when an error occurs
 boolean shouldRemoveConnectionOnError()
          Deprecated. PUBLIC: Return whether connections to remote servers should be disconnected when an error occurs
 void stopListening()
          Deprecated. INTERNAL: This method is used to Stop Listening to the remote services.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

remoteConnections

protected java.util.Hashtable remoteConnections
Deprecated. 
This attribute is used to store the list of RemoteConnections that changes should be sent to


remoteSessionController

protected java.lang.Object remoteSessionController
Deprecated. 

remoteSessionConnection

protected RemoteConnection remoteSessionConnection
Deprecated. 
This attribute holds the remoteSessionControllerDispatcher that this Session is making available to other sessions for synchronization


session

protected Session session
Deprecated. 
This attribute holds a reference back to the session


isAsynchronous

protected boolean isAsynchronous
Deprecated. 
This attribute flag is used to determine if the propigation should be synchronous or asynchronous


shouldRemoveConnectionOnError

protected boolean shouldRemoveConnectionOnError
Deprecated. 
This attribute designates if conects to remote servers should be removed if an error occurs The default is true


localHostURL

protected java.lang.String localHostURL
Deprecated. 
The URL of the JNDI host where the Dispatcher will be placed


clusteringServiceClassType

protected java.lang.Class clusteringServiceClassType
Deprecated. 
This attribute holds the reference to the SynchronizationService


clusteringService

protected AbstractClusteringService clusteringService
Deprecated. 
This attribute holds the Synchronization Service

Constructor Detail

CacheSynchronizationManager

public CacheSynchronizationManager()
Deprecated. 
PUBLIC: Creates a CacheSynchronizationManager.


CacheSynchronizationManager

public CacheSynchronizationManager(java.lang.Class clusteringServiceClassType)
Deprecated. 
PUBLIC: Creates a CacheSynchronizationManager.

Parameters:
clusteringServiceClassType - the class that will be instantiated to connect all nodes

CacheSynchronizationManager

public CacheSynchronizationManager(java.lang.Object controller)
Deprecated. As of version 4.0

PUBLIC: Creates a CacheSynchronizationManager.

Parameters:
controller - This must be a globally available RemoteSessionController
Method Detail

initialize

public void initialize()
Deprecated. 
ADVANCED: THis method is called during the Login of the session to set up the synchronization service


getclusteringServiceClassTypeName

public java.lang.String getclusteringServiceClassTypeName()
Deprecated. 
INTERNAL: Get the name of the clusteringServiceClassType as a String. Used for persisting.


setClusteringServiceClassTypeName

public void setClusteringServiceClassTypeName(java.lang.String aClassName)
Deprecated. 
INTERNAL: Given the name of a class, set my clusteringServiceClassType to point at that class. Used for persisting


addRemoteConnection

public void addRemoteConnection(RemoteConnection connection)
Deprecated. 
PUBLIC: Add a remote Connection for cache synchronisation. This connection will be updated with the changes that occur to this session's cache.


connectToAllRemoteServers

public void connectToAllRemoteServers()
Deprecated. 
PUBLIC: Connect to all known servers, that have been specified through addRemoteConnections. This notifies the other servers that this server is alive and desires it's cache to be synchronized with their caches. The other server will then send all committed changes back through the remote connection to this server. Note: any errors that occur will be ignored and this will continue to connect to the other servers, these errors will be logged to the session's log.


getRemoteConnections

public java.util.Hashtable getRemoteConnections()
Deprecated. 
PUBLIC: Returns the list of remote connections for cache synchronisation.


getSession

public Session getSession()
Deprecated. 
INTERNAL: This method returns the session referenced by this policy


getSessionRemoteController

public java.lang.Object getSessionRemoteController()
Deprecated. Since 4.0

ADVANCED: Returns the remoteSession controller dispatcher that this session has made available for synchronization.


getSessionRemoteConnection

public RemoteConnection getSessionRemoteConnection()
Deprecated. 
ADVANCED: Returns the remoteSession controller dispatcher that this session has made available for synchronization.


propagateChanges

public void propagateChanges(UnitOfWorkChangeSet changeSet)
Deprecated. 
INTERNAL: Propigate the changes to distributed caches.


removeAllRemoteConnections

public void removeAllRemoteConnections()
Deprecated. 
PUBLIC: Remove all remote connections for cache synchronisation. All remote connections will no longer be updated with the changes


removeRemoteConnection

public void removeRemoteConnection(RemoteConnection connection)
Deprecated. 
PUBLIC: Remove a remote connection for cache synchronisation. This connection will no longer be updated with the changes.


setIsAsynchronous

public void setIsAsynchronous(boolean isAsynchronous)
Deprecated. 
ADVANCED: This method is used to set if the propagation of the change sets should be asynchronous. This means that the client will return from the commit before the changes may have been propigated.


isAsynchronous

public boolean isAsynchronous()
Deprecated. 
PUBLIC: Return whether the propagation of the change sets should be asynchronous. Asynchronous propagation means that the client will return from the commit before the changes may have been propigated.

Returns:
boolean

setSession

public void setSession(Session session)
Deprecated. 
INTERNAL: Set the session.


setSessionRemoteController

public void setSessionRemoteController(java.lang.Object remoteSessionController)
Deprecated. As of version 4.0

ADVANCED: Sets the remoteSession controller dispatcher that this session has made available for synchronization.


setSessionRemoteConnection

public void setSessionRemoteConnection(RemoteConnection remoteSessionConnection)
Deprecated. 
ADVANCED: Sets the remoteSession connection that this session will make available for synchronization. Other session will communicate with this session through this connection


setShouldRemoveConnectionOnError

public void setShouldRemoveConnectionOnError(boolean shouldRemoveConnectionOnError)
Deprecated. 
PUBLIC: Allow whether connections to remote servers should be disconnected when an error occurs


shouldRemoveConnectionOnError

public boolean shouldRemoveConnectionOnError()
Deprecated. 
PUBLIC: Return whether connections to remote servers should be disconnected when an error occurs


getClusteringService

public AbstractClusteringService getClusteringService()
Deprecated. 
INTERNAL: Used to return the running synchronization service

SBGen:
Method get clusteringService

setClusteringService

public void setClusteringService(AbstractClusteringService clusteringService)
Deprecated. 
ADVANCED: Use this method to set the clusteringService used to synchronize the distributed sessions The class supplied must subclass AbstractClusteringService

Parameters:
clusteringService -
SBGen:
Method set clusteringService

setClusteringServiceClassType

public void setClusteringServiceClassType(java.lang.Class clusteringServiceClassType)
Deprecated. 
ADVANCED: Use this method to set the class type to be used to synchronize the distributed sessions The class supplied must subclass AbstractClusteringService

Parameters:
clusteringServiceClassType -
SBGen:
Method set clusteringServiceClassType

getClusteringServiceClassType

public java.lang.Class getClusteringServiceClassType()
Deprecated. 
INTERNAL: Return the class type used ot automatically synchronize distributed sessions

SBGen:
Method get clusteringServiceClassType

getLocalHostURL

public java.lang.String getLocalHostURL()
Deprecated. since 4.5 now set on ClusteringService

This method will return the Host URL of the JNDI service for this node

SBGen:
Method get jndiHostURL

setLocalHostURL

public void setLocalHostURL(java.lang.String localHostURL)
Deprecated. since 4.5 now set on ClusteringService

This method will set the Host address of the JNDI service

Parameters:
jndiHostURL -
SBGen:
Method set jndiHostURL

stopListening

public void stopListening()
Deprecated. 
INTERNAL: This method is used to Stop Listening to the remote services. This should only happen when the session is logged out


EclipseLink 1.0_1.0M2 API Reference - Incubation