|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.ehcache.distribution.RMICacheManagerPeerListener
public class RMICacheManagerPeerListener
A cache server which exposes available cache operations remotely through RMI.
It acts as a Decorator to a Cache. It holds an instance of cache, which is a local cache it talks to. This class could specify a security manager with code like:if (System.getSecurityManager() == null) { System.setSecurityManager(new RMISecurityManager()); }Doing so would require the addition of
grant
statements in the java.policy
file.
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.
Field Summary | |
---|---|
protected Map |
cachePeers
The cache peers. |
protected Integer |
port
The RMI listener port |
protected Status |
status
status. |
Constructor Summary | |
---|---|
RMICacheManagerPeerListener(String hostName,
Integer port,
Integer remoteObjectPort,
CacheManager cacheManager,
Integer socketTimeoutMillis)
Constructor with full arguments. |
Method Summary | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final Map cachePeers
protected Status status
protected Integer port
Constructor Detail |
---|
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 response
UnknownHostException
Method Detail |
---|
protected void assignFreePort(boolean forced) throws IllegalStateException
IllegalStateException
- if the statis of the listener is not Status.STATUS_UNINITIALISED
protected String calculateHostAddress() throws UnknownHostException
UnknownHostException
protected int getFreePort() throws IllegalArgumentException
IllegalArgumentException
public void init() throws CacheException
init
in interface CacheManagerEventListener
CacheException
- - all exceptions are wrapped in CacheExceptionprotected void bind(String peerName, RMICachePeer rmiCachePeer) throws Exception
rmiCachePeer
-
Exception
protected String[] listBoundRMICachePeers() throws CacheException
RMICachePeer
objects
CacheException
protected Remote lookupPeer(String name) throws CacheException
name
- the name of the cache e.g. sampleCache1
CacheException
protected void populateListOfRemoteCachePeers() throws RemoteException
RemoteException
protected boolean isDistributed(Ehcache cache)
cache
- the cache to check
CacheReplicator
is found in the listenersprotected void startRegistry() throws RemoteException
rmiregistry
binary, in which case:
RemoteException
protected void stopRegistry() throws RemoteException
RemoteException
public void dispose() throws CacheException
dispose
in interface CacheManagerEventListener
CacheException
- - all exceptions are wrapped in CacheExceptionprotected void disposeRMICachePeer(RMICachePeer rmiCachePeer) throws Exception
rmiCachePeer
- the cache peer to dispose of
Exception
- thrown if something goes wrongprotected void unbind(RMICachePeer rmiCachePeer) throws Exception
rmiCachePeer
- the bound and exported cache peer
Exception
public List getBoundCachePeers()
getBoundCachePeers
in interface CacheManagerPeerListener
RMICachePeer
objects. The list if not livepublic Status getStatus()
getStatus
in interface CacheManagerEventListener
public String getUniqueResourceIdentifier()
getUniqueResourceIdentifier
in interface CacheManagerPeerListener
public void attemptResolutionOfUniqueResourceConflict() throws IllegalStateException, CacheException
attemptResolutionOfUniqueResourceConflict
in interface CacheManagerPeerListener
IllegalStateException
- if the statis of the listener is not Status.STATUS_UNINITIALISED
CacheException
public String getScheme()
getScheme
in interface CacheManagerPeerListener
public 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 CacheManagerEventListener
cacheName
- the name of the Cache
the operation relates to
CacheException
CacheEventListener
public 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 CacheManagerEventListener
cacheName
- the name of the Cache
the operation relates to
|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |