Packages

case class SftpFileRefConnection(id: ConnectionId, host: String, port: Int = 22, authMode: AuthMode, ignoreHostKeyVerification: Boolean = false, maxParallelConnections: Int = 1, connectionPoolMaxIdleTimeSec: Int = 3, metadata: Option[ConnectionMetadata] = None) extends Connection with Product with Serializable

SFTP Connection information

id

unique id of this connection

host

sftp host

port

port of sftp service, default is 22

authMode

authentication information: for now BasicAuthMode and PublicKeyAuthMode are supported.

ignoreHostKeyVerification

do not validate host key if true, default is false

maxParallelConnections

number of parallel sftp connections created by an instance of this connection

connectionPoolMaxIdleTimeSec

timeout to close unused connections in the pool

Annotations
@Scaladoc()
Linear Supertypes
Serializable, Serializable, Product, Equals, Connection, AtlasExportable, ParsableFromConfig[Connection], SdlConfigObject, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SftpFileRefConnection
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Connection
  7. AtlasExportable
  8. ParsableFromConfig
  9. SdlConfigObject
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SftpFileRefConnection(id: ConnectionId, host: String, port: Int = 22, authMode: AuthMode, ignoreHostKeyVerification: Boolean = false, maxParallelConnections: Int = 1, connectionPoolMaxIdleTimeSec: Int = 3, metadata: Option[ConnectionMetadata] = None)

    id

    unique id of this connection

    host

    sftp host

    port

    port of sftp service, default is 22

    authMode

    authentication information: for now BasicAuthMode and PublicKeyAuthMode are supported.

    ignoreHostKeyVerification

    do not validate host key if true, default is false

    maxParallelConnections

    number of parallel sftp connections created by an instance of this connection

    connectionPoolMaxIdleTimeSec

    timeout to close unused connections in the pool

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 atlasName: String
    Definition Classes
    Connection → AtlasExportable
  6. def atlasQualifiedName(prefix: String): String
    Definition Classes
    AtlasExportable
  7. val authMode: AuthMode
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. val connectionPoolMaxIdleTimeSec: Int
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def execWithSFtpClient[A](func: (SFTPClient) ⇒ A): A
  12. def factory: FromConfigFactory[Connection]

    Returns the factory that can parse this type (that is, type CO).

    Returns the factory that can parse this type (that is, type CO).

    Typically, implementations of this method should return the companion object of the implementing class. The companion object in turn should implement FromConfigFactory.

    returns

    the factory (object) for this class.

    Definition Classes
    SftpFileRefConnection → ParsableFromConfig
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. val host: String
  15. val id: ConnectionId

    A unique identifier for this instance.

    A unique identifier for this instance.

    Definition Classes
    SftpFileRefConnection → Connection → SdlConfigObject
  16. val ignoreHostKeyVerification: Boolean
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val maxParallelConnections: Int
  19. val metadata: Option[ConnectionMetadata]

    Additional metadata for the Connection

    Additional metadata for the Connection

    Definition Classes
    SftpFileRefConnection → Connection
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. val pool: GenericObjectPool[SFTPClient]
  24. val port: Int
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def test(): Unit
  27. def toStringShort: String
    Definition Classes
    Connection
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. 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 Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Connection

Inherited from AtlasExportable

Inherited from ParsableFromConfig[Connection]

Inherited from SdlConfigObject

Inherited from AnyRef

Inherited from Any

Ungrouped