JGCacheInvalidationBridgeMBean


1   /*
2     * JBoss, Home of Professional Open Source
3     * Copyright 2005, JBoss Inc., and individual contributors as indicated
4     * by the @authors tag. See the copyright.txt in the distribution for a
5     * full listing of individual contributors.
6     *
7     * This is free software; you can redistribute it and/or modify it
8     * under the terms of the GNU Lesser General Public License as
9     * 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.bridges;
23  
24  import org.jboss.ha.framework.server.ClusterPartitionMBean;
25  import org.jboss.system.ServiceMBean;
26  
27  /**
28   * Cache Invalidation bridge working over JavaGroup.
29   * The partition to be used and the invalidation manager can be defined as part
30   * of the MBean interface.
31   * The bridge automatically discovers which are the InvalidationGroup that are
32   * managed by other node of the cluster and only send invalidation information
33   * for these groups over the network. This makes this bridge very easy to setup
34   * while still being efficient with network resource and CPU serialization cost.
35   *
36   * @see JGCacheInvalidationBridge
37   * @see org.jboss.cache.invalidation.InvalidationManager
38   *
39   * @author  <a HREF="mailto:sacha.labourey@cogito-info.ch">Sacha Labourey</a>.
40   * @version $Revision: 43877 $
41   *
42   * <p><b>Revisions:</b>
43   *
44   * <p><b>24 septembre 2002 Sacha Labourey:</b>
45   * <ul>
46   * <li> First implementation </li>
47   * </ul>
48   */
49  
50  public interface JGCacheInvalidationBridgeMBean extends ServiceMBean
51  {
52     /** 
53      * Gets the name of the Clustering partition to be used to exchange
54      * invalidation messages and discover which caches (i.e. InvalidationGroup)
55      * are available
56      * 
57      * @return the name of the partition
58      * 
59      * @deprecate use {@link #getClusterPartition()}
60      */
61     String   getPartitionName();
62     /**
63      * Sets the name of the Clustering partition to be used to exchange
64      * invalidation messages and discover which caches (i.e. InvalidationGroup)
65      * are available
66      * 
67      * @param name the name of the partition
68      * 
69      * @deprecate use {@link #setClusterPartition()}
70      */
71     void setPartitionName(String   name);
72     
73     /**
74      * Get the underlying partition used by this service to exchange
75      * invalidation messages and discover which caches (i.e. InvalidationGroup)
76      * are available
77      * 
78      * @return the partition
79      */
80     ClusterPartitionMBean getClusterPartition();
81     
82     /**
83      * Sets the underlying partition used by this service to exchange
84      * invalidation messages and discover which caches (i.e. InvalidationGroup)
85      * are available
86      * 
87      * @param clusterPartition the partition
88      */
89     void setClusterPartition(ClusterPartitionMBean clusterPartition);
90     
91     /**
92      * ObjectName of the InvalidationManager to be used. Optional: in this
93      * case, the default InvalidationManager is used.
94      */
95     public String   getInvalidationManager ();
96     public void setInvalidationManager (String   objectName);
97     
98     public String   getBridgeName ();
99     public void setBridgeName (String   name);
100    
101 }
102
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags