modules/core/src/main/java/org/apache/ignite/plugin/CacheTopologyValidatorProvider.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.ignite.plugin;

import org.apache.ignite.configuration.TopologyValidator;

/**
 * The {@link CacheTopologyValidatorProvider} is used to pass an implementation of {@link TopologyValidator}s for a specific
 * cache through Ignite plugin extensions mechanism. Each cache, on startup, iterates over all registered
 * {@link CacheTopologyValidatorProvider}s and tries to obtain the instance of {@link TopologyValidator} by
 * cache name. All obtained {@link TopologyValidator}s are saved in the cache context and successively called during
 * topology validation process. The topology validation is passed if all {@link TopologyValidator}s consider that
 * the current topology is valid.
 *
 * @see TopologyValidator
 * @see Extension
 * @see PluginProvider#initExtensions(PluginContext, ExtensionRegistry)
 */
public interface CacheTopologyValidatorProvider extends Extension {
    /**
     * Provides instance of {@link TopologyValidator} for the cache with specified name.
     *
     * @param cacheName Name of the cache or cache group.
     * @return Instance of topology validator for the cache with specified name.
     */
    public TopologyValidator topologyValidator(String cacheName);
}