FileDescriptorCredentials

Trait that describes how a FileDescriptor extracts credentials from a config.

The config file must follow the following structure:

{{protocol}}.default = $protocolCredentials {{protocol}}.credentials = [{ id = id1 creds = $protocolCredentials },{ ids = [id2, id3] creds = $protocolCredentials }]

The {{protocol}}.default is an optional and is used as a fallback when the file descriptor id matches none of the credentials ids.

Inside the {{protocol}}.credentials list there must be a creds key which contains the all required keys for the pertaining protocol, and either an id or a ids key which represent an unique id or a list of unique ids respectively for which the credentials are valid.

T: The type of credential object that is extracted

Linear Supertypes

AnyRef, Any

Abstract Value Members

abstract def createCredentials(fdId: String, fdConfig: Config): T

Creates a credential object T from the file descriptor specific config
Creates a credential object T from the file descriptor specific config
fdConfig
the config containing specific keys required to create a credential object T for the file descriptor
returns
the credential object T

Attributes
protected
abstract def id(path: String): String

Returns an unique id from the given file descriptor path to use when accessing the config
Returns an unique id from the given file descriptor path to use when accessing the config
path
the file descriptor path
returns
an unique id from the given file descriptor path

Attributes
protected
abstract def protocol: String

The protocol key to use when accessing the config
The protocol key to use when accessing the config
returns
the protocol key to use when accessing the config

Concrete 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
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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
def read(config: Config, path: String): Option[T]

Reads from the config file and given the file descriptor path converted to an unique id by the ìd function, extracts a credentials object T.
Reads from the config file and given the file descriptor path converted to an unique id by the ìd function, extracts a credentials object T.
config
the config file with the credentials keys
path
the file descriptor path to be converted to an unique id
returns
the credential object T
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 config

trait FileDescriptorCredentials[T] extends AnyRef

Abstract Value Members

abstract def createCredentials(fdId: String, fdConfig: Config): T

abstract def id(path: String): String

abstract def protocol: String

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def read(config: Config, path: String): Option[T]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped