Package graphql.execution

Interface EngineRunningObserver

@ExperimentalApi
@NullMarked
public interface EngineRunningObserver

This class lets you observe the running state of the graphql-java engine. As it processes and dispatches graphql fields, the engine moves in and out of a running and not running state. As it does this, the callback is called with information telling you the current state.

If the engine is cancelled via ExecutionInput.cancel() then the observer will also be called to indicate that.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EngineRunningObserver.RunningState

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENGINE_RUNNING_OBSERVER_KEY

Method Summary

Modifier and Type	Method	Description
void	runningStateChanged(@Nullable ExecutionId executionId, GraphQLContext graphQLContext, EngineRunningObserver.RunningState runningState)	This will be called when the running state of the graphql-java engine changes.

Field Details

ENGINE_RUNNING_OBSERVER_KEY

static final String ENGINE_RUNNING_OBSERVER_KEY

See Also:

• Constant Field Values

Method Details

runningStateChanged

void runningStateChanged(@Nullable ExecutionId executionId,
 GraphQLContext graphQLContext,
 EngineRunningObserver.RunningState runningState)

This will be called when the running state of the graphql-java engine changes.

Parameters:

executionId - the id of the current execution. This could be null when the engine starts, if there is no execution id provided in the execution input

graphQLContext - the graphql context