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

Class VersionProvider.Builder

java.lang.Object

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

Enclosing class:

VersionProvider

public static class VersionProvider.Builder
extends Object

Builder for VersionProvider instances.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
VersionProvider	build()	Builds a VersionProvider instance.
VersionProvider.Builder	entries(Map<String,String> values)	Bulk-set entries from a map.
VersionProvider.Builder	entry(String key, String value)	Sets a single entry, overwriting any prior value for that key.
VersionProvider.Builder	fromGitProperties()	Reads git.commit.id, git.branch, and git.build.time from /git.properties on the VersionProvider classloader.
VersionProvider.Builder	fromGitProperties(ClassLoader classLoader)	Reads git.properties from the supplied classloader.
VersionProvider.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.
VersionProvider.Builder	fromManifest()	Reads Implementation-Title, Implementation-Version, Implementation-Vendor, and Build-Jdk from /META-INF/MANIFEST.MF on the VersionProvider classloader.
VersionProvider.Builder	fromManifest(ClassLoader classLoader)	Reads manifest attributes from /META-INF/MANIFEST.MF on the supplied classloader.
VersionProvider.Builder	fromManifest(Manifest manifest)	Reads a Manifest that the importer registered as a bean (e.g.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor — protected access for VersionProvider.create().

Method Details

entry

public VersionProvider.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 VersionProvider.UNKNOWN).

Returns:

This object.

entries

public VersionProvider.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 VersionProvider.UNKNOWN.

Returns:

This object.

fromManifest

public VersionProvider.Builder fromManifest()

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

Missing keys are recorded as VersionProvider.UNKNOWN. A missing MANIFEST.MF resource is silently skipped.

Returns:

This object.

fromManifest

public VersionProvider.Builder fromManifest(ClassLoader classLoader)

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

Useful under Spring Boot fat jars, where the importer's app manifest is reachable from its own classloader but not the framework's. Missing keys are recorded as VersionProvider.UNKNOWN; a missing MANIFEST.MF resource is silently skipped.

Parameters:

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

Returns:

This object.

fromManifest

public VersionProvider.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 VersionProvider.Builder fromGitProperties()

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

Returns:

This object.

fromGitProperties

public VersionProvider.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 VersionProvider.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 VersionProvider build()

Builds a VersionProvider instance.

Returns:

A configured instance.