001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.cache.invalidation;
023:
024: import java.io.Serializable;
025:
026: /**
027: * An InvalidationGroup (IG) is the meeting point of all caches and invaliders
028: * working for the same cached information.
029: * For example, two entity beans based
030: * on the same database information will share their cache invalidation so that
031: * a modification performed on the bean of one of the deployed EJB will imply
032: * a cache invalidation in the cache of the other EJB.
033: * In this case, we say that both EJBs work in the same InvalidationGroup.
034: * @see InvalidationManagerMBean
035: * @author <a href="mailto:sacha.labourey@cogito-info.ch">Sacha Labourey</a>.
036: * @version $Revision: 57209 $
037: *
038: * <p><b>Revisions:</b>
039: *
040: * <p><b>21 septembre 2002 Sacha Labourey:</b>
041: * <ul>
042: * <li> First implementation </li>
043: * </ul>
044: */
045:
046: public interface InvalidationGroup {
047: /**
048: * Return the name (i.e. identifier) of the current IG
049: * @return Name of the current IG
050: */
051: public String getGroupName();
052:
053: /**
054: * Invalidate a single key in all caches associated with this IG
055: * @param key The key to be invalidated
056: */
057: public void invalidate(Serializable key);
058:
059: /**
060: * Invalidate a single key in all caches associated with this IG specifying a
061: * prefered invalidation mode (synchronous vs. asynchronous)
062: * @param key The key to be invalidated in the cache
063: * @param asynchronous if true, the invalidation will be, if possible, performed asynchronously
064: */
065: public void invalidate(Serializable key, boolean asynchronous);
066:
067: /**
068: * Invalidate a set of keys in all caches associated with this IG
069: * @param keys Set of keys to be invalidated
070: */
071: public void invalidate(Serializable[] keys);
072:
073: /**
074: * Invalidate a set of keys in all caches associated with this IG specifying a
075: * prefered invalidation mode (synchronous vs. asynchronous)
076: * @param keys keys to be invalidated
077: * @param asynchronous if true, the invalidation will be, if possible, performed asynchronously
078: */
079: public void invalidate(Serializable[] keys, boolean asynchronous);
080:
081: /**
082: * All entries in all the caches associated with this invalidation group should be invalidated.
083: */
084: public void invalidateAll();
085:
086: /**
087: * All entries in all the caches associated with this invalidation group should be invalidated
088: * using specified mode.
089: */
090: public void invalidateAll(boolean asynchronous);
091:
092: /**
093: * Used to know when to definitively remove this IG. Every component using this IG
094: * must increment the counter, otherwise, the group may be dropped while they are still
095: * using it. Exceptions:
096: * - When calling InvalidationManager.getInvalidationGroup, the counter is automatically
097: * called. Consequently, code accessing this IG through this mean must not call
098: * addReference. Nevertheless, they *must* still call removeReference
099: * appropriatly
100: * - When calling InvalidationGroup.unregister, the counter is automatically
101: * decreased
102: *
103: * Consequenlty, users such as cache generally don't need to increment or decrement
104: * the reference count because it is automatically done while getting access to the
105: * InvalidationGroup and unsubscribing. Invaliders do need to correctly unsubscribe.
106: *
107: * When the reference count drops to 0, the group is removed from the Manager
108: * Thus, any active user of this group should appropriatly increment the reference
109: * count. Passive listener (JMS/JG bridge for example) should not subscribe.
110: */
111: public void addReference();
112:
113: /**
114: * Decrease the usage counter. When the counter drops to 0, the group is removed.
115: */
116: public void removeReference();
117:
118: /**
119: * Return the value of the usage counter for this IG.
120: * @return Actual usage counter
121: */
122: public int getReferenceCount();
123:
124: /**
125: * Register an Invalidatable instance has a subscriber of this InvalidationGroup.
126: * @param registered Subscribing instance
127: */
128: public void register(Invalidatable registered);
129:
130: /**
131: * Unregister an Invalidatable instance
132: * @param registered Unsubscribing instance
133: */
134: public void unregister(Invalidatable registered);
135:
136: /**
137: * Set the default mode for managing invalidations in this IG: synchronous or
138: * asynchronous.
139: * Note: this is a best effort setting.
140: * @param async If true, asynchronous communication should be used if possible.
141: */
142: public void setAsynchronousInvalidation(boolean async);
143:
144: /**
145: * Return the default (a-)synchronous communication scheme used
146: */
147: public boolean getAsynchronousInvalidation();
148:
149: /**
150: * Return the InvalidationManager (IM) to which is linked this group (IG)
151: */
152: public InvalidationManagerMBean getInvalidationManager();
153:
154: }
|