1 /***
2 * Copyright 2003-2010 Terracotta, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package net.sf.ehcache.distribution;
18
19 import net.sf.ehcache.CacheException;
20 import net.sf.ehcache.event.CacheManagerEventListener;
21
22 import java.util.List;
23
24 /***
25 * A listener for updates, which controls remote cache peers.
26 * @author Greg Luck
27 * @version $Id: CacheManagerPeerListener.html 13146 2011-08-01 17:12:39Z oletizi $
28 */
29 public interface CacheManagerPeerListener extends CacheManagerEventListener {
30
31 /***
32 * All of the caches which are listening for remote changes.
33 * @return a list of <code>CachePeer</code> objects
34 */
35 List getBoundCachePeers();
36
37
38
39 /***
40 * A listener will normally have a resource that only one instance can use at the same time,
41 * such as a port. This identifier is used to tell if it is unique and will not conflict with an
42 * existing instance using the resource.
43 * @return a String identifier for the resource
44 */
45 String getUniqueResourceIdentifier();
46
47
48 /***
49 * If a conflict is detected in unique resource use, this method signals the listener to attempt
50 * automatic resolution of the resource conflict.
51 * @throws IllegalStateException if the statis of the listener is not {@link net.sf.ehcache.Status#STATUS_UNINITIALISED}
52 */
53 void attemptResolutionOfUniqueResourceConflict() throws IllegalStateException, CacheException;
54
55 /***
56 * The replication scheme this listener interacts with.
57 * Each peer provider has a scheme name, which can be used by caches to specify for replication and bootstrap purposes.
58 * @return the well-known scheme name, which is determined by the replication provider author.
59 */
60 String getScheme();
61 }