org.dataconservancy.pass.deposit.transport

Interface Transport

public interface Transport

Abstracts the transport protocol used to deposit a package with a target submission system. Callers are able to open a TransportSession by supplying configuration hints, which allows the implementation to perform necessary connection initialization, prior to a package being transported using TransportSession.send(PackageStream, Map).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Transport.AUTHMODE
static class	Transport.PROTOCOL

Field Summary

Fields

Modifier and Type	Field and Description
static String	TRANSPORT_AUTHMODE Property key identifying the mode of authentication; value encoded as the Enum.name form of Transport.AUTHMODE.
static String	TRANSPORT_CHECKSUM_MD5 Property key identifying the base64 encoded checksum of the InputStream being deposited by TransportSession.send(PackageStream, Map).
static String	TRANSPORT_CHECKSUM_SHA256 Property key identifying the base64 encoded checksum of the InputStream being deposited by TransportSession.send(PackageStream, Map).
static String	TRANSPORT_CHECKSUM_SHA512 Property key identifying the base64 encoded checksum of the InputStream being deposited by TransportSession.send(PackageStream, Map).
static String	TRANSPORT_MIME_TYPE Property key identifying the mime type of the InputStream being deposited by TransportSession.send(PackageStream, Map).
static String	TRANSPORT_PACKAGE_SPEC Property key identifying the packaging spec of the InputStream being deposited by TransportSession.send(PackageStream, Map).
static String	TRANSPORT_PASSWORD Property key carrying the password used for authentication when using Transport.AUTHMODE.userpass.
static String	TRANSPORT_PROTOCOL Property key identifying the protocol used for transport, value encoded as the Enum.name form of Transport.PROTOCOL.
static String	TRANSPORT_SERVER_FQDN Property identifying the server (or IP address) that the package will be deposited to
static String	TRANSPORT_SERVER_PORT Property identifying the TCP port that will be used by the transport to deposit the package
static String	TRANSPORT_SERVERID Property identifying the value that can be used to look up authentication credentials by reference (i.e.
static String	TRANSPORT_USERNAME Property key carrying the user name used for authentication when using Transport.AUTHMODE.userpass.

Method Summary

Modifier and Type	Method and Description
TransportSession	open(Map<String,String> hints) Open a TransportSession with the underlying transport.
Transport.PROTOCOL	protocol() Return the transport protocol implemented by this instance

Field Detail

TRANSPORT_SERVERID

static final String TRANSPORT_SERVERID

Property identifying the value that can be used to look up authentication credentials by reference (i.e. the value of this property serves as a key for an implementation to look up authentication credentials)

See Also:

Constant Field Values

TRANSPORT_USERNAME

static final String TRANSPORT_USERNAME

Property key carrying the user name used for authentication when using Transport.AUTHMODE.userpass.

See Also:

Constant Field Values

TRANSPORT_PASSWORD

static final String TRANSPORT_PASSWORD

Property key carrying the password used for authentication when using Transport.AUTHMODE.userpass.

See Also:

Constant Field Values

TRANSPORT_AUTHMODE

static final String TRANSPORT_AUTHMODE

Property key identifying the mode of authentication; value encoded as the Enum.name form of Transport.AUTHMODE.

See Also:

Constant Field Values

TRANSPORT_PROTOCOL

static final String TRANSPORT_PROTOCOL

Property key identifying the protocol used for transport, value encoded as the Enum.name form of Transport.PROTOCOL.

See Also:

Constant Field Values

TRANSPORT_SERVER_FQDN

static final String TRANSPORT_SERVER_FQDN

Property identifying the server (or IP address) that the package will be deposited to

See Also:

Constant Field Values

TRANSPORT_SERVER_PORT

static final String TRANSPORT_SERVER_PORT

Property identifying the TCP port that will be used by the transport to deposit the package

See Also:

Constant Field Values

TRANSPORT_CHECKSUM_SHA256

static final String TRANSPORT_CHECKSUM_SHA256

Property key identifying the base64 encoded checksum of the InputStream being deposited by TransportSession.send(PackageStream, Map). N.B.: The preferred form of obtaining the checksum of the InputStream would be PackageStream.Metadata#checksums().

See Also:

Constant Field Values

TRANSPORT_CHECKSUM_SHA512

static final String TRANSPORT_CHECKSUM_SHA512

Property key identifying the base64 encoded checksum of the InputStream being deposited by TransportSession.send(PackageStream, Map). N.B.: The preferred form of obtaining the checksum of the InputStream would be PackageStream.Metadata#checksums().

See Also:

Constant Field Values

TRANSPORT_CHECKSUM_MD5

static final String TRANSPORT_CHECKSUM_MD5

Property key identifying the base64 encoded checksum of the InputStream being deposited by TransportSession.send(PackageStream, Map). N.B.: The preferred form of obtaining the checksum of the InputStream would be PackageStream.Metadata#checksums().

See Also:

Constant Field Values

TRANSPORT_MIME_TYPE

static final String TRANSPORT_MIME_TYPE

Property key identifying the mime type of the InputStream being deposited by TransportSession.send(PackageStream, Map). N.B.: The preferred form of obtaining the name of the InputStream would be PackageStream.Metadata#name().

See Also:

Constant Field Values

TRANSPORT_PACKAGE_SPEC

static final String TRANSPORT_PACKAGE_SPEC

Property key identifying the packaging spec of the InputStream being deposited by TransportSession.send(PackageStream, Map). N.B.: The preferred form of obtaining the packaging specification of the InputStream would be PackageStream.Metadata#spec().

See Also:

Constant Field Values

Method Detail

protocol

Transport.PROTOCOL protocol()

Return the transport protocol implemented by this instance

Returns:

the protocol provided by this instance

open

TransportSession open(Map<String,String> hints)

Open a TransportSession with the underlying transport. The returned TransportSession should be ready to use by the caller, without the caller having to perform any further setup (the implementation of this method should perform all necessary actions to allow TransportSession.send(PackageStream, Map) to succeed). The supplied hints may be used by the implementation to configure and open the session. Well known properties include those documented in Transport, and individual implementations may document properties as well.

The returned TransportSession should be open, otherwise implementations are encouraged to throw a RuntimeException if a closed TransportSession would be returned.

Parameters:

hints - transport implementation configuration hints

Returns:

an open TransportSession, ready to transfer packages using the underlying transport