org.apache.geode.internal.cache.extension.Extension Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of geode-core Show documentation

Apache Geode provides a database-like consistency model, reliable transaction processing and a shared-nothing architecture to maintain very low latency performance with high concurrency processing

There is a newer version: 1.15.1

Show newest version

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

import org.apache.geode.cache.Cache;
import org.apache.geode.internal.cache.xmlcache.CacheXml;
import org.apache.geode.internal.cache.xmlcache.XmlGenerator;

/**
 * Interface used for objects wishing to extend and {@link Extensible} object.
 * 
 *
 * @since GemFire 8.1
 */
public interface Extension {

  /**
   * Get {@link XmlGenerator} capable of serializing this object's configuration.
   * 
   * @return {@link XmlGenerator} for this object's configuration.
   * @since GemFire 8.1
   */
  XmlGenerator getXmlGenerator();

  /**
   * Called by {@link CacheXml} objects that are {@link Extensible} before creating this extension.
   *
   * @param source source object this extension is currently attached to.
   * @param cache target object to attach any created extensions to.
   * @since Geode 1.0.0
   */
  void beforeCreate(Extensible source, Cache cache);

  /**
   * Called by {@link CacheXml} objects that are {@link Extensible} to create this extension.
   *
   * @param source source object this extension is currently attached to.
   * @param target target object to attach any created extensions to.
   * @since GemFire 8.1
   */
  void onCreate(Extensible source, Extensible target);

}