Oracle Application Server TopLink API Reference
10g Release 2 (10.1.2)

B15903-01


oracle.toplink.remote.rmi
Class RMIClusteringService

java.lang.Object
  extended byoracle.toplink.remote.AbstractClusteringService
      extended byoracle.toplink.remote.rmi.RMIClusteringService

All Implemented Interfaces:
java.lang.Runnable

public class RMIClusteringService
extends AbstractClusteringService

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

Descripton:This thread object will place a remote dispatcher in the specified RMI registry. it will also monitor the specified multicast socket to allow other sessions to connect. This Particular class has been configured to use the RMI transport protocols

See Also:
CacheSynchronizationManager, oracle.toplink.remote.

Constructor Summary
RMIClusteringService(Session session)
PUBLIC: Creates a RMIClusteringService
RMIClusteringService(java.lang.String multicastAddress, int multicastPort, Session session)
ADVANCED: Creates a RMIClusteringService

Method Summary
oracle.toplink.internal.remote.RemoteConnection createRemoteConnection(java.lang.String sessionId, java.lang.String remoteHostURL)
ADVANCED: This method should return a remote connection of the appropraite type for use in the synchronizatio
void deregisterDispatcher()
ADVANCED: This method will deregister the dispatcher for this session from JNDI on the specified host.
java.net.MulticastSocket getCommunicationSocket()
ADVANCED: Returns the socket that will be used for the multicast communication.
java.lang.Object getDispatcher()
ADVANCED: This is the object that will be placed in JNDI to provide remote synchronization services
oracle.toplink.internal.remote.RemoteConnection getLocalRemoteConnection()
ADVANCED: This method should return a Remote Connection of the appropriate type that references the Remote dispatcher for this Session
void registerDispatcher()
ADVANCED: This method will register the dispatcher for this session in JNDI on the specified host.

Methods inherited from class oracle.toplink.remote.AbstractClusteringService
getAnnouncementDelay, getApplicationName, getLocalHostURL, getMulticastGroupAddress, getMulticastPort, getSessionId, getTimeToLive, setAnnouncementDelay, setApplicationName, setDispatcher, setLocalHostURL, setMulticastGroupAddress, setMulticastPort, setSessionId, setTimeToLive, stopListening

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RMIClusteringService

public RMIClusteringService(java.lang.String multicastAddress,
                            int multicastPort,
                            Session session)
ADVANCED: Creates a RMIClusteringService
Parameters:
multicastAddress - The address of the multicast group
multicastPort - The port the multicast group is listening on

RMIClusteringService

public RMIClusteringService(Session session)
PUBLIC: Creates a RMIClusteringService

Method Detail

registerDispatcher

public void registerDispatcher()
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

deregisterDispatcher

public void deregisterDispatcher()
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

createRemoteConnection

public oracle.toplink.internal.remote.RemoteConnection createRemoteConnection(java.lang.String sessionId,
                                                                              java.lang.String remoteHostURL)
ADVANCED: This method should return a remote connection of the appropraite type for use in the synchronizatio
Specified by:
createRemoteConnection in class AbstractClusteringService

getCommunicationSocket

public java.net.MulticastSocket getCommunicationSocket()
ADVANCED: Returns the socket that will be used for the multicast communication. By default this will be java.net.MulticastSocket
Specified by:
getCommunicationSocket in class AbstractClusteringService

getDispatcher

public java.lang.Object getDispatcher()
                               throws java.rmi.RemoteException
ADVANCED: This is the object that will be placed in JNDI to provide remote synchronization services
Specified by:
getDispatcher in class AbstractClusteringService
Throws:
java.rmi.RemoteException

getLocalRemoteConnection

public oracle.toplink.internal.remote.RemoteConnection getLocalRemoteConnection()
ADVANCED: This method should return a Remote Connection of the appropriate type that references the Remote dispatcher for this Session
Specified by:
getLocalRemoteConnection in class AbstractClusteringService

Copyright © 1998, 2005 Oracle Corporation. All Rights Reserved.