View Javadoc

1   /**
2    *  Copyright 2003-2006 Greg Luck
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.event.CacheEventListener;
20  
21  /**
22   * Replicates cache entries to peers of the CacheManager
23   * @author <a href="mailto:gluck@thoughtworks.com">Greg Luck</a>
24   * @version $Id: CacheReplicator.java 52 2006-04-24 14:50:03Z gregluck $
25   */
26  public interface CacheReplicator extends CacheEventListener {
27  
28      /**
29       * Returns whether update is through copy or invalidate
30       * @return true if update is via copy, else false if invalidate
31       */
32      boolean isReplicateUpdatesViaCopy();
33  
34      /**
35       * Returns whether the replicator is not active.
36       * @return true if the status is not STATUS_ALIVE
37       */
38      boolean notAlive();
39  
40      /**
41       * Checks that the replicator is is <code>STATUS_ALIVE</code>.
42       * @return true if the replicator is is <code>STATUS_ALIVE</code>, else false.
43       */
44      boolean alive();
45  
46  }