com.hedera.node.app.service.networkadmin.FreezeService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of app-service-network-admin Show documentation

Hedera NetworkAdmin Service API

The newest version!

/*
 * Copyright (C) 2020-2024 Hedera Hashgraph, LLC
 *
 * 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.hedera.node.app.service.networkadmin;

import com.hedera.node.app.spi.RpcService;
import com.hedera.node.app.spi.RpcServiceFactory;
import com.hedera.pbj.runtime.RpcServiceDefinition;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.ServiceLoader;
import java.util.Set;

/**
 * Implements the HAPI Freeze
 * Service.
 */
public interface FreezeService extends RpcService {

    String NAME = "FreezeService";

    /**
     * Returns the service name.
     * @return the service name
     */
    @NonNull
    @Override
    default String getServiceName() {
        return NAME;
    }

    /**
     * Returns the RPC definitions for the service.
     * @return the RPC definitions
     */
    @NonNull
    @Override
    default Set rpcDefinitions() {
        return Set.of(FreezeServiceDefinition.INSTANCE);
    }

    /**
     * Returns the concrete implementation instance of the service.
     *
     * @return the implementation instance
     */
    @NonNull
    static FreezeService getInstance() {
        return RpcServiceFactory.loadService(FreezeService.class, ServiceLoader.load(FreezeService.class));
    }
}