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

B15903-01


oracle.toplink.remote.rmi.wls
Class WLSClusteringService

java.lang.Object
  extended byoracle.toplink.remote.AbstractClusteringService
      extended byoracle.toplink.remote.AbstractJNDIClusteringService
          extended byoracle.toplink.remote.rmi.wls.WLSClusteringService

All Implemented Interfaces:
java.lang.Runnable

public class WLSClusteringService
extends AbstractJNDIClusteringService

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 JNDI space. 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. This class is only valid for use in a clustered WebLogic application server.

See Also:
CacheSynchronizationManager, oracle.toplink.remote.

Constructor Summary
WLSClusteringService(Session session)
PUBLIC: Creates a WLSClusteringService

Method Summary
oracle.toplink.internal.remote.RemoteConnection createRemoteConnection(java.lang.String sessionId, java.lang.Object remoteObject)
ADVANCED: This method should return a remote connection of the appropraite type for use in the synchronizatio
oracle.toplink.internal.remote.RemoteConnection createRemoteConnection(java.lang.String sessionId, java.lang.String jndiHostURL)
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.
javax.naming.Context getContext(java.util.Hashtable contextProperties)
ADVANCED: Returns the active JNDI Context to store the remote service in no properties are required in WebLogic as all defaults should be globally available in the VM
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.
void run()
This is the main execution method of this class.

Methods inherited from class oracle.toplink.remote.AbstractJNDIClusteringService
getContext, getInitialContextProperties, getPassword, getUserName, setContext, setInitialContextFactoryName, setInitialContextProperties, setPassword, setUserName

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

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

Constructor Detail

WLSClusteringService

public WLSClusteringService(Session session)
PUBLIC: Creates a WLSClusteringService

Method Detail

createRemoteConnection

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

createRemoteConnection

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

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

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

getContext

public javax.naming.Context getContext(java.util.Hashtable contextProperties)
ADVANCED: Returns the active JNDI Context to store the remote service in no properties are required in WebLogic as all defaults should be globally available in the VM
Overrides:
getContext in class AbstractJNDIClusteringService

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
Returns:
Throws:
java.rmi.RemoteException

run

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