com.gemstone.gemfire.cache.CacheCallback Maven / Gradle / Ivy

Go to download

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;

/**
 * User-defined objects that can be plugged into caching to receive callback
 * notifications.
 *
 * @author Eric Zoerner
 *
 * @since 3.0
 */
public interface CacheCallback {
  /** Called when the region containing this callback is closed or destroyed, when
   * the cache is closed, or when a callback is removed from a region
   * using an AttributesMutator.
   *
   * Implementations should cleanup any external
   * resources such as database connections. Any runtime exceptions this method
   * throws will be logged.
   *
   * It is possible for this method to be called multiple times on a single
   * callback instance, so implementations must be tolerant of this.
   *
   * @see Cache#close()
   * @see Region#close
   * @see Region#localDestroyRegion()
   * @see Region#destroyRegion()
   * @see AttributesMutator
   */
  public void close();
}