Uses of Annotation Interface
io.helidon.common.Api.Stable

Packages that use Api.Stable

Package	Description
io.helidon.builder.api	Support for handling the generation of code for Helidon builders and configured builders.
io.helidon.codegen	Code generation and processing support.
io.helidon.common	Common utilities for Helidon projects.
io.helidon.common.buffers	Byte buffers and byte operations.
io.helidon.common.configurable	General utilities that use Config.
io.helidon.common.configurable.spi	Loadable service definitions.
io.helidon.common.context	Support for context propagation across executor boundaries.
io.helidon.common.context.http	Common types for Context propagation over HTTP.
io.helidon.common.context.spi	Provider for data propagation between threads in executor service.
io.helidon.common.crypto	Common cryptography implementations.
io.helidon.common.features.api	API required to describe features in module descriptor.
io.helidon.common.mapper	Support for mapping of types.
io.helidon.common.mapper.spi	SPI to provide mappers for Mappers.
io.helidon.common.media.type	Support for mapping resources to media types, be it files, URIs or URLs.
io.helidon.common.media.type.spi	SPI to provide custom mappings of resources to media types.
io.helidon.common.parameters	Support for parameters with multiple values.
io.helidon.common.pki	Utilities for PKI configuration and loading of certificates and keys.
io.helidon.common.reactive	Common reactive library for Helidon projects.
io.helidon.common.security	Types that are security related and can be used across all components (servers, clients etc.).
io.helidon.common.testing.http.junit5	Testing support for HTTP.
io.helidon.common.testing.junit5	Basic testing support for Helidon.
io.helidon.common.testing.virtualthreads	Virtual Threads testing features.
io.helidon.common.tls	TLS Configuration for client and server.
io.helidon.common.tls.spi	TLS Configuration SPI for client and server.
io.helidon.common.types	Subset of Builder's SPI types that are useful for runtime.
io.helidon.common.uri	URI utilities.
io.helidon.http.encoding.deflate	Deflate encoding support.
io.helidon.http.encoding.gzip	Gzip encoding support.
io.helidon.service.registry	API required to define services, and to compile the code generated sources for Helidon Service Registry, with a core service registry implementation (replacement for ServiceLoader).

Uses of Api.Stable in io.helidon.builder.api

Classes in io.helidon.builder.api with annotations of type Api.Stable

Modifier and Type	Class	Description
final class	BuilderSupport	Static methods used from generated prototypes and builders.
@interface	Description	Custom description.
final class	GeneratedBuilder	Types used from generated code.
final class	Option	Prototype option annotations.
final class	Prototype	Prototype is generated from a prototype blueprint, and it is expected to be part of the public API of the module.
final class	RuntimeType	This class holds all types related to runtime types, configured from prototypes.

Uses of Api.Stable in io.helidon.codegen

Classes in io.helidon.codegen with annotations of type Api.Stable

Modifier and Type	Class	Description
class	Codegen	Central piece of code processing and generation.
interface	CodegenContext	Code processing and generation context.
interface	CodegenEvent	An event happening during code gen to be logged with CodegenLogger.log(CodegenEvent).
class	CodegenException	An exception for any code processing and generation tools.
interface	CodegenFiler	An abstraction for writing out source files and resource files.
interface	CodegenLogger	An abstraction for logging code processing and generation events.
interface	CodegenOptions	Configuration options.
final record	CodegenScope	Scope of the current code generation session.
final class	CodegenUtil	Tools for generating code.
final class	CodegenValidator	Validation utilities.
final class	ElementInfoPredicates	Commonly used predicates to filter typed element info.
interface	FilerResource	A resource from output (such as target/META-INF/helidon) that can have existing values, and may be replaced with a new value.
interface	FilerTextResource	A resource from output (such as target/META-INF/helidon) that can have existing values, and may be replaced with a new value.
enum	IndentType	Indentation kind.
class	ManifestResource	Support for Helidon manifest file, that lists all manifest resources on the classpath.
interface	ModuleInfo	Module info.
final record	ModuleInfoRequires	A requires definition of a module-info.java.
final class	ModuleInfoSourceParser	Support for parsing module-info.java sources.
interface	Option<T>	Option definition.
interface	RoundContext	Context of a single round of code generation.
final class	TypeHierarchy	Utilities for type hierarchy.

