com.hedera.node.app.spi.workflows.WarmupContext Maven / Gradle / Ivy
/*
* Copyright (C) 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.spi.workflows;
import com.hedera.hapi.node.transaction.TransactionBody;
import edu.umd.cs.findbugs.annotations.NonNull;
/**
* Represents the context of a single {@code warm()}-call.
*/
public interface WarmupContext {
/**
* Gets the {@link TransactionBody}
*
* @return the {@link TransactionBody} in this context
*/
@NonNull
TransactionBody body();
/**
* Create a new store given the store's interface. This gives read-only access to the store.
*
* @param storeInterface The store interface to find and create a store for
* @param Interface class for a Store
* @return An implementation of store interface provided, or null if the store
* @throws IllegalArgumentException if the storeInterface class provided is unknown to the app
* @throws NullPointerException if {@code storeInterface} is {@code null}
*/
@NonNull
C createStore(@NonNull final Class storeInterface);
}