Class/Object

args4c

SecureConfig

Related Docs: object SecureConfig | package args4c

Permalink

case class SecureConfig(promptForInput: UserInput) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SecureConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SecureConfig(promptForInput: UserInput)

    Permalink

Value Members

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

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  7. def finalize(): Unit

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

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

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

    Permalink
    Definition Classes
    AnyRef
  11. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  12. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  13. val promptForInput: UserInput

    Permalink
  14. def readConfigPassword(): Array[Byte]

    Permalink

    returns

    the application config password used to encrypt the config

    Attributes
    protected
  15. def readSecureConfigAtPath(pathToEncryptedConfig: Path): Option[Config]

    Permalink

    read the configuration from the given path, prompting for the password via 'promptForInput' should the SecureConfig.SecureEnvVariableName environment variable not be set

    read the configuration from the given path, prompting for the password via 'promptForInput' should the SecureConfig.SecureEnvVariableName environment variable not be set

    pathToEncryptedConfig

    the path pointing at the encrypted config

    returns

    a configuration if the file exists

  16. def setupSecureConfig(defaultSecureConfigFilePath: Path, requiredPaths: Seq[String] = Nil): Path

    Permalink

    defaultSecureConfigFilePath

    the default path to store the configuration in, either from the --secure=x/y/z user arg, and env variable or default

    requiredPaths

    a potentially empty list of configuration paths which need to have values specified

    returns

    the path to the secure config

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

    Permalink
    Definition Classes
    AnyRef
  18. def updateSecureConfig(configPath: Path, requiredPaths: Seq[String]): Path

    Permalink

    prompt for and set some secure values

    prompt for and set some secure values

    configPath

    the path where the secure config is written

    requiredPaths

    a potentially empty list of configuration paths which need to have values specified

    returns

    the path to the encrypted configuration file

  19. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped