BearerTokenAuthenticatorSettings

The settings for the bearer token authenticator.

fieldName: The name of the field in which the token will be transferred in any part of the request.
requestParts: Some request parts from which a value can be extracted or None to extract values from any part of the request.
authenticatorIdleTimeout: The duration an authenticator can be idle before it timed out.
authenticatorExpiry: The duration an authenticator expires after it was created.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new BearerTokenAuthenticatorSettings(fieldName: String = "X-Auth-Token", requestParts: Option[Seq[api.util.RequestPart.Value]] = Some(Seq(RequestPart.Headers)), authenticatorIdleTimeout: Option[FiniteDuration] = None, authenticatorExpiry: FiniteDuration = 12 hours)

fieldName
The name of the field in which the token will be transferred in any part of the request.
requestParts
Some request parts from which a value can be extracted or None to extract values from any part of the request.
authenticatorIdleTimeout
The duration an authenticator can be idle before it timed out.
authenticatorExpiry
The duration an authenticator expires after it was created.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val authenticatorExpiry: FiniteDuration

The duration an authenticator expires after it was created.
val authenticatorIdleTimeout: Option[FiniteDuration]

The duration an authenticator can be idle before it timed out.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val fieldName: String

The name of the field in which the token will be transferred in any part of the request.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val requestParts: Option[Seq[api.util.RequestPart.Value]]

Some request parts from which a value can be extracted or None to extract values from any part of the request.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package authenticators

Instance Constructors

new BearerTokenAuthenticatorSettings(fieldName: String = "X-Auth-Token", requestParts: Option[Seq[api.util.RequestPart.Value]] = Some(Seq(RequestPart.Headers)), authenticatorIdleTimeout: Option[FiniteDuration] = None, authenticatorExpiry: FiniteDuration = 12 hours)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val authenticatorExpiry: FiniteDuration

val authenticatorIdleTimeout: Option[FiniteDuration]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

val fieldName: String

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val requestParts: Option[Seq[api.util.RequestPart.Value]]

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped