com.gemstone.gemfire.internal.cache.CacheDistributionAdvisee 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

The newest version!

/*
 * 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.internal.cache;

import com.gemstone.gemfire.cache.Cache;
import com.gemstone.gemfire.cache.RegionAttributes;
import com.gemstone.gemfire.distributed.internal.DistributionAdvisee;
import com.gemstone.gemfire.internal.cache.CacheDistributionAdvisor.CacheProfile;

/**
 * Distributed cache object (typically a Region) which uses
 * a {@link CacheDistributionAdvisor}.
 * @author Kirk Lund
 * @since 5.1
 */
public interface CacheDistributionAdvisee extends DistributionAdvisee {

  /**
   * Returns the CacheDistributionAdvisor that provides advice for
   * this advisee.
   * @return the CacheDistributionAdvisor
   */
  public CacheDistributionAdvisor getCacheDistributionAdvisor();

  /**
   * Returns the Cache associated with this cache object.
   * @return the Cache
   */
  public Cache getCache();
  
  /** 
   * Returns the RegionAttributes associated with this advisee.
   * @return the RegionAttributes of this advisee
   */
  public RegionAttributes getAttributes();
  
  /**
   * notifies the advisee that a new remote member has registered a profile
   * showing that it is now initialized
   * 
   * @param profile the remote member's profile
   */
  public void remoteRegionInitialized(CacheProfile profile);
}