01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package org.jboss.cache.invalidation;
23:
24: import java.io.Serializable;
25:
26: /**
27: * Every bridge subscribing to a InvalidationManager has access to this interface that
28: * it can used to invalidate messages on the local IM.
29: * @see InvalidationManagerMBean
30: * @see InvalidationBridgeListener
31: * @version $Revision: 57209 $
32: *
33: * <p><b>Revisions:</b>
34: *
35: * <p><b>21 septembre 2002 Sacha Labourey:</b>
36: * <ul>
37: * <li> First implementation </li>
38: * </ul>
39: */
40:
41: public interface BridgeInvalidationSubscription {
42: /**
43: * Used to invalidate a single key in a given InvalidationGroup
44: * @param invalidationGroupName Name of the InvalidationGroup for which this invalidation is targeted
45: * @param key Key to be invalidated
46: */
47: public void invalidate(String invalidationGroupName,
48: Serializable key);
49:
50: /**
51: * Invalidate a set of keys in a give InvalidationGRoup
52: * @param invalidationGroupName Name of the InvalidationGroup to which is targeted this invalidation
53: * @param keys Keys to be invalidated
54: */
55: public void invalidate(String invalidationGroupName,
56: Serializable[] keys);
57:
58: /**
59: * Invalidate all the entries in the specified group
60: * @param groupName
61: */
62: public void invalidateAll(String groupName);
63:
64: /**
65: * Invalidates a set of keys in a set of InvalidationGroup. It is the responsability
66: * of the InvalidationManager to determine which IG are actually present i.e. the
67: * bridge may transmit BatchInvalidation for IG that are not present locally. The
68: * IM will simply ignore them.
69: * @param invalidations Invalidations to be performed on the local IM instance
70: */
71: public void batchInvalidate(BatchInvalidation[] invalidations);
72:
73: /**
74: * Unregister the current bridge form the InvalidationManager
75: */
76: public void unregister();
77:
78: }
|