Packages

t

eu.shiftforward.apso.config

FileDescriptorCredentials

trait FileDescriptorCredentials[T] extends AnyRef

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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileDescriptorCredentials
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. 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
  2. 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
  3. 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

  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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  15. 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

  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped