net.corda.core.node.services

Interface AttachmentStorage

All Known Implementing Classes:

MockAttachmentStorage

@DoNotImplement
public AttachmentStorage

An attachment store records potentially large binary objects, identified by their hash.

Constructor Detail

AttachmentStorage

public AttachmentStorage()

Method Detail

openAttachment

@Nullable
Attachment openAttachment(@NotNull
                                    SecureHash id)

Returns a handle to a locally stored attachment, or null if it's not known. The handle can be used to open a stream for the data, which will be a zip/jar file.

importAttachment

@Deprecated
 @NotNull
SecureHash importAttachment(@NotNull
                                                  java.io.InputStream jar)

Deprecated.

Inserts the given attachment into the store, does not close the input stream. This can be an intensive operation due to the need to copy the bytes to disk and hash them along the way.

Note that you should not pass a java.util.jar.JarInputStream into this method and it will throw if you do, because access to the raw byte stream is required.

Throws:

FileAlreadyExistsException - if the given byte stream has already been inserted.

IllegalArgumentException - if the given byte stream is empty or a java.util.jar.JarInputStream.

IOException - if something went wrong.

See Also:

java.util.jar.JarInputStream

importAttachment

@NotNull
SecureHash importAttachment(@NotNull
                                     java.io.InputStream jar,
                                     @NotNull
                                     java.lang.String uploader,
                                     @Nullable
                                     java.lang.String filename)

Inserts the given attachment with additional metadata, see importAttachment for input stream handling Extra parameters:

Parameters:

uploader - Uploader name

filename - Name of the file

See Also:

importAttachment

importOrGetAttachment

@Deprecated
 @NotNull
SecureHash importOrGetAttachment(@NotNull
                                                       java.io.InputStream jar)

Deprecated.

Inserts or returns Attachment Id of attachment. Does not throw an exception if already uploaded.

Parameters:

jar - InputStream of Jar file

Returns:

AttachmentId of uploaded attachment

queryAttachments

@NotNull
java.util.List<net.corda.core.crypto.SecureHash> queryAttachments(@NotNull
                                                                           AttachmentQueryCriteria criteria,
                                                                           @Nullable
                                                                           AttachmentSort sorting)

Searches attachment using given criteria and optional sort rules

Parameters:

criteria - Query criteria to use as a filter

sorting - Sorting definition, if not given, order is undefined

Returns:

List of AttachmentId of attachment matching criteria, sorted according to given sorting parameter

hasAttachment

boolean hasAttachment(@NotNull
                      SecureHash attachmentId)

Searches for an attachment already in the store

Parameters:

attachmentId - The attachment Id

Returns:

true if it's in there

queryAttachments

@NotNull
java.util.List<net.corda.core.crypto.SecureHash> queryAttachments(@NotNull
                                                                           AttachmentQueryCriteria criteria)

getLatestContractAttachments

@NotNull
java.util.List<net.corda.core.crypto.SecureHash> getLatestContractAttachments(@NotNull
                                                                                       java.lang.String contractClassName,
                                                                                       int minContractVersion)

Find the Attachment Id(s) of the contract attachments with the highest version for a given contract class name from trusted upload sources. Return highest version of both signed and unsigned attachment ids (signed first, unsigned second), otherwise return a single signed or unsigned version id, or an empty list if none meet the criteria.

Parameters:

contractClassName - The fully qualified name of the contract class.

minContractVersion - The minimum contract version that should be returned.

Returns:

the AttachmentIds of the contract attachments (signed always first in list), or an empty list if none meet the criteria.