Module io.helidon.service.registry

Package io.helidon.service.registry

Interface ActivationRequest

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

ActivationRequest.BuilderBase.ActivationRequestImpl

public interface ActivationRequest
extends Prototype.Api

Request to activate a service.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ActivationRequest.Builder	Fluent API builder for ActivationRequest.
static class	ActivationRequest.BuilderBase<BUILDER extends ActivationRequest.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ActivationRequest>	Fluent API builder base for ActivationRequest.

Method Summary

Modifier and Type	Method	Description
static ActivationRequest.Builder	builder()	Create a new fluent API builder to customize configuration.
static ActivationRequest.Builder	builder(ActivationRequest instance)	Create a new fluent API builder from an existing instance.
static ActivationRequest	create()	Create a new instance with default values.
Optional<ActivationPhase>	startingPhase()	The phase to start activation.
ActivationPhase	targetPhase()	Ultimate target phase for activation.
boolean	throwIfError()	Whether to throw an exception on failure to activate, or return an error activation result on activation.

Method Details

builder

static ActivationRequest.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ActivationRequest.Builder builder(ActivationRequest instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static ActivationRequest create()

Create a new instance with default values.

Returns:

a new instance

startingPhase

Optional<ActivationPhase> startingPhase()

The phase to start activation. Typically, this should be left as the default (i.e., PENDING).

Returns:

phase to start

targetPhase

ActivationPhase targetPhase()

Ultimate target phase for activation.

Defaults to ActivationPhase.ACTIVE, unless configured otherwise (in the registry).

Returns:

phase to target

throwIfError

boolean throwIfError()

Whether to throw an exception on failure to activate, or return an error activation result on activation.

Returns:

whether to throw on failure