Package net.osslabz.lnd.dto

Class LnrpcMiddlewareRegistration

java.lang.Object
net.osslabz.lnd.dto.LnrpcMiddlewareRegistration
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-06-07T12:03:34.958542131Z[Etc/UTC]") public class LnrpcMiddlewareRegistration extends Object
LnrpcMiddlewareRegistration

  • Field Details

  • Constructor Details

    • LnrpcMiddlewareRegistration

      public LnrpcMiddlewareRegistration()

  • Method Details

    • middlewareName

      public LnrpcMiddlewareRegistration middlewareName(String middlewareName)

    • getMiddlewareName

      @Nullable public String getMiddlewareName()
      The name of the middleware to register. The name should be as informative as possible and is logged on registration.
      Returns:
      middlewareName

    • setMiddlewareName

      public void setMiddlewareName(String middlewareName)

    • customMacaroonCaveatName

      public LnrpcMiddlewareRegistration customMacaroonCaveatName(String customMacaroonCaveatName)

    • getCustomMacaroonCaveatName

      @Nullable public String getCustomMacaroonCaveatName()
      The name of the custom macaroon caveat that this middleware is responsible for. Only requests/responses that contain a macaroon with the registered custom caveat are forwarded for interception to the middleware. The exception being the read-only mode: All requests/responses are forwarded to a middleware that requests read-only access but such a middleware won't be allowed to _alter_ responses. As a security measure, _no_ middleware can change responses to requests made with _unencumbered_ macaroons! NOTE: Cannot be used at the same time as read_only_mode.
      Returns:
      customMacaroonCaveatName

    • setCustomMacaroonCaveatName

      public void setCustomMacaroonCaveatName(String customMacaroonCaveatName)

    • readOnlyMode

      public LnrpcMiddlewareRegistration readOnlyMode(Boolean readOnlyMode)

    • getReadOnlyMode

      @Nullable public Boolean getReadOnlyMode()
      Instead of defining a custom macaroon caveat name a middleware can register itself for read-only access only. In that mode all requests/responses are forwarded to the middleware but the middleware isn't allowed to alter any of the responses. NOTE: Cannot be used at the same time as custom_macaroon_caveat_name.
      Returns:
      readOnlyMode

    • setReadOnlyMode

      public void setReadOnlyMode(Boolean readOnlyMode)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object