Record Class ServerControlOperation.BackupArtifactCommand

java.lang.Object

java.lang.Record

zeroecho.pki.server.ServerControlOperation.BackupArtifactCommand

Record Components:

action - requested workflow phase

artifactHandle - opaque owner-bound handle, never a filesystem path

commitment - server-resolved metadata commitment; empty on the wire

All Implemented Interfaces:

ServerControlOperation

Enclosing interface:

ServerControlOperation

public static record ServerControlOperation.BackupArtifactCommand(ServerControlOperation.BackupArtifactCommand.Action action, String artifactHandle, Optional<String> commitment)
extends Record
implements ServerControlOperation

Requests an action on an owned opaque archive or restore workflow. The gateway replaces any supplied commitment with current authoritative metadata before authorization and approval canonicalization.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ServerControlOperation.BackupArtifactCommand.Action	Closed workflow actions and their stable operation identities.

Nested classes/interfaces inherited from interface ServerControlOperation

ServerControlOperation.AcmeDirectoryProfilePrecondition, ServerControlOperation.ActivateBreakGlass, ServerControlOperation.ActivateEnrollmentProfile, ServerControlOperation.BackupArtifactCommand, ServerControlOperation.CancelApproval, ServerControlOperation.ConfigurationChoices, ServerControlOperation.CreateBreakGlass, ServerControlOperation.CreateGrant, ServerControlOperation.CreateRoleAssignment, ServerControlOperation.DeactivateAcmeAccount, ServerControlOperation.DecideApproval, ServerControlOperation.DecideEnrollmentRequest, ServerControlOperation.DeregisterCmpEndpoint, ServerControlOperation.DeregisterEstEndpoint, ServerControlOperation.DeregisterScepEndpoint, ServerControlOperation.EnrollCredentialPublication, ServerControlOperation.EvaluateAuthorization, ServerControlOperation.ExecuteRestore, ServerControlOperation.ExportBackup, ServerControlOperation.ExportBackupStream, ServerControlOperation.InspectAcmeAccount, ServerControlOperation.InspectAcmeDirectory, ServerControlOperation.InspectApproval, ServerControlOperation.InspectAuditView, ServerControlOperation.InspectBreakGlass, ServerControlOperation.InspectCmpEndpoint, ServerControlOperation.InspectDisclosure, ServerControlOperation.InspectEnrollmentProfile, ServerControlOperation.InspectEnrollmentRequest, ServerControlOperation.InspectEstEndpoint, ServerControlOperation.InspectGrant, ServerControlOperation.InspectOcspResponder, ServerControlOperation.InspectPrincipal, ServerControlOperation.InspectRepositoryAlias, ServerControlOperation.InspectRoleAssignment, ServerControlOperation.InspectRoleTemplate, ServerControlOperation.InspectScepEndpoint, ServerControlOperation.IssueCapability, ServerControlOperation.ListAcmeAccounts, ServerControlOperation.ListAcmeDirectories, ServerControlOperation.ListApprovals, ServerControlOperation.ListBreakGlass, ServerControlOperation.ListCapabilities, ServerControlOperation.ListCmpEndpoints, ServerControlOperation.ListEnrollmentProfiles, ServerControlOperation.ListEnrollmentRequests, ServerControlOperation.ListEstEndpoints, ServerControlOperation.ListGrants, ServerControlOperation.ListOcspResponders, ServerControlOperation.ListPrincipals, ServerControlOperation.ListRepositoryAliases, ServerControlOperation.ListRoleAssignments, ServerControlOperation.ListRoleTemplates, ServerControlOperation.ListScepEndpoints, ServerControlOperation.RegisterAcmeDirectory, ServerControlOperation.RegisterCmpEndpoint, ServerControlOperation.RegisterEnrollmentProfile, ServerControlOperation.RegisterEstEndpoint, ServerControlOperation.RegisterOcspResponder, ServerControlOperation.RegisterPrincipal, ServerControlOperation.RegisterScepEndpoint, ServerControlOperation.RemoveRepositoryAlias, ServerControlOperation.RequestApproval, ServerControlOperation.ReserveBackupUpload, ServerControlOperation.RevokeBreakGlass, ServerControlOperation.RevokeCapability, ServerControlOperation.RevokeGrant, ServerControlOperation.RevokeRoleAssignment, ServerControlOperation.SearchAudit, ServerControlOperation.SetAcmeDirectoryActive, ServerControlOperation.SetDisclosure, ServerControlOperation.SetOcspResponderActive, ServerControlOperation.SetPrincipalEnabled, ServerControlOperation.SetRepositoryAlias, ServerControlOperation.SuspendEnrollmentProfile, ServerControlOperation.UpdateEnrollmentProfile, ServerControlOperation.VerifyAuditIntegrity, ServerControlOperation.VerifyBackup

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACKNOWLEDGE	Acknowledge restore outcome operation identity.
static final String	DOWNLOAD	Download backup archive operation identity.
static final String	RESTORE	Stage backup restoration operation identity.
static final String	STATUS	Inspect restore workflow operation identity.
static final String	UPLOAD	Upload backup archive operation identity.
static final String	VERIFY	Verify uploaded archive operation identity.

Constructor Summary

Constructors

Constructor	Description
BackupArtifactCommand(ServerControlOperation.BackupArtifactCommand.Action action, String artifactHandle, Optional<String> commitment)	Validates shape; ownership and phase are checked by the server.

Method Summary

Modifier and Type	Method	Description
ServerControlOperation.BackupArtifactCommand.Action	action()	Returns the value of the action record component.
String	artifactHandle()	Returns the value of the artifactHandle record component.
Optional<String>	commitment()	Returns the value of the commitment record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the stable operation identity used for authorization and dispatch.
String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

UPLOAD

public static final String UPLOAD

Upload backup archive operation identity.

See Also:

• Constant Field Values

DOWNLOAD

public static final String DOWNLOAD

Download backup archive operation identity.

See Also:

• Constant Field Values

VERIFY

public static final String VERIFY

Verify uploaded archive operation identity.

See Also:

• Constant Field Values

RESTORE

public static final String RESTORE

Stage backup restoration operation identity.

See Also:

• Constant Field Values

STATUS

public static final String STATUS

Inspect restore workflow operation identity.

See Also:

• Constant Field Values

ACKNOWLEDGE

public static final String ACKNOWLEDGE

Acknowledge restore outcome operation identity.

See Also:

• Constant Field Values

Constructor Details

BackupArtifactCommand

public BackupArtifactCommand(ServerControlOperation.BackupArtifactCommand.Action action,
 String artifactHandle,
 Optional<String> commitment)

Validates shape; ownership and phase are checked by the server.

Method Details

name

public String name()

Description copied from interface: ServerControlOperation

Returns the stable operation identity used for authorization and dispatch.

Specified by:

name in interface ServerControlOperation

Returns:

stable operation identity

toString

public 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. All components in this record class are compared with Objects::equals(Object,Object).

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.

action

public ServerControlOperation.BackupArtifactCommand.Action action()

Returns the value of the action record component.

Returns:

the value of the action record component

artifactHandle

public String artifactHandle()

Returns the value of the artifactHandle record component.

Returns:

the value of the artifactHandle record component

commitment

public Optional<String> commitment()

Returns the value of the commitment record component.

Returns:

the value of the commitment record component