Interface NuggetCliConnection

All Superinterfaces:
AutoCloseable
public interface NuggetCliConnection extends AutoCloseable
Transport-neutral connection from the J7M CLI to one selected nugget.

The connection is owned by the CLI session that created it and must be closed by that session. Implementations must report trusted connection security through security() before any PIN is submitted. Discovery endpoint syntax, source classification, or object-reference possession is not sufficient to make credential submission safe.

  • Method Summary

    Modifier and Type
    Method
    Description
    default org.j7m.middleware.operations.api.NuggetAdminCommandResult<org.j7m.middleware.operations.api.NuggetAdminCapabilities>
    adminCapabilities(org.j7m.middleware.operations.api.NuggetAdminRequestContext context)
    Returns public Phase 7.8 contract capabilities for this connection.
    default org.j7m.middleware.operations.api.NuggetAdminCommandResult<?>
    adminCommand(org.j7m.middleware.operations.api.NuggetAdminCommandRequest<?> request)
    Evaluates an optional shared command envelope around existing typed public operation families.
    default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.ApplicationDetail>
    application(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, String applicationInstanceId)
    Reads safe application detail after successful admission and server authorization.
    default org.j7m.middleware.operations.api.NuggetApplicationLifecycle.Result
    applicationLifecycle(org.j7m.middleware.operations.api.NuggetApplicationLifecycle.Request request)
    Executes or plans an application lifecycle operation after successful admission and server authorization.
    default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.CollectionResult<org.j7m.middleware.operations.api.NuggetIntrospection.ApplicationSummary>>
    applications(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, org.j7m.middleware.operations.api.NuggetIntrospection.Query query)
    Reads safe application summaries after successful admission and server authorization.
    org.j7m.middleware.operations.api.NuggetAuthenticationResult
    authenticate(org.j7m.middleware.operations.api.NuggetAuthenticationRequest request, char[] pin)
    Performs PIN admission using shortest-scope mutable credential material.
    void
    close()
    Closes resources owned by the connection.
    default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.CollectionResult<org.j7m.middleware.operations.api.NuggetIntrospection.DiskVolumeSummary>>
    disk(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, org.j7m.middleware.operations.api.NuggetIntrospection.DiskQuery query)
    Reads safe disk and configured storage-root summaries after successful admission and server authorization.
    default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.EnvironmentSummary>
    environment(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
    Reads safe JVM, process, and environment-name information after successful admission and server authorization.
    default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.HealthSummary>
    health(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
    Reads the health summary after successful admission and server authorization.
    default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.MetricsSummary>
    metrics(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
    Reads bounded safe metrics after successful admission and server authorization.
    default org.j7m.middleware.operations.api.NuggetControl.Result
    nuggetControl(org.j7m.middleware.operations.api.NuggetControl.Request request)
    Executes or plans a nugget-level drain, shutdown, or self-termination operation after successful admission and server authorization.
    default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.ObjectDetail>
    object(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, String objectId)
    Reads safe object detail after successful admission and server authorization.
    default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.CollectionResult<org.j7m.middleware.operations.api.NuggetIntrospection.ObjectSummary>>
    objects(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, org.j7m.middleware.operations.api.NuggetIntrospection.Query query)
    Reads safe object summaries after successful admission and server authorization.
    org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.Overview>
    overview(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
    Reads compact overview after successful admission and server authorization.
    default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.ReadinessSummary>
    readiness(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
    Reads the readiness summary after successful admission and server authorization.
    default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.CollectionResult<org.j7m.middleware.operations.api.NuggetIntrospection.RecentErrorEntry>>
    recentErrors(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, org.j7m.middleware.operations.api.NuggetIntrospection.RecentErrorQuery query)
    Reads bounded recent safe errors after successful admission and server authorization.
    default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.RuntimeSummary>
    runtime(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
    Reads the runtime summary after successful admission and server authorization.
    NuggetCliConnectionSecurity
    security()
    Returns the trusted security descriptor for this established connection.
    org.j7m.middleware.operations.api.NuggetStatus
    status(String admissionId)
    Reads compact status after successful admission and server authorization.

  • Method Details

    • security

      NuggetCliConnectionSecurity security()
      Returns the trusted security descriptor for this established connection.
      Returns:
      connection security descriptor

    • authenticate

      org.j7m.middleware.operations.api.NuggetAuthenticationResult authenticate(org.j7m.middleware.operations.api.NuggetAuthenticationRequest request, char[] pin)
      Performs PIN admission using shortest-scope mutable credential material.
      Parameters:
      request - authentication request metadata
      pin - mutable PIN characters; implementations must not retain the array
      Returns:
      authentication result

    • adminCapabilities

      default org.j7m.middleware.operations.api.NuggetAdminCommandResult<org.j7m.middleware.operations.api.NuggetAdminCapabilities> adminCapabilities(org.j7m.middleware.operations.api.NuggetAdminRequestContext context)
      Returns public Phase 7.8 contract capabilities for this connection.

      The default implementation is intentionally unavailable so older providers do not appear to support the public command contract. The result is not admission or authorization.

      Parameters:
      context - request context
      Returns:
      safe capability result

    • adminCommand

      default org.j7m.middleware.operations.api.NuggetAdminCommandResult<?> adminCommand(org.j7m.middleware.operations.api.NuggetAdminCommandRequest<?> request)
      Evaluates an optional shared command envelope around existing typed public operation families.

      The default implementation performs no operation work and returns truthful unavailable. CLI parsing remains owned by the CLI; this method is only a public envelope adapter for providers that explicitly implement it.

      Parameters:
      request - typed command envelope
      Returns:
      safe unavailable result

    • status

      org.j7m.middleware.operations.api.NuggetStatus status(String admissionId)
      Reads compact status after successful admission and server authorization.
      Parameters:
      admissionId - admission identifier
      Returns:
      status summary

    • overview

      org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.Overview> overview(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
      Reads compact overview after successful admission and server authorization.
      Parameters:
      request - introspection request
      Returns:
      overview result

    • environment

      default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.EnvironmentSummary> environment(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
      Reads safe JVM, process, and environment-name information after successful admission and server authorization.
      Parameters:
      request - introspection request
      Returns:
      environment result

    • disk

      default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.CollectionResult<org.j7m.middleware.operations.api.NuggetIntrospection.DiskVolumeSummary>> disk(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, org.j7m.middleware.operations.api.NuggetIntrospection.DiskQuery query)
      Reads safe disk and configured storage-root summaries after successful admission and server authorization.
      Parameters:
      request - introspection request
      query - disk query
      Returns:
      disk result

    • health

      default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.HealthSummary> health(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
      Reads the health summary after successful admission and server authorization.
      Parameters:
      request - introspection request
      Returns:
      health result

    • readiness

      default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.ReadinessSummary> readiness(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
      Reads the readiness summary after successful admission and server authorization.
      Parameters:
      request - introspection request
      Returns:
      readiness result

    • runtime

      default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.RuntimeSummary> runtime(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
      Reads the runtime summary after successful admission and server authorization.
      Parameters:
      request - introspection request
      Returns:
      runtime result

    • applications

      default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.CollectionResult<org.j7m.middleware.operations.api.NuggetIntrospection.ApplicationSummary>> applications(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, org.j7m.middleware.operations.api.NuggetIntrospection.Query query)
      Reads safe application summaries after successful admission and server authorization.
      Parameters:
      request - introspection request
      query - collection query
      Returns:
      application collection result

    • application

      default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.ApplicationDetail> application(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, String applicationInstanceId)
      Reads safe application detail after successful admission and server authorization.
      Parameters:
      request - introspection request
      applicationInstanceId - application instance identifier
      Returns:
      application detail result

    • objects

      default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.CollectionResult<org.j7m.middleware.operations.api.NuggetIntrospection.ObjectSummary>> objects(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, org.j7m.middleware.operations.api.NuggetIntrospection.Query query)
      Reads safe object summaries after successful admission and server authorization.
      Parameters:
      request - introspection request
      query - collection query
      Returns:
      object collection result

    • object

      default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.ObjectDetail> object(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, String objectId)
      Reads safe object detail after successful admission and server authorization.
      Parameters:
      request - introspection request
      objectId - object identifier
      Returns:
      object detail result

    • metrics

      default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.MetricsSummary> metrics(org.j7m.middleware.operations.api.NuggetIntrospection.Request request)
      Reads bounded safe metrics after successful admission and server authorization.
      Parameters:
      request - introspection request
      Returns:
      metrics result

    • recentErrors

      default org.j7m.middleware.operations.api.NuggetIntrospection.Result<org.j7m.middleware.operations.api.NuggetIntrospection.CollectionResult<org.j7m.middleware.operations.api.NuggetIntrospection.RecentErrorEntry>> recentErrors(org.j7m.middleware.operations.api.NuggetIntrospection.Request request, org.j7m.middleware.operations.api.NuggetIntrospection.RecentErrorQuery query)
      Reads bounded recent safe errors after successful admission and server authorization.
      Parameters:
      request - introspection request
      query - recent-error query
      Returns:
      recent-error result

    • applicationLifecycle

      default org.j7m.middleware.operations.api.NuggetApplicationLifecycle.Result applicationLifecycle(org.j7m.middleware.operations.api.NuggetApplicationLifecycle.Request request)
      Executes or plans an application lifecycle operation after successful admission and server authorization.

      The default implementation is intentionally unavailable so older connection providers cannot accidentally report successful mutation for a lifecycle operation they do not implement.

      Parameters:
      request - lifecycle request
      Returns:
      safe lifecycle result

    • nuggetControl

      default org.j7m.middleware.operations.api.NuggetControl.Result nuggetControl(org.j7m.middleware.operations.api.NuggetControl.Request request)
      Executes or plans a nugget-level drain, shutdown, or self-termination operation after successful admission and server authorization.

      The default implementation is intentionally unavailable so older connection providers cannot accidentally report successful nugget control for an operation they do not implement.

      Parameters:
      request - nugget-control request
      Returns:
      safe nugget-control result

    • close

      void close()
      Closes resources owned by the connection.
      Specified by:
      close in interface AutoCloseable