R
- the set of handles for reading the document content from the databaseW
- the set of handles for writing the document content to the databasepublic interface DocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>
Modifier and Type | Interface and Description |
---|---|
static class |
DocumentManager.Metadata
The Metadata enumeration specifies the categories of metadata read from or written to the database.
|
Modifier and Type | Method and Description |
---|---|
void |
clearMetadataCategories()
Clears the metadata categories.
|
DocumentDescriptor |
create(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle)
Creates a database document with metadata and content and a uri assigned by the server.
|
DocumentDescriptor |
create(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform)
Creates a database document with metadata and content and a uri assigned by the server as transformed on the server.
|
DocumentDescriptor |
create(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Creates a database document with metadata and content and a uri assigned by the server in an open database transaction as transformed on the server.
|
DocumentDescriptor |
create(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
Transaction transaction) |
DocumentDescriptor |
create(DocumentUriTemplate template,
W contentHandle)
Creates a database document with a uri assigned by the server.
|
DocumentDescriptor |
create(DocumentUriTemplate template,
W contentHandle,
ServerTransform transform)
Creates a database document with a uri assigned by the server as transformed on the server.
|
DocumentDescriptor |
create(DocumentUriTemplate template,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Creates a database document with a uri assigned by the server in an open database transaction as transformed on the server.
|
DocumentDescriptor |
create(DocumentUriTemplate template,
W contentHandle,
Transaction transaction)
Creates a database document with a uri assigned by the server in an open database transaction.
|
DocumentDescriptor |
createAs(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
Object content)
Creates a database document with a uri assigned by the server from an object of an IO class.
|
DocumentDescriptor |
createAs(DocumentUriTemplate template,
DocumentMetadataWriteHandle metadataHandle,
Object content,
ServerTransform transform)
Creates a database document with a uri assigned by the server from an object of an IO class.
|
DocumentDescriptor |
createAs(DocumentUriTemplate template,
Object content)
Creates a database document with a uri assigned by the server from an object of an IO class.
|
DocumentDescriptor |
createAs(DocumentUriTemplate template,
Object content,
ServerTransform transform)
Creates a database document with a uri assigned by the server from an object of an IO class.
|
void |
delete(DocumentDescriptor desc)
Deletes the document metadata and content from the database
To call delete(), an application must authenticate as rest-writer or rest-admin.
|
void |
delete(DocumentDescriptor desc,
Transaction transaction)
Deletes the document metadata and content from an open database transaction
To call delete(), an application must authenticate as rest-writer or rest-admin.
|
void |
delete(String docId)
Deletes the document metadata and content from the database
To call delete(), an application must authenticate as rest-writer or rest-admin.
|
void |
delete(String docId,
Transaction transaction)
Deletes the document metadata and content from an open database transaction
To call delete(), an application must authenticate as rest-writer or rest-admin.
|
DocumentDescriptor |
exists(String docId)
Checks whether a document exists and gets its format and mimetype
To call exists(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
DocumentDescriptor |
exists(String docId,
Transaction transaction)
Checks whether a document exists in an open transaction and gets its length and format
To call exists(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
Format |
getContentFormat()
Gets the format of the managed documents
|
String |
getForestName()
Returns the name of the forest that should store written documents.
|
Set<DocumentManager.Metadata> |
getMetadataCategories()
Returns the categories of metadata to read, write, or patch.
|
ServerTransform |
getReadTransform()
Returns the transform for read requests that don't specify a transform.
|
ServerTransform |
getWriteTransform()
Returns the transform for write requests that don't specify a transform.
|
DocumentDescriptor |
newDescriptor(String uri)
Creates a document descriptor for identifying the uri of a document,
its format and mimetype, and its version.
|
DocumentUriTemplate |
newDocumentUriTemplate(String extension)
Creates a document uri template for assigning a uri to a document.
|
DocumentMetadataPatchBuilder |
newPatchBuilder(Format pathFormat)
Creates a builder for specifying changes to the metadata of a document.
|
void |
patch(DocumentDescriptor desc,
DocumentPatchHandle patch)
Modifies the metadata or content of a document.
|
void |
patch(DocumentDescriptor desc,
DocumentPatchHandle patch,
Transaction transaction)
Modifies the metadata or content of a document within an open database transaction on the server.
|
void |
patch(String docId,
DocumentPatchHandle patch)
Modifies the metadata or content of a document within an open database transaction on the server.
|
void |
patch(String docId,
DocumentPatchHandle patch,
Transaction transaction)
Modifies the metadata or content of a document within an open database transaction on the server.
|
void |
patchAs(String docId,
Object patch)
Modifies the metadata or content of a document within an open database transaction on the server.
|
<T extends R> |
read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle)
Reads the document metadata and content from the database in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends R> |
read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform)
Reads the document metadata and content from the database as transformed on the server.
|
<T extends R> |
read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document metadata and content from an open database transaction as transformed on the server.
|
<T extends R> |
read(DocumentDescriptor desc,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
Transaction transaction)
Reads the document metadata and content from an open database transaction in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends R> |
read(DocumentDescriptor desc,
T contentHandle)
Reads the document content from the database in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends R> |
read(DocumentDescriptor desc,
T contentHandle,
ServerTransform transform)
Reads the document content from the database as transformed on the server.
|
<T extends R> |
read(DocumentDescriptor desc,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document content from an open database transaction as transformed on the server.
|
<T extends R> |
read(DocumentDescriptor desc,
T contentHandle,
Transaction transaction)
Reads the document content from an open database transaction in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends R> |
read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle)
Reads the document metadata and content from the database in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends R> |
read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform)
Reads the document metadata and content from the database as transformed on the server.
|
<T extends R> |
read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document metadata and content from an open database transaction as transformed on the server.
|
<T extends R> |
read(String docId,
DocumentMetadataReadHandle metadataHandle,
T contentHandle,
Transaction transaction)
Reads the document metadata and content from an open database transaction in the representations provided by the handles
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends R> |
read(String docId,
T contentHandle)
Reads the document content from the database in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends R> |
read(String docId,
T contentHandle,
ServerTransform transform)
Reads the document content from the database as transformed on the server.
|
<T extends R> |
read(String docId,
T contentHandle,
ServerTransform transform,
Transaction transaction)
Reads the document content from an open database transaction as transformed on the server.
|
<T extends R> |
read(String docId,
T contentHandle,
Transaction transaction)
Reads the document content from an open database transaction in the representation provided by the handle
To call read(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T> T |
readAs(String docId,
Class<T> as)
Reads the document content from the database in the representation specified by the IO class.
|
<T> T |
readAs(String docId,
Class<T> as,
ServerTransform transform)
Reads the document content from the database in the representation specified by the IO class.
|
<T> T |
readAs(String docId,
DocumentMetadataReadHandle metadataHandle,
Class<T> as)
Reads the document metadata and content from the database in the representation specified by the IO class.
|
<T> T |
readAs(String docId,
DocumentMetadataReadHandle metadataHandle,
Class<T> as,
ServerTransform transform)
Reads the document metadata and content from the database in the representation specified by the IO class.
|
<T extends DocumentMetadataReadHandle> |
readMetadata(String docId,
T metadataHandle)
Reads the document metadata from the database in the representation provided by the handle
To call readMetadata(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
<T extends DocumentMetadataReadHandle> |
readMetadata(String docId,
T metadataHandle,
Transaction transaction)
Reads the document metadata from an open database transaction in the representation provided by the handle
To call readMetadata(), an application must authenticate as rest-reader, rest-writer, or rest-admin.
|
void |
setForestName(String forestName)
Specifies the name of the forest that should store written documents.
|
void |
setMetadataCategories(DocumentManager.Metadata... categories)
Specifies the categories of metadata to read, write, or patch.
|
void |
setMetadataCategories(Set<DocumentManager.Metadata> categories)
Specifies the categories of metadata to read, write, or patch.
|
void |
setReadTransform(ServerTransform transform)
Specifies a transform for read requests that don't specify a transform.
|
void |
setWriteTransform(ServerTransform transform)
Specifies a transform for write requests that don't specify a transform.
|
void |
startLogging(RequestLogger logger)
Starts debugging client requests.
|
void |
stopLogging()
Stops debugging client requests.
|
void |
write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle)
Writes the document metadata and content to the database from the representations provided by the handles
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform)
Writes the document metadata and content to the database as transformed on the server.
|
void |
write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document metadata and content to an open database transaction as transformed on the server.
|
void |
write(DocumentDescriptor desc,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
Transaction transaction)
Writes the document metadata and content to an open database transaction from the representations provided by the handles
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
write(DocumentDescriptor desc,
W contentHandle)
Writes the document content to the database from the representation provided by the handle
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
write(DocumentDescriptor desc,
W contentHandle,
ServerTransform transform)
Writes the document content to the database as transformed on the server.
|
void |
write(DocumentDescriptor desc,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document content to an open database transaction as transformed on the server.
|
void |
write(DocumentDescriptor desc,
W contentHandle,
Transaction transaction)
Writes the document content to an open database transaction from the representation provided by the handle
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle)
Writes the document metadata and content to the database from the representations provided by the handles
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform)
Writes the document metadata and content to the database as transformed on the server.
|
void |
write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document metadata and content to an open database transaction as transformed on the server.
|
void |
write(String docId,
DocumentMetadataWriteHandle metadataHandle,
W contentHandle,
Transaction transaction)
Writes the document metadata and content to an open database transaction from the representations provided by the handles
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
write(String docId,
W contentHandle)
Writes the document content to the database from the representation provided by the handle
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
write(String docId,
W contentHandle,
ServerTransform transform)
Writes the document content to the database as transformed on the server.
|
void |
write(String docId,
W contentHandle,
ServerTransform transform,
Transaction transaction)
Writes the document content to an open database transaction as transformed on the server.
|
void |
write(String docId,
W contentHandle,
Transaction transaction)
Writes the document content to an open database transaction from the representation provided by the handle
To call write(), an application must authenticate as rest-writer or rest-admin.
|
void |
writeAs(String docId,
DocumentMetadataWriteHandle metadataHandle,
Object content)
Writes the document content to the database from an object of an IO class.
|
void |
writeAs(String docId,
DocumentMetadataWriteHandle metadataHandle,
Object content,
ServerTransform transform)
Writes the document content to the database from an object of an IO class.
|
void |
writeAs(String docId,
Object content)
Writes the document content to the database from an object of an IO class.
|
void |
writeAs(String docId,
Object content,
ServerTransform transform)
Writes the document content to the database from an object of an IO class.
|
void |
writeDefaultMetadata(String docId)
Reverts the document metadata in the database to the defaults
To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
|
void |
writeDefaultMetadata(String docId,
Transaction transaction)
Reverts the document metadata in an open database transaction to the defaults
To call writeDefaultMetadata(), an application must authenticate as rest-writer or rest-admin.
|
void |
writeMetadata(String docId,
DocumentMetadataWriteHandle metadataHandle)
Writes the document metadata to the database from the representation provided by the handle
To call writeMetadata(), an application must authenticate as rest-writer or rest-admin.
|
void |
writeMetadata(String docId,
DocumentMetadataWriteHandle metadataHandle,
Transaction transaction)
Writes the document metadata to an open database transaction from the representation provided by the handle
To call writeMetadata(), an application must authenticate as rest-writer or rest-admin.
|
DocumentDescriptor newDescriptor(String uri)
uri
- the identifier for the documentDocumentUriTemplate newDocumentUriTemplate(String extension)
extension
- the identifier for the documentDocumentMetadataPatchBuilder newPatchBuilder(Format pathFormat)
pathFormat
- whether the patch specifies metadata with JSON or XML pathsDocumentDescriptor exists(String docId) throws ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentForbiddenUserException
FailedRequestException
DocumentDescriptor exists(String docId, Transaction transaction) throws ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documenttransaction
- a open transaction under which the document may have been created or deletedForbiddenUserException
FailedRequestException
<T> T readAs(String docId, Class<T> as) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentas
- the IO class for reading the content of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T> T readAs(String docId, Class<T> as, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentas
- the IO class for reading the content of the documenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T> T readAs(String docId, DocumentMetadataReadHandle metadataHandle, Class<T> as) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentas
- the IO class for reading the content of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T> T readAs(String docId, DocumentMetadataReadHandle metadataHandle, Class<T> as, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentas
- the IO class for reading the content of the documenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(String docId, T contentHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentcontentHandle
- a handle for reading the content of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(String docId, T contentHandle, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(DocumentDescriptor desc, T contentHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for reading the content of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(DocumentDescriptor desc, T contentHandle, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(String docId, T contentHandle, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentcontentHandle
- a handle for reading the content of the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(String docId, T contentHandle, ServerTransform transform, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(DocumentDescriptor desc, T contentHandle, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for reading the content of the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(DocumentDescriptor desc, T contentHandle, ServerTransform transform, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(String docId, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends R> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for reading the metadata of the documentcontentHandle
- a handle for reading the content of the documenttransform
- a server transform to modify the document contenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void writeAs(String docId, Object content) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentcontent
- an IO representation of the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void writeAs(String docId, Object content, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentcontent
- an IO representation of the document contenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void writeAs(String docId, DocumentMetadataWriteHandle metadataHandle, Object content) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for writing the metadata of the documentcontent
- an IO representation of the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void writeAs(String docId, DocumentMetadataWriteHandle metadataHandle, Object content, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for writing the metadata of the documentcontent
- an IO representation of the document contenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(String docId, W contentHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentcontentHandle
- a handle for writing the content of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(String docId, W contentHandle, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentcontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(DocumentDescriptor desc, W contentHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for writing the content of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(DocumentDescriptor desc, W contentHandle, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(String docId, W contentHandle, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentcontentHandle
- a handle for writing the content of the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(String docId, W contentHandle, ServerTransform transform, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentcontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(DocumentDescriptor desc, W contentHandle, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for writing the content of the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(DocumentDescriptor desc, W contentHandle, ServerTransform transform, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentcontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(String docId, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void write(DocumentDescriptor desc, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentmetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void delete(String docId) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void delete(String docId, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void delete(DocumentDescriptor desc) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void delete(DocumentDescriptor desc, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
desc
- a descriptor for the URI identifier, format, and mimetype of the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
DocumentDescriptor createAs(DocumentUriTemplate template, Object content) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document uricontent
- an IO representation of the document contentForbiddenUserException
FailedRequestException
DocumentDescriptor createAs(DocumentUriTemplate template, Object content, ServerTransform transform) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document uricontent
- an IO representation of the document contenttransform
- a server transform to modify the document contentForbiddenUserException
FailedRequestException
DocumentDescriptor createAs(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, Object content) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document urimetadataHandle
- a handle for writing the metadata of the documentcontent
- an IO representation of the document contentForbiddenUserException
FailedRequestException
DocumentDescriptor createAs(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, Object content, ServerTransform transform) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document urimetadataHandle
- a handle for writing the metadata of the documentcontent
- an IO representation of the document contenttransform
- a server transform to modify the document contentForbiddenUserException
FailedRequestException
DocumentDescriptor create(DocumentUriTemplate template, W contentHandle) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document uricontentHandle
- a handle for writing the content of the documentForbiddenUserException
FailedRequestException
DocumentDescriptor create(DocumentUriTemplate template, W contentHandle, ServerTransform transform) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document uricontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contentForbiddenUserException
FailedRequestException
DocumentDescriptor create(DocumentUriTemplate template, W contentHandle, Transaction transaction) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document uricontentHandle
- a handle for writing the content of the documenttransaction
- a open transaction under which the document may have been created or deletedForbiddenUserException
FailedRequestException
DocumentDescriptor create(DocumentUriTemplate template, W contentHandle, ServerTransform transform, Transaction transaction) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document uricontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contenttransaction
- a open transaction under which the document may have been created or deletedForbiddenUserException
FailedRequestException
DocumentDescriptor create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document urimetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documentForbiddenUserException
FailedRequestException
DocumentDescriptor create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document urimetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contentForbiddenUserException
FailedRequestException
DocumentDescriptor create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, Transaction transaction) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document urimetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documenttransaction
- a open transaction under which the document may have been created or deletedForbiddenUserException
FailedRequestException
DocumentDescriptor create(DocumentUriTemplate template, DocumentMetadataWriteHandle metadataHandle, W contentHandle, ServerTransform transform, Transaction transaction) throws ForbiddenUserException, FailedRequestException
template
- the template for constructing the document urimetadataHandle
- a handle for writing the metadata of the documentcontentHandle
- a handle for writing the content of the documenttransform
- a server transform to modify the document contenttransaction
- a open transaction under which the document may have been created or deletedForbiddenUserException
FailedRequestException
void patchAs(String docId, Object patch) throws ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentpatch
- an IO representation of the patchForbiddenUserException
FailedRequestException
void patch(String docId, DocumentPatchHandle patch)
docId
- the URI identifier for the documentpatch
- a handle for writing the modification to the document metadata or contentvoid patch(String docId, DocumentPatchHandle patch, Transaction transaction)
docId
- the URI identifier for the documentpatch
- a handle for writing the modification to the document metadata or contenttransaction
- a open transactionvoid patch(DocumentDescriptor desc, DocumentPatchHandle patch)
desc
- a descriptor for the URI identifier, format, and mimetype of the documentpatch
- a handle for writing the modification to the document metadata or contentvoid patch(DocumentDescriptor desc, DocumentPatchHandle patch, Transaction transaction)
desc
- a descriptor for the URI identifier, format, and mimetype of the documentpatch
- a handle for writing the modification to the document metadata or contenttransaction
- a open transaction<T extends DocumentMetadataReadHandle> T readMetadata(String docId, T metadataHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends DocumentMetadataReadHandle> T readMetadata(String docId, T metadataHandle, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for reading the metadata of the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void writeMetadata(String docId, DocumentMetadataWriteHandle metadataHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for writing the metadata of the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void writeMetadata(String docId, DocumentMetadataWriteHandle metadataHandle, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentmetadataHandle
- a handle for writing the metadata of the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
void writeDefaultMetadata(String docId) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documentResourceNotFoundException
ForbiddenUserException
FailedRequestException
void writeDefaultMetadata(String docId, Transaction transaction) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
docId
- the URI identifier for the documenttransaction
- a open transaction under which the document may have been created or deletedResourceNotFoundException
ForbiddenUserException
FailedRequestException
Format getContentFormat()
Set<DocumentManager.Metadata> getMetadataCategories()
void setMetadataCategories(Set<DocumentManager.Metadata> categories)
categories
- the set of metadata categoriesvoid setMetadataCategories(DocumentManager.Metadata... categories)
categories
- the set of metadata categoriesvoid clearMetadataCategories()
ServerTransform getReadTransform()
void setReadTransform(ServerTransform transform)
transform
- the name of the transformServerTransform getWriteTransform()
void setWriteTransform(ServerTransform transform)
transform
- the name of the transformString getForestName()
void setForestName(String forestName)
forestName
- the name of the forestvoid startLogging(RequestLogger logger)
logger
- the logger that receives debugging outputvoid stopLogging()
Copyright © 2013-2015 MarkLogic Corporation.