Interface ManagementRequest


@Deprecated public interface ManagementRequest
Deprecated.
since 2.13.0: ManagementRequest.
A management call as a module sees it. It has already passed ApiKey.isAuthorized; a module never sees an unauthenticated call and never re-implements the gate.
  • Method Summary

    Modifier and Type
    Method
    Description
    Deprecated.
     
    Deprecated.
    The request body, unread.
    boolean
    Deprecated.
    ApiKey.isAuthorizedToWrite: stricter than the read gate - it refuses on a node with no API key configured.
    boolean
    Deprecated.
    Whether the management call arrived over TLS, as the container reports it.
    int
    Deprecated.
    The local port the management call arrived on.
    openRawOutput(String contentType, String fileName)
    Deprecated.
    Answers with a raw body instead of JSON; the action must then return null.
    Deprecated.
    A query-string or form parameter; null when absent.
  • Method Details

    • action

      String action()
      Deprecated.
    • parameter

      String parameter(String name)
      Deprecated.
      A query-string or form parameter; null when absent.
    • body

      InputStream body() throws IOException
      Deprecated.
      The request body, unread. getParameter on a non-form POST reads the query string only, which is what leaves the body here to be streamed.
      Throws:
      IOException
    • isSecure

      boolean isSecure()
      Deprecated.
      Whether the management call arrived over TLS, as the container reports it.
    • localPort

      int localPort()
      Deprecated.
      The local port the management call arrived on.
    • isAuthorizedToWrite

      boolean isAuthorizedToWrite()
      Deprecated.
      ApiKey.isAuthorizedToWrite: stricter than the read gate - it refuses on a node with no API key configured. A module's state-changing action must check it.
    • openRawOutput

      OutputStream openRawOutput(String contentType, String fileName) throws IOException
      Deprecated.
      Answers with a raw body instead of JSON; the action must then return null.
      Parameters:
      fileName - sent as an attachment's name when not null - the caller must have validated it
      Throws:
      IOException