org.dataconservancy.pass.deposit.transport

Interface TransportSession

All Superinterfaces:

AutoCloseable

public interface TransportSession
extends AutoCloseable

Represents an open connection, or the promise of a successful connection, with a service or system that will accept the bytes of a package. Instances of TransportSession that are immediately returned from Transport.open(Map) ought to be open (that is, closed() should return false). If the underlying implementation allows a TransportSession to be re-used (i.e. to send(...) multiple files), closed() can be used to check the health of the underlying connection, and whether or not this TransportSession is still viable.

This interface extends AutoCloseable so it can be used in a try-with-resources block.

Method Summary

Modifier and Type	Method and Description
boolean	closed()
TransportResponse	send(PackageStream packageStream, Map<String,String> metadata) Transfer the bytes of the supplied package to the remote system.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

send

TransportResponse send(PackageStream packageStream,
                       Map<String,String> metadata)

Transfer the bytes of the supplied package to the remote system. Metadata can be optionally supplied which may help the underlying transport correctly configure itself for the transfer.

Note the PackageStream carries metadata about the package itself. However, the supplied metadata could be used to augment the PackageStream metadata, in addition to carrying transport-related metadata.

Parameters:

packageStream - the package and package metadata

metadata - transport-related metadata, or any "extra" package metadata

Returns:

a response indicating success or failure of the transfer

closed

boolean closed()