com.couchbase.lite

Class Attachment

java.lang.Object

com.couchbase.lite.Attachment

public final class Attachment
extends java.lang.Object

A Couchbase Lite Document Attachment.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Attachment(java.io.InputStream contentStream, java.lang.String contentType) Constructor
protected	Attachment(Revision revision, java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> metadata) Constructor

Method Summary

Modifier and Type	Method and Description
protected static BlobStoreWriter	blobStoreWriterForBody(java.io.InputStream body, Database database)
protected java.io.InputStream	getBodyIfNew()
java.io.InputStream	getContent() Get the input stream of the content (aka 'body') data.
java.lang.String	getContentType() Get the MIME type of the contents.
java.net.URL	getContentURL() Get the URL of the file containing the contents.
Document	getDocument() Get the owning document.
long	getLength() Get the length in bytes of the contents.
java.util.Map<java.lang.String,java.lang.Object>	getMetadata() The CouchbaseLite metadata about the attachment, that lives in the document.
java.lang.String	getName() Get the filename.
Revision	getRevision() Get the owning document revision.
protected static java.util.Map<java.lang.String,java.lang.Object>	installAttachmentBodies(java.util.Map<java.lang.String,java.lang.Object> attachments, Database database) Goes through an _attachments dictionary and replaces any values that are Attachment objects with proper JSON metadata dicts.
protected void	setName(java.lang.String name)
protected void	setRevision(Revision revision)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Attachment

public Attachment(java.io.InputStream contentStream,
                  java.lang.String contentType)

Constructor

Attachment

protected Attachment(Revision revision,
                     java.lang.String name,
                     java.util.Map<java.lang.String,java.lang.Object> metadata)

Constructor

Method Detail

getRevision

public Revision getRevision()

Get the owning document revision.

getDocument

public Document getDocument()

Get the owning document.

getName

public java.lang.String getName()

Get the filename.

getContentType

public java.lang.String getContentType()

Get the MIME type of the contents.

getContent

public java.io.InputStream getContent()
                               throws CouchbaseLiteException

Get the input stream of the content (aka 'body') data.

Throws:

CouchbaseLiteException

getContentURL

public java.net.URL getContentURL()

Get the URL of the file containing the contents. This property is somewhat deprecated and is made available only for use with platform APIs that require file paths/URLs, e.g. some media playback APIs. Whenever possible, use the `getContent()` method to get the input stream of the content instead. The file must be treated as read-only! DO NOT MODIFY OR DELETE IT. If the database is encrypted, attachment files are also encrypted and not directly readable, so this property will return null.

getLength

public long getLength()

Get the length in bytes of the contents.

getMetadata

public java.util.Map<java.lang.String,java.lang.Object> getMetadata()

The CouchbaseLite metadata about the attachment, that lives in the document.

setName

protected void setName(java.lang.String name)

setRevision

protected void setRevision(Revision revision)

getBodyIfNew

protected java.io.InputStream getBodyIfNew()

installAttachmentBodies

protected static java.util.Map<java.lang.String,java.lang.Object> installAttachmentBodies(java.util.Map<java.lang.String,java.lang.Object> attachments,
                                                                                          Database database)
                                                                                   throws CouchbaseLiteException

Goes through an _attachments dictionary and replaces any values that are Attachment objects with proper JSON metadata dicts. It registers the attachment bodies with the blob store and sets the metadata 'getDigest' and 'follows' properties accordingly.

Throws:

CouchbaseLiteException

blobStoreWriterForBody

protected static BlobStoreWriter blobStoreWriterForBody(java.io.InputStream body,
                                                        Database database)
                                                 throws java.io.IOException,
                                                        SymmetricKeyException

Throws:

java.io.IOException

SymmetricKeyException