Record Class PkiServerConfiguration

java.lang.Object

java.lang.Record

zeroecho.pki.server.PkiServerConfiguration

Record Components:

version - server schema version

serverName - safe bounded operational name

realm - exact realm configuration

listener - HTTPS listener policy

authentication - strict client-certificate mappings

execution - bounded execution and shutdown policy

runtime - process-local capability references

publicListener - optional separately bounded public repository listener

acmeListener - optional separately bounded ACME protocol listener

estListener - optional separately bounded EST protocol listener

scepListener - optional separately bounded SCEP protocol listener

cmpListener - optional separately bounded CMP protocol listener

auditProjection - bounded audit-projection scheduling policy

public record PkiServerConfiguration(int version, String serverName, ServerRealmConfiguration realm, PkiServerConfiguration.Listener listener, PkiServerConfiguration.Authentication authentication, PkiServerConfiguration.Execution execution, PkiServerConfiguration.RuntimeCapabilities runtime, Optional<PkiServerConfiguration.PublicListener> publicListener, Optional<PkiServerConfiguration.AcmeListener> acmeListener, Optional<PkiServerConfiguration.EstListener> estListener, Optional<PkiServerConfiguration.ScepListener> scepListener, Optional<PkiServerConfiguration.CmpListener> cmpListener, PkiServerConfiguration.AuditProjection auditProjection)
extends Record

Strict immutable configuration for one administrative HTTPS server instance.

The record owns no secret values. Provider properties may contain paths and names of external environment-variable references and therefore must never be rendered or logged. One instance belongs to exactly one realm and creates one long-lived ServerRealmContext.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PkiServerConfiguration.AcmeListener	Separately bounded ACME listener and protocol-security configuration.
static enum	PkiServerConfiguration.AcmeTransportMode	Closed ACME listener transport topologies.
static final record	PkiServerConfiguration.AuditProjection	Bounded audit-projection policy, independently applied to revocation and each evidence family.
static final record	PkiServerConfiguration.Authentication	Strict mode-separated administrative client-certificate authentication.
static final record	PkiServerConfiguration.ClientCertificateMapping	One exact client-certificate mapping.
static final record	PkiServerConfiguration.CmpListener	Configuration for the optional CMP RFC 4210/9480 HTTPS listener.
static final record	PkiServerConfiguration.EstListener	Separately bounded EST protocol listener configuration.
static final record	PkiServerConfiguration.Execution	Bounded worker, queue, admission, deadline and shutdown policy.
static final record	PkiServerConfiguration.Listener	HTTPS listener configuration.
static final record	PkiServerConfiguration.PublicListener	Separately bounded public repository listener configuration.
static final record	PkiServerConfiguration.RuntimeCapabilities	Process-local capability references.
static final record	PkiServerConfiguration.ScepListener	Configuration for the optional SCEP RFC 8894 HTTPS listener.
static final record	PkiServerConfiguration.SigningReconciliation	Bounds for one signing-reconciliation pass executed by SigningReconciliationWorker.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CURRENT_VERSION	Current server configuration schema.

Constructor Summary

Constructors

Constructor	Description
PkiServerConfiguration(int version, String serverName, ServerRealmConfiguration realm, PkiServerConfiguration.Listener listener, PkiServerConfiguration.Authentication authentication, PkiServerConfiguration.Execution execution, PkiServerConfiguration.RuntimeCapabilities runtime)	Creates a configuration with the public repository and ACME listeners disabled.
PkiServerConfiguration(int version, String serverName, ServerRealmConfiguration realm, PkiServerConfiguration.Listener listener, PkiServerConfiguration.Authentication authentication, PkiServerConfiguration.Execution execution, PkiServerConfiguration.RuntimeCapabilities runtime, Optional<PkiServerConfiguration.PublicListener> publicListener)	Creates a configuration with ACME disabled.
PkiServerConfiguration(int version, String serverName, ServerRealmConfiguration realm, PkiServerConfiguration.Listener listener, PkiServerConfiguration.Authentication authentication, PkiServerConfiguration.Execution execution, PkiServerConfiguration.RuntimeCapabilities runtime, Optional<PkiServerConfiguration.PublicListener> publicListener, Optional<PkiServerConfiguration.AcmeListener> acmeListener)	Creates a configuration with default audit projection.
PkiServerConfiguration(int version, String serverName, ServerRealmConfiguration realm, PkiServerConfiguration.Listener listener, PkiServerConfiguration.Authentication authentication, PkiServerConfiguration.Execution execution, PkiServerConfiguration.RuntimeCapabilities runtime, Optional<PkiServerConfiguration.PublicListener> publicListener, Optional<PkiServerConfiguration.AcmeListener> acmeListener, Optional<PkiServerConfiguration.EstListener> estListener, Optional<PkiServerConfiguration.ScepListener> scepListener, Optional<PkiServerConfiguration.CmpListener> cmpListener, PkiServerConfiguration.AuditProjection auditProjection)	Validates all security-sensitive fields before resource allocation.

Method Summary

