io

Type Members

1. trait FileDescriptor extends AnyRef

   

   A representation of a file stored in an arbitrary location.

   A representation of a file stored in an arbitrary location. A descriptor includes logic to copy files to and from a local filesystem, as well as filesystem navigation logic.

2. trait FileDescriptorCredentials[Conf, CredObj] extends AnyRef

   

   Trait that describes how a FileDescriptor extracts credentials from a config.

   Trait that describes how a FileDescriptor extracts credentials from a config.

   The config file must follow the following structure:

   {
     default = <protocolCredentials>
     ids {
       id1 = <protocolCredentials>
       id2 = <protocolCredentials>
     }
   }

   The default is optional and is used as a fallback when the file descriptor id matches none of the credentials ids.

   Conf

   The type of credential config that is extracted

   CredObj

   The type of credential object that is extracted

3. class InsistentInputStream extends InputStream with Logging

   

   A InputStream that wraps another InputStream, retrying failed reads.

   A InputStream that wraps another InputStream, retrying failed reads. This is useful for input streams that can have transient failures (eg HTTP input streams).

4. class LazySequenceInputStream extends InputStream

   

   Provides the same functionality as java.io.SequenceInputStream, i.e.

   Provides the same functionality as java.io.SequenceInputStream, i.e. a SequenceInputStream represents the logical concatenation of other input streams. Unlike SequenceInputStream, this implementation will open the concatenated input streams lazily (as needed). At any point while reading from the stream, only one underlying InputStream should be open.

5. case class LocalFileDescriptor(initialPath: String) extends FileDescriptor with Logging with Product with Serializable

   

6. trait RemoteFileDescriptor extends AnyRef

   

7. trait ResourceUtil extends AnyRef

   

   Utility methods for handling resource files

8. case class S3FileDescriptor(bucket: S3Bucket, elements: List[String], summary: Option[S3ObjectSummary] = None) extends FileDescriptor with RemoteFileDescriptor with Logging with Product with Serializable

   

9. case class SftpFileDescriptor(host: String, port: Int, username: String, password: Option[String], elements: List[String], identity: Option[Identity], _fileAttributes: Option[FileAttributes] = None) extends FileDescriptor with RemoteFileDescriptor with Logging with Product with Serializable

   

   A FileDescriptor for files served over SFTP.

   A FileDescriptor for files served over SFTP. This file descriptor only supports absolute paths. The SSH connections for a given host are pooled.

   The URI for this FileDescriptor should be in the format: - sftp://<username>@<hostname>:<port>/<absolute-path>

   Both the username and port are optional. Additionally, the credentials config expects an object with the following format:

   sftp { default = { username = <username> password = <password> } }

   Or if using public key authentication: sftp { default = { username = <username> keypair-file = <key filename> passphrase = <passphrase> } }

   What is considered as an id for credentials handling is the hostname of the file descriptor, therefore it is possible to provide credentials for a specific hostname.