public class RMICacheManagerPeerListener extends Object implements CacheManagerPeerListener
if (System.getSecurityManager() == null) {
System.setSecurityManager(new RMISecurityManager());
}
Doing so would require the addition of grant statements in the java.policy file.
Per the JDK documentation: "If no security manager is specified no class loading, by RMI clients or servers, is allowed,
aside from what can be found in the local CLASSPATH." The classpath of each instance of this class should have
all required classes to enable distribution, so no remote classloading is required or desirable. Accordingly,
no security manager is set and there are no special JVM configuration requirements.
This class opens a ServerSocket. The dispose method should be called for orderly closure of that socket. This class
has a shutdown hook which calls dispose() as a convenience feature for developers.| Modifier and Type | Field and Description |
|---|---|
protected Map |
cachePeers
The cache peers.
|
protected Integer |
port
The RMI listener port
|
protected Status |
status
status.
|
| Constructor and Description |
|---|
RMICacheManagerPeerListener(String hostName,
Integer port,
Integer remoteObjectPort,
CacheManager cacheManager,
Integer socketTimeoutMillis)
Constructor with full arguments.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
assignFreePort(boolean forced)
Assigns a free port to be the listener port.
|
void |
attemptResolutionOfUniqueResourceConflict()
If a conflict is detected in unique resource use, this method signals the listener to attempt
automatic resolution of the resource conflict.
|
protected void |
bind(String peerName,
RMICachePeer rmiCachePeer)
Bind a cache peer
|
protected String |
calculateHostAddress()
Calculates the host address as the default NICs IP address
|
void |
dispose()
Stop the listener.
|
protected void |
disposeRMICachePeer(RMICachePeer rmiCachePeer)
A template method to dispose an individual RMICachePeer.
|
List |
getBoundCachePeers()
All of the caches which are listening for remote changes.
|
protected int |
getFreePort()
Gets a free server socket port.
|
String |
getScheme()
The replication scheme this listener interacts with.
|
Status |
getStatus()
Returns the listener status.
|
String |
getUniqueResourceIdentifier()
A listener will normally have a resource that only one instance can use at the same time,
such as a port.
|
void |
init()
Call to start the listeners and do any other required initialisation.
|
protected boolean |
isDistributed(Ehcache cache)
Determine if the given cache is distributed.
|
protected String[] |
listBoundRMICachePeers()
Returns a list of bound objects.
|
protected Remote |
lookupPeer(String name)
Returns a reference to the remote object.
|
void |
notifyCacheAdded(String cacheName)
Called immediately after a cache has been added and activated.
|
void |
notifyCacheRemoved(String cacheName)
Called immediately after a cache has been disposed and removed.
|
protected void |
populateListOfRemoteCachePeers()
Should be called on init because this is one of the last things that should happen on CacheManager startup.
|
protected void |
startRegistry()
Start the rmiregistry.
|
protected void |
stopRegistry()
Stop the rmiregistry if it was started by this class.
|
protected void |
unbind(RMICachePeer rmiCachePeer)
Unbinds an RMICachePeer and unexports it.
|
protected final Map cachePeers
protected Status status
protected Integer port
public RMICacheManagerPeerListener(String hostName, Integer port, Integer remoteObjectPort, CacheManager cacheManager, Integer socketTimeoutMillis) throws UnknownHostException
hostName - may be null, in which case the hostName will be looked up. Machines with multiple
interfaces should specify this if they do not want it to be the default NIC.port - a port in the range 1025 - 65536remoteObjectPort - the port number on which the remote objects bound in the registry receive calls.
This defaults to a free port if not specified.cacheManager - the CacheManager this listener belongs tosocketTimeoutMillis - TCP/IP Socket timeout when waiting on responseUnknownHostExceptionprotected void assignFreePort(boolean forced)
throws IllegalStateException
IllegalStateException - if the statis of the listener is not Status.STATUS_UNINITIALISEDprotected String calculateHostAddress() throws UnknownHostException
UnknownHostExceptionprotected int getFreePort()
throws IllegalArgumentException
IllegalArgumentExceptionpublic void init()
throws CacheException
init in interface CacheManagerEventListenerCacheException - - all exceptions are wrapped in CacheExceptionprotected void bind(String peerName, RMICachePeer rmiCachePeer) throws Exception
rmiCachePeer - Exceptionprotected String[] listBoundRMICachePeers() throws CacheException
RMICachePeer objectsCacheExceptionprotected Remote lookupPeer(String name) throws CacheException
name - the name of the cache e.g. sampleCache1CacheExceptionprotected void populateListOfRemoteCachePeers()
throws RemoteException
RemoteExceptionprotected boolean isDistributed(Ehcache cache)
cache - the cache to checkCacheReplicator is found in the listenersprotected void startRegistry()
throws RemoteException
rmiregistry binary, in which case:
RemoteExceptionprotected void stopRegistry()
throws RemoteException
RemoteExceptionpublic void dispose()
throws CacheException
dispose in interface CacheManagerEventListenerCacheException - - all exceptions are wrapped in CacheExceptionprotected void disposeRMICachePeer(RMICachePeer rmiCachePeer) throws Exception
rmiCachePeer - the cache peer to dispose ofException - thrown if something goes wrongprotected void unbind(RMICachePeer rmiCachePeer) throws Exception
rmiCachePeer - the bound and exported cache peerExceptionpublic List getBoundCachePeers()
getBoundCachePeers in interface CacheManagerPeerListenerRMICachePeer objects. The list if not livepublic Status getStatus()
getStatus in interface CacheManagerEventListenerpublic String getUniqueResourceIdentifier()
getUniqueResourceIdentifier in interface CacheManagerPeerListenerpublic void attemptResolutionOfUniqueResourceConflict()
throws IllegalStateException,
CacheException
attemptResolutionOfUniqueResourceConflict in interface CacheManagerPeerListenerIllegalStateException - if the statis of the listener is not Status.STATUS_UNINITIALISEDCacheExceptionpublic String getScheme()
getScheme in interface CacheManagerPeerListenerpublic void notifyCacheAdded(String cacheName) throws CacheException
Status.STATUS_UNINITIALISED to Status.STATUS_ALIVE. Care should be
taken on processing that notification because:
CacheManager.getCache(String) will cause a deadlock.
notifyCacheAdded in interface CacheManagerEventListenercacheName - the name of the Cache the operation relates toCacheExceptionCacheEventListenerpublic void notifyCacheRemoved(String cacheName)
CacheEventListener status changed will also be triggered. Any attempt from that notification
to access CacheManager will also result in a deadlock.notifyCacheRemoved in interface CacheManagerEventListenercacheName - the name of the Cache the operation relates toCopyright © 2003-2014 Terracotta, Inc.. All Rights Reserved.