Enum Class NuggetAdminOperationKind

java.lang.Object
java.lang.Enum<NuggetAdminOperationKind>
org.j7m.middleware.operations.api.NuggetAdminOperationKind
All Implemented Interfaces:
Serializable, Comparable<NuggetAdminOperationKind>, Constable
public enum NuggetAdminOperationKind extends Enum<NuggetAdminOperationKind>
Stable public operation families for the nugget administration contract.

The values identify typed operation families only. They are not method names, CLI command strings, JSON dispatch keys, reflection targets, or a universal router. Implementations must continue to use the existing typed public families such as NuggetIntrospection, NuggetApplicationLifecycle, NuggetControl, and NuggetDiscovery for operation semantics.

Each operation kind owns the finite binding between the operation family and the exact public request and result payload DTO classes that may appear in NuggetAdminCommandRequest and NuggetAdminCommandResult. The binding is intentionally closed: maps, strings, arrays, collections, implementation classes, CLI-private models, generic JSON nodes, request/result role swaps, and wrong-family DTOs are invalid before provider dispatch. Payload type strings are stable public schema tokens; callers may omit them and let the envelope infer the token from the exact DTO class.

The enum and its binding metadata are immutable and thread-safe.

  • Enum Constant Details

    • CAPABILITIES

      public static final NuggetAdminOperationKind CAPABILITIES
      Capability discovery for this public contract.

    • DISCOVERY

      public static final NuggetAdminOperationKind DISCOVERY
      Nugget discovery and target resolution.

    • AUTHENTICATION

      public static final NuggetAdminOperationKind AUTHENTICATION
      PIN admission metadata and safe admission outcome.

    • INTROSPECTION

      public static final NuggetAdminOperationKind INTROSPECTION
      Read-only nugget/runtime/object/application/environment inspection.

    • APPLICATION_LIFECYCLE

      public static final NuggetAdminOperationKind APPLICATION_LIFECYCLE
      Application lifecycle operation through the typed lifecycle family.

    • NUGGET_CONTROL

      public static final NuggetAdminOperationKind NUGGET_CONTROL
      Nugget drain, shutdown, or kill-disabled control operation.

  • Method Details

    • values

      public static NuggetAdminOperationKind[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static NuggetAdminOperationKind valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • requestPayloadMayBeNull

      public boolean requestPayloadMayBeNull()
      Returns whether a command request envelope may omit its typed payload for this operation kind.
      Returns:
      true when request payload null is a valid operation-family request

    • resultPayloadMayBeNullForUnavailable

      public boolean resultPayloadMayBeNullForUnavailable()
      Returns whether a command result envelope may omit its typed payload when the common result outcome is NuggetAdminOutcome.UNAVAILABLE.
      Returns:
      true when older-provider unavailable results may carry a null payload

    • readOnly

      public boolean readOnly()
      Returns whether this operation family is read-only after admission and authorization. Authentication is not read-only because it may update admission throttles and short-lived admission sessions.
      Returns:
      read-only operation-family flag

    • queryPermitted

      public boolean queryPermitted()
      Returns whether query DTOs are part of this operation family's public request surface.
      Returns:
      query-permitted flag

    • confirmationPermitted

      public boolean confirmationPermitted()
      Returns whether this operation family may carry confirmation semantics in its typed DTOs. Confirmation challenges are sensitive and currently apply only to nugget control.
      Returns:
      confirmation-permitted flag

    • acceptedMutationOperationIdentityRequired

      public boolean acceptedMutationOperationIdentityRequired()
      Returns whether accepted or in-progress mutation results must carry a stable operation id in the common header when that operation family represents mutation identity.
      Returns:
      accepted-mutation operation identity flag

    • requestPayloads

      public List<NuggetAdminOperationKind.PayloadBinding> requestPayloads()
      Returns the exact public DTO classes accepted as request payloads for this operation kind.
      Returns:
      immutable request payload binding list

    • resultPayloads

      public List<NuggetAdminOperationKind.PayloadBinding> resultPayloads()
      Returns the exact public DTO classes accepted as result payloads for this operation kind.
      Returns:
      immutable result payload binding list

    • validateRequestPayload

      public String validateRequestPayload(Object payload, String payloadType)
      Validates and normalizes a command request payload type for this operation family.
      Parameters:
      payload - request payload, or null
      payloadType - caller-supplied payload type token, or empty
      Returns:
      canonical payload type token, or empty when the request has no payload
      Throws:
      IllegalArgumentException - if the payload, null policy, or payload-type token is invalid

    • validateResultPayload

      public String validateResultPayload(NuggetAdminResultHeader header, Object payload, String payloadType)
      Validates and normalizes a command result payload type for this operation family.
      Parameters:
      header - common result header
      payload - result payload, or null
      payloadType - caller-supplied payload type token, or empty
      Returns:
      canonical payload type token, or empty when the result has no payload
      Throws:
      IllegalArgumentException - if the header, payload, null policy, payload-type token, outcome flags, or mutation identity is invalid