com.gemstone.gemfire.cache.partition.PartitionListener Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
SnappyData store based off Pivotal GemFireXD
There is a newer version: 2.0-BETA
/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License. You
 * may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License. See accompanying
 * LICENSE file.
 */

package com.gemstone.gemfire.cache.partition;

import com.gemstone.gemfire.cache.PartitionAttributesFactory;
import com.gemstone.gemfire.cache.Region;

/**
 * 
 * A callback for partitioned regions, invoked when a partition region is
 * created or any bucket in a partitioned region becomes primary.

 * 

 * A sample implementation of this interface to colocate partition regions using
 * a primary key without having to honor the redundancy contract for every
 * colocate partition regions is as follows : 

 * 
 *  * public class ColocatingPartitionListener extends PartitionListenerAdapter
 *     implements Declarable {
 *   private Cache cache;
 * 
 *   private List<String> viewRegionNames = new ArrayList<String>();
 * 
 *   public ColocatingPartitionListener() {
 *   }
 * 
 *   public void afterPrimary(int bucketId) {
 *     for (String viewRegionName : viewRegionNames) {
 *       Region viewRegion = cache.getRegion(viewRegionName);
 *       PartitionManager.createPrimaryBucket(viewRegion, bucketId, true, true);
 *     }
 *   }
 * 
 *   public void init(Properties props) {
 *     String viewRegions = props.getProperty("viewRegions");
 *     StringTokenizer tokenizer = new StringTokenizer(viewRegions, ",");
 *     while (tokenizer.hasMoreTokens()) {
 *       viewRegionNames.add(tokenizer.nextToken());
 *     }
 *   }
 * 
 *   public void afterRegionCreate(Region<?, ?> region) {
 *     cache = region.getCache();
 *   }
 * }
 * 
 * 
 * A sample declaration of the ColocatingPartitionListener in cache.xml as
 * follows :

 * 
 *  * <partition-attributes redundant-copies="1">
 *     <partition-listener>
 *         <class-name>com.myCompany.ColocatingPartitionListener</class-name>
 *          <parameter name="viewRegions">
 *              <string>/customer/ViewA,/customer/ViewB</string>
 *          </parameter>             
 *     </partition-listener>
 * </partition-attributes>
 * 
 * 
 * @see PartitionAttributesFactory#addPartitionListener(PartitionListener)
 * 
 *      Note : Please contact [email protected] before using these APIs
 * 
 * @author Yogesh Mahajan
 * @since 6.5
 * 
 */
public interface PartitionListener {

  /**
   * Callback invoked when any bucket in a partitioned region becomes primary
   * 
   * @param bucketId
   *          id of the bucket which became primary
   * @since 6.5
   */
  public void afterPrimary(int bucketId);

  /**
   * Callback invoked when a partition region is created
   * 
   * @param region
   *          handle of the region which is created
   * @since 6.5
   */
  public void afterRegionCreate(Region region);

  /**
   * Callback invoked after a bucket has been removed from a member (e.g. during
   * rebalancing). This API is useful for maintaining external data structures
   * by bucket id or key.
   * 
   * @param bucketId
   *          id of the bucket removed
   * @param keys
   *          keys in the bucket removed
   * @since 6.6.1
   */
  public void afterBucketRemoved(int bucketId, Iterable keys);

  /**
   * Callback invoked after a bucket has been created in a member (e.g. during
   * rebalancing). This API is useful for maintaining external data structures
   * by bucket id or key. Note that this API is invoked after the initial image
   * has been completed so creates and destroys may occur in the keys. It is
   * best to use this API during periods of no cache activity.
   * 
   * @param bucketId
   *          id of the bucket created
   * @param keys
   *          keys in the bucket created
   * @since 6.6.1
   */
  public void afterBucketCreated(int bucketId, Iterable keys);
}