Modifier and Type	Method	Description
Optional<PkiServerConfiguration.AcmeListener>	acmeListener()	Returns the value of the acmeListener record component.
PkiServerConfiguration.AuditProjection	auditProjection()	Returns the value of the auditProjection record component.
PkiServerConfiguration.Authentication	authentication()	Returns the value of the authentication record component.
Optional<PkiServerConfiguration.CmpListener>	cmpListener()	Returns the value of the cmpListener record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Optional<PkiServerConfiguration.EstListener>	estListener()	Returns the value of the estListener record component.
PkiServerConfiguration.Execution	execution()	Returns the value of the execution record component.
final int	hashCode()	Returns a hash code value for this object.
PkiServerConfiguration.Listener	listener()	Returns the value of the listener record component.
Optional<PkiServerConfiguration.PublicListener>	publicListener()	Returns the value of the publicListener record component.
ServerRealmConfiguration	realm()	Returns the value of the realm record component.
PkiServerConfiguration.RuntimeCapabilities	runtime()	Returns the value of the runtime record component.
Optional<PkiServerConfiguration.ScepListener>	scepListener()	Returns the value of the scepListener record component.
String	serverName()	Returns the value of the serverName record component.
final String	toString()	Returns a string representation of this record class.
int	version()	Returns the value of the version record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CURRENT_VERSION

public static final int CURRENT_VERSION

Current server configuration schema.

See Also:

• Constant Field Values

Constructor Details

PkiServerConfiguration

public PkiServerConfiguration(int version,
 String serverName,
 ServerRealmConfiguration realm,
 PkiServerConfiguration.Listener listener,
 PkiServerConfiguration.Authentication authentication,
 PkiServerConfiguration.Execution execution,
 PkiServerConfiguration.RuntimeCapabilities runtime,
 Optional<PkiServerConfiguration.PublicListener> publicListener,
 Optional<PkiServerConfiguration.AcmeListener> acmeListener,
 Optional<PkiServerConfiguration.EstListener> estListener,
 Optional<PkiServerConfiguration.ScepListener> scepListener,
 Optional<PkiServerConfiguration.CmpListener> cmpListener,
 PkiServerConfiguration.AuditProjection auditProjection)

Validates all security-sensitive fields before resource allocation.

PkiServerConfiguration

public PkiServerConfiguration(int version,
 String serverName,
 ServerRealmConfiguration realm,
 PkiServerConfiguration.Listener listener,
 PkiServerConfiguration.Authentication authentication,
 PkiServerConfiguration.Execution execution,
 PkiServerConfiguration.RuntimeCapabilities runtime,
 Optional<PkiServerConfiguration.PublicListener> publicListener)

Creates a configuration with ACME disabled.

Parameters:

version - configuration schema version

serverName - nonblank server name

realm - realm configuration

listener - administrative HTTPS listener

authentication - administrative authentication policy

execution - bounded request-execution policy

runtime - explicit process-local runtime capabilities

publicListener - optional public repository listener

PkiServerConfiguration

public PkiServerConfiguration(int version,
 String serverName,
 ServerRealmConfiguration realm,
 PkiServerConfiguration.Listener listener,
 PkiServerConfiguration.Authentication authentication,
 PkiServerConfiguration.Execution execution,
 PkiServerConfiguration.RuntimeCapabilities runtime,
 Optional<PkiServerConfiguration.PublicListener> publicListener,
 Optional<PkiServerConfiguration.AcmeListener> acmeListener)

Creates a configuration with default audit projection.

Parameters:

version - configuration schema version

serverName - nonblank server name

realm - realm configuration

listener - administrative HTTPS listener

authentication - administrative authentication policy

execution - bounded request-execution policy

runtime - explicit process-local runtime capabilities

publicListener - optional public repository listener

acmeListener - optional ACME protocol listener

PkiServerConfiguration

public PkiServerConfiguration(int version,
 String serverName,
 ServerRealmConfiguration realm,
 PkiServerConfiguration.Listener listener,
 PkiServerConfiguration.Authentication authentication,
 PkiServerConfiguration.Execution execution,
 PkiServerConfiguration.RuntimeCapabilities runtime)

Creates a configuration with the public repository and ACME listeners disabled.

Parameters:

version - configuration schema version

serverName - nonblank server name

realm - realm configuration

listener - administrative HTTPS listener

authentication - administrative authentication policy

execution - bounded request-execution policy

runtime - explicit process-local runtime capabilities

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

version

public int version()

Returns the value of the version record component.

Returns:

the value of the version record component

serverName

public String serverName()

Returns the value of the serverName record component.

Returns:

the value of the serverName record component

realm

public ServerRealmConfiguration realm()

Returns the value of the realm record component.

Returns:

the value of the realm record component

listener

public PkiServerConfiguration.Listener listener()

Returns the value of the listener record component.

Returns:

the value of the listener record component

authentication

public PkiServerConfiguration.Authentication authentication()

Returns the value of the authentication record component.

Returns:

the value of the authentication record component

execution

public PkiServerConfiguration.Execution execution()

Returns the value of the execution record component.

Returns:

the value of the execution record component

runtime

public PkiServerConfiguration.RuntimeCapabilities runtime()

Returns the value of the runtime record component.

Returns:

the value of the runtime record component

publicListener

public Optional<PkiServerConfiguration.PublicListener> publicListener()

Returns the value of the publicListener record component.

Returns:

the value of the publicListener record component

acmeListener

public Optional<PkiServerConfiguration.AcmeListener> acmeListener()

Returns the value of the acmeListener record component.

Returns:

the value of the acmeListener record component

estListener

public Optional<PkiServerConfiguration.EstListener> estListener()

Returns the value of the estListener record component.

Returns:

the value of the estListener record component

scepListener

public Optional<PkiServerConfiguration.ScepListener> scepListener()

Returns the value of the scepListener record component.

Returns:

the value of the scepListener record component

cmpListener

public Optional<PkiServerConfiguration.CmpListener> cmpListener()

Returns the value of the cmpListener record component.

Returns:

the value of the cmpListener record component

auditProjection

public PkiServerConfiguration.AuditProjection auditProjection()

Returns the value of the auditProjection record component.

Returns:

the value of the auditProjection record component