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

B15903-01


oracle.toplink.remote.ejb
Class EJBJNDIClusteringService

java.lang.Object
  extended byoracle.toplink.remote.AbstractClusteringService
      extended byoracle.toplink.remote.AbstractJNDIClusteringService
          extended byoracle.toplink.remote.ejb.EJBJNDIClusteringService

All Implemented Interfaces:
java.lang.Runnable

public class EJBJNDIClusteringService
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 also assumes that there is a JNDI service available. And is best used within an application server.

See Also:
CacheSynchronizationManager, oracle.toplink.remote.

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

Method Summary
oracle.toplink.internal.remote.RemoteConnection createRemoteConnection(java.lang.String sessionId, java.lang.String jndiHostURL)
ADVANCED: This method should return a remote connection of the appropriate type for use in the synchronization
void deregisterDispatcher()
ADVANCED: This method will rdeegister 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.lang.String jndiHostURL)
Deprecated. Since 4.5
java.lang.Object getDispatcher()
ADVANCED: This is the object that will be placed in JNDI to provide remote synchronization services
java.lang.String getHomeName()
PUBLIC: Returns the HomeName where the Session Bean Home is registered
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 setHomeName(java.lang.String name)
PUBLIC: Sets the HomeName where the Session Bean Home is registered

Methods inherited from class oracle.toplink.remote.AbstractJNDIClusteringService
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

EJBJNDIClusteringService

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

EJBJNDIClusteringService

public EJBJNDIClusteringService(Session session)
PUBLIC: Creates a EJBJNDIClusteringService

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 rdeegister 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 jndiHostURL)
ADVANCED: This method should return a remote connection of the appropriate type for use in the synchronization
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

getContext

public javax.naming.Context getContext(java.lang.String jndiHostURL)
Deprecated. Since 4.5
ADVANCED: Returns the active JNDI Context to store the remote service in
Overrides:
getContext in class AbstractJNDIClusteringService
Returns:

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

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

setHomeName

public void setHomeName(java.lang.String name)
PUBLIC: Sets the HomeName where the Session Bean Home is registered

getHomeName

public java.lang.String getHomeName()
PUBLIC: Returns the HomeName where the Session Bean Home is registered

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