Uses of Api.Stable in io.helidon.common

Classes in io.helidon.common with annotations of type Api.Stable

Modifier and Type	Class	Description
final class	Api	Annotations used to describe and enforce Helidon API stability contracts.
static @interface	Api.Incubating	An incubating API (type, method, or constructor).
static @interface	Api.Internal	An internal API (type, method, or constructor).
static @interface	Api.Preview	A preview API (type, method, or constructor).
static @interface	Api.Since	API may add this annotation to mark the first Helidon version that contains the current contract.
static @interface	Api.Stable	Stable API.
class	Base64Value	Base64 wrapper.
interface	Builder<B extends Builder<B,T>, T>	Interface for builders, to be able to accept a builder in addition to an instance.
final class	Errors	Errors utility used to file processing messages (e.g.
static class	Errors.Collector	A collector of Errors.ErrorMessages.
static class	Errors.ErrorMessage	Error message with a severity and a source.
static final class	Errors.ErrorMessagesException	Exception used by Errors.checkValid() thrown in case there are fatal messages.
final class	Functions	Functional interfaces required to complement the Runnable, Callable, and Supplier to help with checked exceptions in lambdas.
static interface	Functions.CheckedBiConsumer<T, U, E extends Throwable>	Checked bi-consumer.
static interface	Functions.CheckedConsumer<T, E extends Throwable>	Checked consumer.
static interface	Functions.CheckedFunction<T, U, E extends Throwable>	Checked consumer.
static interface	Functions.CheckedRunnable<E extends Throwable>	Checked runnable.
static interface	Functions.CheckedSupplier<T, E extends Throwable>	Checked supplier.
@interface	Generated	Annotation marking this type as generated.
class	GenericType<T>	Represents a full type including generics declaration, to avoid information loss due to type erasure.
final class	HelidonServiceLoader<T>	Helidon specific support for Java Service Loaders.
static final class	HelidonServiceLoader.Builder<T>	Fluent api builder for HelidonServiceLoader.
interface	LazyList<T>	Wrapper for list of LazyValues while keeping laziness.
interface	LazyValue<T>	A typed supplier that wraps another supplier and only retrieves the value on the first request to Supplier.get(), caching the value for all subsequent invocations.
interface	LruCache<K,V>	Least recently used cache.
final class	NativeImageHelper	Utility for GraalVM native image.
@interface	Reflected	A type annotated with this annotation will be added to native image with reflection support for all methods and fields (including private).
final class	SerializationConfig	Support for JEP 290 - deserialization filtering.
static enum	SerializationConfig.Action	What action to take if there is no global filter configured, or if the configuration is not according to Helidon expectations.
static class	SerializationConfig.Builder	Fluent API builder to customize SerializationConfig.
static enum	SerializationConfig.TraceOption	Deserialization tracing options.
enum	Severity	Severity of an event.
interface	Size	A definition of size in bytes.
static enum	Size.Unit	Units that can be used.
static enum	Size.UnitKind	Kind of units, used for printing out the correct unit.
class	UncheckedException	Unchecked exception.
final class	Version	Simple class to provide version information.
@interface	Weight	Annotation that can define a type weight.
interface	Weighted	Interface to define that this class is a class with weight.
final class	Weights	Weight utilities.
interface	Wrapper	Behavior of a type that wraps a related type, typically through delegation.

Uses of Api.Stable in io.helidon.common.buffers

Classes in io.helidon.common.buffers with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	BufferData	Wrapper around a byte array.
interface	CompositeBufferData	Composite (mutable) buffer data.
interface	DataListener<T>	A listener for data.
class	DataReader	Data reader that can pull additional data.
interface	DataWriter	Write data to the underlying transport (most likely a socket).

Uses of Api.Stable in io.helidon.common.configurable

Classes in io.helidon.common.configurable with annotations of type Api.Stable

Modifier and Type	Class	Description
class	AllowList	AllowList defines a list of allowed and/or denied matches and tests if a particular value conforms to the conditions.
interface	AllowListConfig	AllowList defines a list of allowed and/or denied matches and tests if a particular value conforms to the conditions.
interface	Resource	A representation of a resource that can be loaded from URL (Resource.create(URI)), classpath (Resource.create(String)), filesystem (Resource.create(Path), content in config (Resource.create(Config), input stream(Resource.create(String, InputStream), or direct value (Resource.create(String, byte[]), Resource.create(String, String).
interface	ResourceConfig	Configuration of a resource.
class	ResourceException	Exception used from Resource and other resource related components marking an issue with access to a Resource or instance generated from it.
interface	ScheduledThreadPoolConfig	Interface generated from blueprint io.helidon.common.configurable.ScheduledThreadPoolConfigBlueprint.
final class	ScheduledThreadPoolSupplier	Supplier of a custom scheduled thread pool.
final class	ServerThreadPoolSupplier	Supplier of a custom thread pool with defaults appropriate for a thread-per-request server.
class	ThreadPool	A ThreadPoolExecutor with an extensible growth policy and queue state accessors.
interface	ThreadPoolConfig	Interface generated from blueprint io.helidon.common.configurable.ThreadPoolConfigBlueprint.
final class	ThreadPoolSupplier	Supplier of a custom thread pool.

Uses of Api.Stable in io.helidon.common.configurable.spi

Classes in io.helidon.common.configurable.spi with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	ExecutorServiceSupplierObserver	Behavior for observers of the various executor service suppliers.

Uses of Api.Stable in io.helidon.common.context

Classes in io.helidon.common.context with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	Context	A registry for context objects.
interface	ContextAwareExecutorService	An interface for wrapped executor services.
final class	Contexts	Support for handling Context across thread boundaries.
class	ExecutorException	Exception related to execution of a task in context.

Uses of Api.Stable in io.helidon.common.context.http

Classes in io.helidon.common.context.http with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	ContextRecordConfig	Configuration of a single propagation record, a mapping of a header name to its context classifier, with optional default value(s), and definition whether it is a single value, or an array.

Uses of Api.Stable in io.helidon.common.context.spi

Classes in io.helidon.common.context.spi with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	DataPropagationProvider<T>	This is an SPI provider which helps user to propagate values from one thread to another.

Uses of Api.Stable in io.helidon.common.crypto

Classes in io.helidon.common.crypto with annotations of type Api.Stable

Modifier and Type	Class	Description
class	AsymmetricCipher	This class provides simple and stateless way to encrypt and decrypt messages using selected asymmetric cipher.
interface	CommonCipher	Common cipher which helps to simplify encryption and decryption of the message.
class	CryptoException	Common cryptography exception.
interface	Digest	Common digest which simplifies digest creation and its verification.
class	HashDigest	The HashDigest is used for ordinary data digest creation and verification.
class	HmacDigest	The HmacDigest is used for simplification of the HMAC signature creation and verification.
class	PasswordKeyDerivation	Util class used for encryption key derivation from the password.
class	Signature	The Signature class is used for simplification of the digital signature creation and verification.
class	SymmetricCipher	This class provides simple and stateless way to encrypt and decrypt messages using selected symmetric cipher.

Uses of Api.Stable in io.helidon.common.features.api

Classes in io.helidon.common.features.api with annotations of type Api.Stable

Modifier and Type	Class	Description
final class	Features	A container class for annotations and types related to declaration of Helidon features.
enum	HelidonFlavor	Flavors of Helidon.

Uses of Api.Stable in io.helidon.common.mapper

Classes in io.helidon.common.mapper with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	Mapper<SOURCE,TARGET>	A generic and general approach to mapping two types.
class	MapperException	An exception that is thrown when mapping failed to map source to target.
interface	Mappers	Mappers manager of all configured mappers.
interface	MappersConfig	Mappers configuration.
interface	OptionalValue<T>	A typed value with support for mapping (conversion) to other types.
interface	Value<T>	A typed value with support for mapping (conversion) to other types.

Uses of Api.Stable in io.helidon.common.mapper.spi

Classes in io.helidon.common.mapper.spi with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	MapperProvider	Java Service loader service to get mappers.
static final record	MapperProvider.ProviderResponse	Response of a provider.
static enum	MapperProvider.Support	How does this provider support the type.

Uses of Api.Stable in io.helidon.common.media.type

Classes in io.helidon.common.media.type with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	MediaType	Media type support and known media types.
final class	MediaTypes	Media type detection based on a resource.
enum	ParserMode	Media type parsing mode.

Uses of Api.Stable in io.helidon.common.media.type.spi

Classes in io.helidon.common.media.type.spi with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	MediaTypeDetector	Detect media type.

Uses of Api.Stable in io.helidon.common.parameters

Classes in io.helidon.common.parameters with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	Parameters	Parameters abstraction (used by any component that has named parameters with possible multiple values).

Uses of Api.Stable in io.helidon.common.pki

Classes in io.helidon.common.pki with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	Keys	Configuration of keys.
interface	KeystoreKeys	Resources from a java keystore (PKCS12, JKS etc.).
interface	PemKeys	PEM files based keys - accepts private key and certificate chain.
final class	PemReader	Reads a PEM file and converts it into a list of DERs so that they are imported into a KeyStore easily.
class	PkiException	Exception caused by PKI handling (keystores, keys, certificates).

Uses of Api.Stable in io.helidon.common.reactive

Classes in io.helidon.common.reactive with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	Awaitable<T>	Makes intentional blocking when waiting for CompletableFuture more convenient with Awaitable.await() and Awaitable.await(long, java.util.concurrent.TimeUnit) methods.
class	BufferedEmittingPublisher<T>	Emitting publisher for manual publishing with built-in buffer for handling backpressure.
interface	Collector<T,U>	A collector accumulates the items provided when Collector.collect(java.lang.Object) is invoked and makes them available in a single container object with Collector.value().
class	CompletionAwaitable<T>	CompletionStage wrapper enriched with Awaitable.
class	CompletionSingle<T>	Single as CompletionStage.
final class	ConcatPublisher<T>	Concat streams to one.
class	EmittingPublisher<T>	Emitting publisher for manual publishing on the same thread.
interface	IoMulti	Create reactive stream from standard IO resources.
interface	Multi<T>	Represents a Flow.Publisher emitting zero or more items, optionally followed by an error or completion.
final class	MultiTappedPublisher<T>	Intercept the calls to the various Flow interface methods and calls the appropriate user callbacks.
interface	OptionalCompletionStage<T>	A completion stage that allows processing of cases when the element is present and when not.
class	OutputStreamMulti	Output stream that Flow.Publisher publishes any data written to it as ByteBuffer events.
class	RequestedCounter	Requested event counter.
interface	RetrySchema	Defines delay for next read/poll operation in a polling publisher.
class	SequentialSubscriber<T>	Wrapper Flow.Subscriber ensuring OnSubscribe, onNext, onError and onComplete to be signaled serially.
interface	Single<T>	Represents a Flow.Publisher that may: signal one item then completes, complete without an item or signal an error.
class	SingleSubscriberHolder<T>	A subscriber container that accepts only a single, one-time subscriber registration.
interface	Subscribable<T>	Decorated publisher that allows subscribing to individual events with java functions.

Uses of Api.Stable in io.helidon.common.security

Classes in io.helidon.common.security with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	SecurityContext<P extends Principal>	Security context.

Uses of Api.Stable in io.helidon.common.testing.http.junit5

Classes in io.helidon.common.testing.http.junit5 with annotations of type Api.Stable

Modifier and Type	Class	Description
final class	HttpHeaderMatcher	Matchers for Headers.
class	SocketHttpClient	The SocketHttpClient provides means to simply pass any bytes over the network and to see how a server deals with such a case.

Uses of Api.Stable in io.helidon.common.testing.junit5

Classes in io.helidon.common.testing.junit5 with annotations of type Api.Stable

Modifier and Type	Class	Description
final class	FileMatchers	Hamcrest matchers for Path.
class	InMemoryLoggingHandler	Captures log records in memory for later retrieval.
class	LogRecordMatcher	Hamcrest matcher for a LogRecord.
final class	MapMatcher	Hamcrest matchers for Map.
class	MatcherWithRetry	Hamcrest matcher capable of configured retries before failing the assertion, plus more generic retry processing.
final class	OptionalMatcher	Hamcrest matchers for Optional.
class	RestoreSystemPropertiesExt	JUnit 5 extension for preserving and restoring system properties around test executions.

Uses of Api.Stable in io.helidon.common.testing.virtualthreads

Classes in io.helidon.common.testing.virtualthreads with annotations of type Api.Stable

Modifier and Type	Class	Description
class	PinningAssertionError	Assertion error used for reporting of Virtual Thread pinning detected during test.
class	PinningRecorder	Record pinned thread events and throw exception when detected.

Uses of Api.Stable in io.helidon.common.tls

Classes in io.helidon.common.tls with annotations of type Api.Stable

Modifier and Type	Class	Description
class	ConfiguredTlsManager	The default configured TlsManager implementation.
interface	RevocationConfig	Certificate revocation configuration.
class	Tls	TLS configuration - common for server and client.
enum	TlsClientAuth	Type of client authentication.
interface	TlsConfig	TLS configuration, used by web server listeners, web client and other components that need TLS.
interface	TlsManager	Implementors of this contract are responsible for initializing a single SSLContext identity and managing the TlsReloadableComponent instances that provide its key and trust material.
interface	TlsMaterial	TLS key and trust material used to set up or reload manager state.

Uses of Api.Stable in io.helidon.common.tls.spi

Classes in io.helidon.common.tls.spi with annotations of type Api.Stable

Modifier and Type	Interface	Description
interface	TlsManagerProvider	ServiceLoader service provider for TlsManager.

Uses of Api.Stable in io.helidon.common.types

Classes in io.helidon.common.types with annotations of type Api.Stable

Modifier and Type	Class	Description
enum	AccessModifier	Access modifier of the class model components.
interface	Annotated	Annotated elements provide annotations and their values.
interface	Annotation	An annotation with defined values.
interface	AnnotationProperty	A property of an annotation.
final class	Annotations	Annotation utilities.
enum	ElementKind	Kind of element.
interface	ElementSignature	Signature of a TypedElementInfo.
interface	EnumValue	When creating an Annotation, we may need to create an enum value without access to the enumeration.
enum	Modifier	Modifiers except for AccessModifier.
interface	ModuleInfoExports	An exports directive of a module info.
interface	ModuleInfoOpens	An opens directive of a module info.
interface	ModuleInfoProvides	A provides directive of a module info.
interface	ModuleInfoRequires	A requires directive of a module info.
interface	ModuleInfoUses	A uses directive of a module info.
interface	ModuleTypeInfo	Module info type information.
interface	ResolvedType	A wrapper for TypeName that uses the resolved name for equals and hashCode.
interface	TypedElementInfo	An annotation with defined values.
interface	TypeInfo	Represents the model object for a type.
interface	TypeName	TypeName is similar to Type in its most basic use case.
final class	TypeNames	Commonly used type names.

Uses of Api.Stable in io.helidon.common.uri

Classes in io.helidon.common.uri with annotations of type Api.Stable

Modifier and Type	Class	Description
final class	UriAuthority	Normalized URI authority.
final class	UriEncoding	Support for encoding and decoding of URI in HTTP.
class	UriFragment	Fragment section of the URI.
final class	UriHost	Normalized host value.
interface	UriInfo	Information about URI, that can be used to invoke a specific request over the network.
interface	UriPath	Abstraction of HTTP path supporting matrix parameters.
interface	UriPathSegment	Segment of a path.
interface	UriQuery	HTTP Query representation.
interface	UriQueryWriteable	Mutable HTTP query.
class	UriValidationException	A URI validation exception.
final class	UriValidator	Validate parts of the URI.

Uses of Api.Stable in io.helidon.http.encoding.deflate

Classes in io.helidon.http.encoding.deflate with annotations of type Api.Stable

Modifier and Type	Class	Description
class	DeflateEncoding	Support for deflate content encoding.

Uses of Api.Stable in io.helidon.http.encoding.gzip

Classes in io.helidon.http.encoding.gzip with annotations of type Api.Stable

Modifier and Type	Class	Description
class	GzipEncoding	Support for gzip content encoding.

Uses of Api.Stable in io.helidon.service.registry

Classes in io.helidon.service.registry with annotations of type Api.Stable

Modifier and Type	Class	Description
final class	Interception	Interception annotations and types.
final class	Service	A set of annotations (and APIs) required to declare a service.