Package me.ahoo.cosid.spring.autoconfigure

Class CosIdSpecs

java.lang.Object

me.ahoo.cosid.spring.autoconfigure.CosIdSpecs

public final class CosIdSpecs
extends Object

CosIdProperties to RuntimeSpec (07-runtime-and-spring.md §4.1): toSpec(me.ahoo.cosid.spring.autoconfigure.CosIdProperties, java.time.ZoneId) is a pure function, no Spring involved; bind(java.lang.Iterable<org.springframework.boot.context.properties.source.ConfigurationPropertySource>, org.springframework.boot.context.properties.bind.PlaceholdersResolver) binds cosid.* strictly. It checks what the properties alone can tell (a missing strategy, a codec item naming two codecs, ...) and reports every problem at once by property path; CosIdRuntime.start validates the spec as a whole.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COSID80
static final String	CUSTOM	The strategy of a user generator (GeneratorSpec.Custom or Instance) in describe().
static final String	PERIODIC_SEGMENT
static final String	SEGMENT
static final String	SNOWFLAKE
static final String	UUIDV7	UUIDv7 ids (D46): no machine, store nor codec.

Method Summary

Modifier and Type	Method	Description
static CosIdProperties	bind(Iterable<org.springframework.boot.context.properties.source.ConfigurationPropertySource> sources, org.springframework.boot.context.properties.bind.PlaceholdersResolver placeholders)	Binds cosid.*; a key that binds to nothing fails (R1-spring-03): a typo would otherwise fall back to the default silently.
static Optional<String>	namespace(String configured, String applicationName)	The namespace of the runtime (D38): cosid.namespace, else spring.application.name, else "cosid".
static me.ahoo.cosid.runtime.RuntimeSpec	toSpec(CosIdProperties properties, String namespace, ZoneId zone)	Maps the properties to a spec.
static me.ahoo.cosid.runtime.RuntimeSpec	toSpec(CosIdProperties properties, ZoneId zone)	Maps the properties to a spec, in cosid.namespace or "cosid".

Methods inherited from class java.lang.Object

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

Field Details

SNOWFLAKE

public static final String SNOWFLAKE

See Also:

• Constant Field Values

COSID80

public static final String COSID80

See Also:

• Constant Field Values

SEGMENT

public static final String SEGMENT

See Also:

• Constant Field Values

PERIODIC_SEGMENT

public static final String PERIODIC_SEGMENT

See Also:

• Constant Field Values

CUSTOM

public static final String CUSTOM

The strategy of a user generator (GeneratorSpec.Custom or Instance) in describe().

See Also:

• Constant Field Values

UUIDV7

public static final String UUIDV7

UUIDv7 ids (D46): no machine, store nor codec.

See Also:

• Constant Field Values

Method Details

bind

public static CosIdProperties bind(Iterable<org.springframework.boot.context.properties.source.ConfigurationPropertySource> sources,
 org.springframework.boot.context.properties.bind.PlaceholdersResolver placeholders)

Binds cosid.*; a key that binds to nothing fails (R1-spring-03): a typo would otherwise fall back to the default silently. cosid.stores.*.options, the keys of the integrations and the server, and system properties and environment variables are not checked here.

Parameters:

sources - the property sources, such as ConfigurationPropertySources.get(environment)

placeholders - resolves ${...} in the values

Returns:

the properties

Throws:

org.springframework.boot.context.properties.bind.BindException - with the unbound keys

namespace

public static Optional<String> namespace(String configured,
 String applicationName)

The namespace of the runtime (D38): cosid.namespace, else spring.application.name, else "cosid".

Parameters:

configured - cosid.namespace, or null

applicationName - spring.application.name, or null

Returns:

the namespace; empty when both are unset, for "cosid"

Throws:

me.ahoo.cosid.CosIdException - if the application name is no valid namespace

toSpec

public static me.ahoo.cosid.runtime.RuntimeSpec toSpec(CosIdProperties properties,
 ZoneId zone)

Maps the properties to a spec, in cosid.namespace or "cosid".

Parameters:

properties - the bound properties

zone - the zone of the zone-dependent settings left empty (the system zone in an application)

Returns:

the spec

Throws:

me.ahoo.cosid.CosIdException - listing every problem by property path

toSpec

public static me.ahoo.cosid.runtime.RuntimeSpec toSpec(CosIdProperties properties,
 String namespace,
 ZoneId zone)

Maps the properties to a spec.

Parameters:

properties - the bound properties

namespace - the namespace of the runtime, resolved by namespace(String, String)

zone - the zone of the zone-dependent settings left empty (the system zone in an application)

Returns:

the spec

Throws:

me.ahoo.cosid.CosIdException - listing every problem by property path