Packages

t

io.github.cakelier

RemoteConfiguration

trait RemoteConfiguration extends AnyRef

A configuration for accessing a remote location.

This entity represents the configuration parameters which are needed for accessing a remote location, a remote server, through SSH. The hostname and the username to be used are required, while the port is not needed, defaulting to the one used for SSH, which is the port 22. Other data can be specified, such as: the password for the user, if a password-based authentication must be performed, the java.nio.file.Path to the file containing the private key, if a public key-based authentication is required. Moreover, a passphrase can be specified for the private key, if it has been encrypted. If both the password and the java.nio.file.Path to the private key were specified, the last one takes precedence and the first one is ignored. If neither is specified, an empty password will be supplied. Last, a fingerprint can be specified for verifying the identity of the remote location to which connecting and fail if not corresponding. By default, the connection to the remote is established only if the identity can be verified, but this feature can be turned off.

Instances of this trait must be constructed through its companion object.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RemoteConfiguration
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val fingerprint: Option[String]

    Returns a scala.Some containing the fingerprint to be used for identifying the remote host to which connecting, if present, a scala.None if absent.

  2. abstract val host: String

    Returns the hostname of the remote location.

  3. abstract val password: Option[String]

    Returns a scala.Some containing the password to be used during the authentication process, if present, scala.None if absent.

  4. abstract val port: Int

    Returns the port to which establishing a connection to the remote location.

  5. abstract val privateKeyFile: Option[Path]

    Returns a scala.Some containing the java.nio.file.Path to the file containing the private key to be used during the authentication process, if present, scala.None if absent.

  6. abstract val privateKeyPassphrase: Option[String]

    Returns a scala.Some containing the passphrase to be used for decrypting the private key to be used during the authentication process, if present, scala.None if absent.

  7. abstract val user: String

    Returns the username of the user to use while establishing a connection to the remote location.

  8. abstract val verifyIdentity: Boolean

    Returns whether or not the connection to the remote location is to be made only if its identity can be verified.

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped