com.hazelcast.internal.dynamicconfig.search.ConfigSupplier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hazelcast Show documentation

Core Hazelcast Module

There is a newer version: 5.5.0

/*
 * Copyright (c) 2008-2023, Hazelcast, 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.
 */

package com.hazelcast.internal.dynamicconfig.search;

import com.hazelcast.config.Config;
import com.hazelcast.internal.dynamicconfig.ConfigurationService;
import com.hazelcast.nio.serialization.IdentifiedDataSerializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Map;

/**
 * Config supplier, which helps to match type of the config to corresponding search method.
 *
 * @param  specifies type of the config
 * @since 3.11
 * @see ConfigSearch
 */
public interface ConfigSupplier {
    /**
     * Get dynamic configuration for the given name
     *
     * @param configurationService configuration service
     * @param name data structure name
     * @return configuration if found, or null
     */
    @Nullable
    T getDynamicConfig(@Nonnull ConfigurationService configurationService, @Nonnull String name);

    /**
     * Get static configuration for the given name
     *
     * @param staticConfig static config
     * @param name data structure name
     * @return configuration if found, or null
     */
    @Nullable
    T getStaticConfig(@Nonnull Config staticConfig, @Nonnull String name);

    /**
     * Get all static configs for the given config type.
     * @param staticConfig static config
     * @return name-to-config map
     */
    Map getStaticConfigs(@Nonnull Config staticConfig);
}