Packages

final case class MiddlewareRegistration(middlewareName: String = "", customMacaroonCaveatName: String = "", readOnlyMode: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MiddlewareRegistration] with Product with Serializable

middlewareName

The name of the middleware to register. The name should be as informative as possible and is logged on registration.

customMacaroonCaveatName

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.

readOnlyMode

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.

Annotations
@SerialVersionUID()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MiddlewareRegistration
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MiddlewareRegistration(middlewareName: String = "", customMacaroonCaveatName: String = "", readOnlyMode: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    middlewareName

    The name of the middleware to register. The name should be as informative as possible and is logged on registration.

    customMacaroonCaveatName

    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.

    readOnlyMode

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def companion: MiddlewareRegistration.type
    Definition Classes
    MiddlewareRegistration → GeneratedMessage
  7. val customMacaroonCaveatName: String
  8. def discardUnknownFields: MiddlewareRegistration
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    MiddlewareRegistration → GeneratedMessage
  13. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    MiddlewareRegistration → GeneratedMessage
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val middlewareName: String
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val readOnlyMode: Boolean
  21. def serializedSize: Int
    Definition Classes
    MiddlewareRegistration → GeneratedMessage
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  24. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  25. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  26. def toProtoString: String
    Definition Classes
    MiddlewareRegistration → GeneratedMessage
  27. val unknownFields: UnknownFieldSet
  28. def update(ms: (Lens[MiddlewareRegistration, MiddlewareRegistration]) => Mutation[MiddlewareRegistration]*): MiddlewareRegistration
    Definition Classes
    Updatable
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. def withCustomMacaroonCaveatName(__v: String): MiddlewareRegistration
  33. def withMiddlewareName(__v: String): MiddlewareRegistration
  34. def withReadOnlyMode(__v: Boolean): MiddlewareRegistration
  35. def withUnknownFields(__v: UnknownFieldSet): MiddlewareRegistration
  36. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  37. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    MiddlewareRegistration → GeneratedMessage
  38. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped