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

Class VersionProvider

java.lang.Object

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

public class VersionProvider
extends Object

Flavor-neutral version/build-metadata worker bean shared by the version @Rest flavors.

Holds the capability state (the assembled name/version/git*/buildTime/ javaVersion entry map) and the serve logic (write the map as readable JSON, format-pinned to application/json so the endpoint serves JSON even on a vanilla RestServlet host that hasn't wired up JSON serializers). The VersionMixin (mixin), VersionResource (child), and VersionServlet (servlet) flavors are independent @Rest classes that each hold a VersionProvider worker and delegate to it — so the three deployment forms cannot drift, and no flavor is another flavor's worker.

See Also:

• VersionMixin
• VersionResource
• VersionServlet
• REST Server — Mixins and Multi-Mount Paths

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VersionProvider.Builder	Builder for VersionProvider instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	UNKNOWN	Sentinel value returned for entries that the worker couldn't resolve.

Constructor Summary

Constructors

Modifier	Constructor	Description
	VersionProvider()	No-arg constructor — reads MANIFEST.MF, git.properties, and the JVM version from the framework classloader.
protected	VersionProvider(VersionProvider.Builder builder)	Builder constructor.

Method Summary

Modifier and Type	Method	Description
static VersionProvider.Builder	create()	Creates a new builder, with @Value-annotated fields populated through BeanInstantiator from the active Settings chain.
static VersionProvider.Builder	create(BeanStore beanStore)	Creates a new builder using the supplied BeanStore for @Value-resolution and dependency injection.
Map<String,String>	getInfoMap()	Returns the configured info map (test/inspection helper).
void	serve(RestResponse res)	Serves the assembled metadata as a JSON map.

Methods inherited from class java.lang.Object

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

Field Details

UNKNOWN

public static final String UNKNOWN

Sentinel value returned for entries that the worker couldn't resolve.

See Also:

• Constant Field Values

Constructor Details

VersionProvider

public VersionProvider()

No-arg constructor — reads MANIFEST.MF, git.properties, and the JVM version from the framework classloader. Equivalent to create().build().

VersionProvider

protected VersionProvider(VersionProvider.Builder builder)

Builder constructor.

Applies the default lookup chain (VersionProvider.Builder.fromManifest() + VersionProvider.Builder.fromGitProperties() + VersionProvider.Builder.fromJavaVersion()) when no other builder method has been called — ensuring that a freshly-created builder always produces a non-empty payload.

Parameters:

builder - The builder. Must not be null.

Method Details

create

public static VersionProvider.Builder create()

Creates a new builder, with @Value-annotated fields populated through BeanInstantiator from the active Settings chain.

Returns:

A new builder.

create

public static VersionProvider.Builder create(BeanStore beanStore)

Creates a new builder using the supplied BeanStore for @Value-resolution and dependency injection.

Parameters:

beanStore - The bean store to use for dependency injection.

Returns:

A new builder.

serve

public void serve(RestResponse res)
           throws IOException

Serves the assembled metadata as a JSON map.

Format-pinned to application/json — bypasses the host's content negotiation so the endpoint serves JSON even on a vanilla RestServlet host that hasn't wired up JSON serializers explicitly.

Parameters:

res - The current REST response. Must not be null.

Throws:

IOException - If an I/O error occurs while writing the response.

getInfoMap

public Map<String,String> getInfoMap()

Returns the configured info map (test/inspection helper).

Returns:

The info map.