Packages

object Principal

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Principal
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed abstract class AuthenticateStatus extends AnyRef

    If unable to authenticate then it will be shown why as a subtype of this.

  2. final case class AuthenticationToken(username: String, token: ByteString, ttl: FiniteDuration) extends Product with Serializable

    Describes an authentication token.

    Describes an authentication token. Tokens have leases expressed as durations.

    username

    the username used to acquire the token

    token

    an opaque token

    ttl

    a duration declaring how long the token is valid for

  3. final case class AuthenticationTokenRetrieved(token: AuthenticationToken) extends SuccessResponse with Product with Serializable

    A successful authentication token reply.

    A successful authentication token reply. Do not cache as it is subject to invalidation

    token

    the token

  4. final case class AuthorizedSecret(value: String, ttl: FiniteDuration) extends Product with Serializable

    Describes a secret.

    Describes a secret.

    value

    The value representing a secret

    ttl

    a duration declaring how long the secret is valid for

  5. sealed abstract class FailureResponse extends Response

    Classifies failure responses for requests on a Principal

  6. type GetAuthenticationToken = () => Future[Either[FailureResponse, AuthenticationTokenRetrieved]]

    A function type to return authentication tokens

  7. type GetSecret = (Path) => Future[Either[FailureResponse, SecretRetrieved]]

    A function type to return secrets

  8. sealed abstract class GetSecretStatus extends AnyRef

    If a secret is unable to be returned then it will shown why as a subtype of this.

  9. type InvalidateSecret = (Path) => Future[Done]

    A function type to invalidate secrets

  10. type Path = String

    The path based address of the secret.

    The path based address of the secret. A path may contain a namespace which is denoted by a "/". For example, a path of "my.ns/my.secret" refers to a secret of "my.secret" in the "my.ns" namespace.

  11. type PutSecret = (Path, String) => Future[Either[FailureResponse, SecretStored.type]]

    A function type to store secrets

  12. sealed abstract class PutSecretStatus extends AnyRef

    If a secret is unable to be set then it will shown why as a subtype of this.

  13. type RemoveSecret = (Path) => Future[Either[FailureResponse, SecretRemoved.type]]

    A function type to remove secrets

  14. sealed abstract class RemoveSecretStatus extends AnyRef

    If a secret is unable to be removed then it will be shown why as a subtype of this.

  15. sealed abstract class Response extends AnyRef

    Denotes all response types for requests on a Principal

  16. final case class SecretRetrieved(secret: AuthorizedSecret) extends SuccessResponse with Product with Serializable

    A successful secret reply.

    A successful secret reply. Do not cache as it is subject to invalidation

    secret

    the secret

  17. sealed abstract class SuccessResponse extends Response

    For all successful responses on a Principal

  18. final case class Unauthorized(path: Path) extends FailureResponse with Product with Serializable

    The principal does not have the rights to perform the request

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. def apply(getAuthenticationToken: GetAuthenticationToken, getSecret: GetSecret, invalidateSecret: InvalidateSecret, putSecret: PutSecret, removeSecret: RemoveSecret): Principal

    Constructs a new Principal containing the provided functions

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toJava[A, B, C](func: (A, B) => Future[Either[FailureResponse, C]]): BiFunction[A, B, CompletionStage[Either[FailureResponse, C]]]

    Converts the supplied two-argument function to a BiFunction that integrates with Java APIs.

    Converts the supplied two-argument function to a BiFunction that integrates with Java APIs.

    Converts:

    • Principal#putSecret
  18. def toJava[A, B](func: (A) => Future[Either[FailureResponse, B]]): Function[A, CompletionStage[Either[FailureResponse, B]]]

    Converts the supplied one-argument function to a Function that integrates with Java APIs.

    Converts the supplied one-argument function to a Function that integrates with Java APIs.

    Converts:

    • Principal#getSecret
    • Principal#removeSecret
  19. def toJava[A](func: () => Future[Either[FailureResponse, A]]): Supplier[CompletionStage[Either[FailureResponse, A]]]

    Converts the supplied zero-argument function into a Supplier that integrates with Java APIs.

    Converts the supplied zero-argument function into a Supplier that integrates with Java APIs.

    Converts:

    • Principal#getAuthenticatedSecret
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. case object AuthenticationAttemptRejected extends AuthenticateStatus with Product with Serializable

    Unable to authenticate because attempt was rejected.

  25. case object SecretRemoved extends SuccessResponse with Product with Serializable

    A secret was successfully removed.

  26. case object SecretStored extends SuccessResponse with Product with Serializable

    A successful secret store reply.

  27. case object Unauthenticated extends FailureResponse with Product with Serializable

    The request cannot be fulfilled because the principal is not yet authenticated

  28. case object UnauthenticatedGetSecretAccess extends GetSecretStatus with Product with Serializable

    A secret is unable to be retrieved given no authentication

  29. case object UnauthenticatedPutSecretAccess extends PutSecretStatus with Product with Serializable

    A secret is unable to be stored given no authentication

  30. case object UnauthenticatedRemoveSecretAccess extends RemoveSecretStatus with Product with Serializable

    A secret is unable to be removed given no authentication

  31. case object UnauthorizedGetSecretAccess extends GetSecretStatus with Product with Serializable

    A secret is unable to be retrieved given inadequate authorization

  32. case object UnauthorizedPutSecretAccess extends PutSecretStatus with Product with Serializable

    A secret is unable to be stored given inadequate authorization

  33. case object UnauthorizedRemoveSecretAccess extends RemoveSecretStatus with Product with Serializable

    A secret is unable to be removed given inadequate authorization.

Inherited from AnyRef

Inherited from Any

Ungrouped