org.bdgenomics.adam.util

CredentialsProperties

class CredentialsProperties extends Serializable with Logging

CredentialsProperties is a wrapper class which extracts Amazon S3 keys (although it could be modified to extract other key / secret-key pairs) from a key-value-formatted file (see below), if available, or from the System environment otherwise.

(This is to make testing and running on a local environment easier.)

The 'location' parameter names a file which should have the format of key=value one per line. Whitespace around both 'key' and 'value' are stripped.

Linear Supertypes
Logging, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CredentialsProperties
  2. Logging
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CredentialsProperties(location: Option[File])

    location

    The location of the file which will be read _if it exists and is readable_, otherwise the parameters will be read from the System environment.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. def accessKey(suffix: Option[String]): String

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def awsCredentials(suffix: Option[String] = None): AWSCredentials

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val configuration: Map[String, String]

  11. def configuredValue(keyName: String, suffix: Option[String] = None): String

    Retrieves the value associated with a given key from the configuration file.

    Retrieves the value associated with a given key from the configuration file.

    The optional 'suffix' argument is used for differentiating different key/value pairs, used for different purposes but with similar keys. For example, we (Genome Bridge) will create configuration files with one key 'accessKey' which contains the AWS access key for accessing almost all our AWS resources -- however, we use a different access (and secret) key for accessing S3, and that's put into the same configuration file with a key name 'accessKey_s3'. (Similarly for 'secretKey' and 'secretKey_s3').

    keyName

    The base key used to retrieve a value

    suffix

    If suffix is None, then the base key is used to retrieve the corresponding value. If suffix is specified, then '[base key]_[suffix]' is used instead. If '[base key]_[suffix]' doesn't exist in the file, then the properties falls back to retrieving the value just associated with the base key itself.

    returns

    The (string) value associated with the given key, or null if no such key exists.

  12. val defaultAccessKey: String

  13. val defaultSecretKey: String

  14. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int

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

    Definition Classes
    Any
  20. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging
  21. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging
  22. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  23. def logDebug(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  24. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  25. def logError(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  26. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  27. def logInfo(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  28. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  29. def logTrace(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  30. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  31. def logWarning(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  32. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  33. final def notify(): Unit

    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  35. def secretKey(suffix: Option[String]): String

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

    Definition Classes
    AnyRef
  37. def toString(): String

    Definition Classes
    AnyRef → Any
  38. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped