Package org.apache.juneau.rest.server.convention

Class VersionMixin.Builder

java.lang.Object

org.apache.juneau.rest.server.AbstractRestBuilder<R,SELF>

org.apache.juneau.rest.server.servlet.RestMixin.Builder<VersionMixin,VersionMixin.Builder>

org.apache.juneau.rest.server.convention.VersionMixin.Builder

All Implemented Interfaces:

RestBuilder<VersionMixin.Builder>

Enclosing class:

VersionMixin

public static class VersionMixin.Builder
extends RestMixin.Builder<VersionMixin,VersionMixin.Builder>

Builder for VersionMixin instances.

Mirrors VersionProvider.Builder's configuration methods on the mixin's own surface and forwards each call to an underlying VersionProvider.Builder, which builds the shared worker the mixin delegates to.

Extends RestMixin.Builder so the mixin's bespoke worker-config setters chain with true covariant returns alongside the inherited RestBuildersurface (e.g. path, roleGuard). The worker config is forwarded once into VersionProvider.Builder and the REST config is inherited once from AbstractRestBuilder — no triplication across the Version flavors.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(VersionProvider.Builder worker)	Constructor — protected access for VersionMixin.create().

Method Summary

Modifier and Type	Method	Description
VersionMixin	build()	Builds a VersionMixin instance.
VersionMixin.Builder	entries(Map<String,String> values)	Bulk-set entries from a map.
VersionMixin.Builder	entry(String key, String value)	Sets a single entry, overwriting any prior value for that key.
VersionMixin.Builder	fromGitProperties()	Reads git.commit.id, git.branch, and git.build.time from /git.properties on the framework classloader.
VersionMixin.Builder	fromGitProperties(ClassLoader classLoader)	Reads git.properties from the supplied classloader.
VersionMixin.Builder	fromJavaVersion()	Adds the running JVM's java.version system property as the javaVersion entry, unless an earlier fromManifest(...) call already supplied one from Build-Jdk.
VersionMixin.Builder	fromManifest()	Reads Implementation-Title, Implementation-Version, Implementation-Vendor, and Build-Jdk from /META-INF/MANIFEST.MF on the framework classloader.
VersionMixin.Builder	fromManifest(ClassLoader classLoader)	Reads manifest attributes from /META-INF/MANIFEST.MF on the supplied classloader.
VersionMixin.Builder	fromManifest(Manifest manifest)	Reads a Manifest that the importer registered as a bean (e.g.

Methods inherited from class org.apache.juneau.rest.server.AbstractRestBuilder

allowedHeaderParams, allowedMethodHeaders, allowedMethodParams, allowedParserOptions, allowedSerializerOptions, asyncCompletionExecutor, asyncTimeoutMillis, children, clientVersionHeader, config, consumes, converters, createResource, debugMarshalling, defaultAccept, defaultCharset, defaultContentType, defaultRequestAttributes, defaultRequestHeaders, defaultResponseHeaders, description, disableContentParam, eagerInit, encoders, getExtras, getMdcAsyncPropagation, getResourceType, guards, lazyChildren, maxInput, mdcAsyncPropagation, messages, mixinDefs, mixins, noInherit, observability, openApiProvider, parsers, partParser, partSerializer, path, paths, problemDetails, produces, renderResponseStackTraces, responseProcessors, restOpArgs, roleGuard, rolesDeclared, self, serializers, set, siteName, staticFiles, swaggerProvider, title, toRestAnnotation, uriAuthority, uriContext, uriRelativity, uriResolution, virtualThreads

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

protected Builder(VersionProvider.Builder worker)

Constructor — protected access for VersionMixin.create().

Method Details

entry

public VersionMixin.Builder entry(String key,
 String value)

Sets a single entry, overwriting any prior value for that key.

Parameters:

key - The entry key. Must not be null or blank.

value - The entry value (a null value is recorded as VersionMixin.UNKNOWN).

Returns:

This object.

entries

public VersionMixin.Builder entries(Map<String,String> values)

Bulk-set entries from a map.

Parameters:

values - Entries to add. Can be null (no-op). Individual null values are recorded as VersionMixin.UNKNOWN.

Returns:

This object.

fromManifest

public VersionMixin.Builder fromManifest()

Reads Implementation-Title, Implementation-Version, Implementation-Vendor, and Build-Jdk from /META-INF/MANIFEST.MF on the framework classloader.

Returns:

This object.

fromManifest

public VersionMixin.Builder fromManifest(ClassLoader classLoader)

Reads manifest attributes from /META-INF/MANIFEST.MF on the supplied classloader.

Parameters:

classLoader - The classloader to walk. Must not be null.

Returns:

This object.

fromManifest

public VersionMixin.Builder fromManifest(Manifest manifest)

Reads a Manifest that the importer registered as a bean (e.g. @Bean Manifest appManifest()).

Parameters:

manifest - The manifest to read. Must not be null.

Returns:

This object.

fromGitProperties

public VersionMixin.Builder fromGitProperties()

Reads git.commit.id, git.branch, and git.build.time from /git.properties on the framework classloader.

Returns:

This object.

fromGitProperties

public VersionMixin.Builder fromGitProperties(ClassLoader classLoader)

Reads git.properties from the supplied classloader.

Parameters:

classLoader - The classloader to walk. Must not be null.

Returns:

This object.

fromJavaVersion

public VersionMixin.Builder fromJavaVersion()

Adds the running JVM's java.version system property as the javaVersion entry, unless an earlier fromManifest(...) call already supplied one from Build-Jdk.

Returns:

This object.

build

public VersionMixin build()

Builds a VersionMixin instance.

Overrides:

build in class RestMixin.Builder<VersionMixin,VersionMixin.Builder>

Returns:

A configured instance.