geode-core/src/main/java/org/apache/geode/internal/cache/CacheDistributionAdvisee.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You 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.
 */
package org.apache.geode.internal.cache;

import org.apache.geode.cache.RegionAttributes;
import org.apache.geode.distributed.internal.DistributionAdvisee;
import org.apache.geode.internal.cache.CacheDistributionAdvisor.CacheProfile;
import org.apache.geode.internal.cache.CreateRegionProcessor.CreateRegionReplyProcessor;

/**
 * Distributed cache object (typically a <code>Region</code>) which uses a
 * {@link CacheDistributionAdvisor}.
 *
 * @since GemFire 5.1
 */
public interface CacheDistributionAdvisee extends DistributionAdvisee {

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

  /**
   * Returns the <code>Cache</code> associated with this cache object.
   *
   * @return the Cache
   */
  InternalCache getCache();

  /**
   * Returns the <code>RegionAttributes</code> associated with this advisee.
   *
   * @return the <code>RegionAttributes</code> of this advisee
   */
  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
   */
  void remoteRegionInitialized(CacheProfile profile);

  /**
   * Allow this advisee to know the CreateRegionReplyProcessor that is creating it.
   *
   * @param processor the CreateRegionReplyProcessor that is creating the advisee
   */
  default void registerCreateRegionReplyProcessor(CreateRegionReplyProcessor processor) {}
}