Index (Transport API 1.0.1-3.4 API)

C E O P S T V

C

closed() - Method in interface org.dataconservancy.pass.deposit.transport.TransportSession

E

error() - Method in interface org.dataconservancy.pass.deposit.transport.TransportResponse: Will contain the Throwable in the case an error is encountered transferring the bytes to the target system.

O

onSuccess(Submission, Deposit, RepositoryCopy) - Method in interface org.dataconservancy.pass.deposit.transport.TransportResponse: Invoked as a callback by Deposit Services after creating or updating PASS repository resources related to the successful transfer of bytes by a Transport.
open(Map<String, String>) - Method in interface org.dataconservancy.pass.deposit.transport.Transport: Open a TransportSession with the underlying transport.
org.dataconservancy.pass.deposit.transport - package org.dataconservancy.pass.deposit.transport: Provides an API for streaming a submission package to a target system, independent of the transport layer (FTP, HTTP, etc.).

P

protocol() - Method in interface org.dataconservancy.pass.deposit.transport.Transport: Return the transport protocol implemented by this instance

S

send(PackageStream, Map<String, String>) - Method in interface org.dataconservancy.pass.deposit.transport.TransportSession: Transfer the bytes of the supplied package to the remote system.
success() - Method in interface org.dataconservancy.pass.deposit.transport.TransportResponse: Whether or not transferring the stream of bytes to the target destination succeeded without error.

T

Transport - Interface in org.dataconservancy.pass.deposit.transport: Abstracts the transport protocol used to deposit a package with a target submission system.
Transport.AUTHMODE - Enum in org.dataconservancy.pass.deposit.transport
Transport.PROTOCOL - Enum in org.dataconservancy.pass.deposit.transport
TRANSPORT_AUTHMODE - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property key identifying the mode of authentication; value encoded as the Enum.name form of Transport.AUTHMODE.
TRANSPORT_CHECKSUM_MD5 - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property key identifying the base64 encoded checksum of the InputStream being deposited by TransportSession.send(PackageStream, Map).
TRANSPORT_CHECKSUM_SHA256 - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property key identifying the base64 encoded checksum of the InputStream being deposited by TransportSession.send(PackageStream, Map).
TRANSPORT_CHECKSUM_SHA512 - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property key identifying the base64 encoded checksum of the InputStream being deposited by TransportSession.send(PackageStream, Map).
TRANSPORT_MIME_TYPE - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property key identifying the mime type of the InputStream being deposited by TransportSession.send(PackageStream, Map).
TRANSPORT_PACKAGE_SPEC - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property key identifying the packaging spec of the InputStream being deposited by TransportSession.send(PackageStream, Map).
TRANSPORT_PASSWORD - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property key carrying the password used for authentication when using Transport.AUTHMODE.userpass.
TRANSPORT_PROTOCOL - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property key identifying the protocol used for transport, value encoded as the Enum.name form of Transport.PROTOCOL.
TRANSPORT_SERVER_FQDN - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property identifying the server (or IP address) that the package will be deposited to
TRANSPORT_SERVER_PORT - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property identifying the TCP port that will be used by the transport to deposit the package
TRANSPORT_SERVERID - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property identifying the value that can be used to look up authentication credentials by reference (i.e.
TRANSPORT_USERNAME - Static variable in interface org.dataconservancy.pass.deposit.transport.Transport: Property key carrying the user name used for authentication when using Transport.AUTHMODE.userpass.
TransportResponse - Interface in org.dataconservancy.pass.deposit.transport
TransportSession - Interface in org.dataconservancy.pass.deposit.transport: Represents an open connection, or the promise of a successful connection, with a service or system that will accept the bytes of a package.

V

valueOf(String) - Static method in enum org.dataconservancy.pass.deposit.transport.Transport.AUTHMODE: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.dataconservancy.pass.deposit.transport.Transport.PROTOCOL: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.dataconservancy.pass.deposit.transport.Transport.AUTHMODE: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.dataconservancy.pass.deposit.transport.Transport.PROTOCOL: Returns an array containing the constants of this enum type, in the order they are declared.

C E O P S T V