public class Repository extends DigitalObject
Modifier and Type | Class and Description |
---|---|
static interface |
Repository.CloseableIterator<T> |
class |
Repository.QueryResults |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SERIALIZED_ENCODING |
Constructor and Description |
---|
Repository(DOAuthentication auth,
DOServiceInfo service)
Constructor for a repository that interfaces an object that provides
an interface to the with the given authentication information
|
Repository(DOAuthentication auth,
java.lang.String repoID)
Constructor for a repository that interfaces an object that provides
an interface to the with the given authentication information
|
Repository(java.lang.String repoID,
DOClientConnection conn)
Construct a Repository instance which can be used to talk over existing
connections to DO servers.
|
Modifier and Type | Method and Description |
---|---|
void |
close() |
java.lang.String |
copyObjectFrom(Repository source,
java.lang.String objectID)
Create a new object on this repository with the given identifier and
return the ID of the new object.
|
DigitalObject |
createDigitalObject(java.lang.String objectID)
Create a new digital object in this repository and return an interface
to that object.
|
void |
deleteDigitalObject(java.lang.String objectID)
Deletes a specified digital object from the repository
|
DOClientConnection |
getConnection()
Internal method to return the underlying connection that is used to
communicate with this Repository.
|
DigitalObject |
getDigitalObject(java.lang.String objectID)
If the specified digital object exists in the repository, this method
will return an instance of the DigitalObject class corresponding to that
object.
|
Repository.CloseableIterator |
listObjects()
Return an iterator of object IDs that are contained in this repository.
|
StreamPair |
performOperation(java.lang.String objectID,
java.lang.String operationID,
HeaderSet parameters)
Invoke a low-level operation on the given object, returning the input and output
streams for the operation in a StreamPair.
|
Repository.CloseableIterator<HeaderSet> |
search(java.lang.String query) |
Repository.QueryResults |
search(java.lang.String query,
HeaderSet params) |
Repository.QueryResults |
search(java.lang.String query,
java.util.List<java.lang.String> returnedFields,
java.util.List<java.lang.String> sortFields,
int pageSize,
int pageOffset) |
Repository.QueryResults |
search(java.lang.String query,
java.util.List<java.lang.String> returnedFields,
java.util.List<java.lang.String> sortFields,
int pageSize,
int pageOffset,
boolean indexUpToDate) |
Repository.QueryResults |
search(java.lang.String query,
java.util.List<java.lang.String> returnedFields,
java.util.List<java.lang.String> sortFields,
int pageSize,
int pageOffset,
HeaderSet params) |
Repository.QueryResults |
search(java.lang.String query,
java.util.List<java.lang.String> returnedFields,
java.util.List<java.lang.String> sortFields,
java.lang.String sortOrder,
int pageSize,
int pageOffset)
Deprecated.
|
Repository.QueryResults |
search(java.lang.String query,
java.util.List<java.lang.String> returnedFields,
java.util.List<java.lang.String> sortFields,
java.lang.String sortOrder,
int pageSize,
int pageOffset,
boolean indexUpToDate)
Deprecated.
|
Repository.QueryResults |
search(java.lang.String query,
java.util.List<java.lang.String> returnedFields,
java.util.List<java.lang.String> sortFields,
java.lang.String sortOrder,
int pageSize,
int pageOffset,
HeaderSet params)
Deprecated.
|
void |
setUseEncryption(boolean encrypt)
Sets whether or not the connection to this repository will be encrypted.
|
java.lang.String |
toString()
Returns a nicely formatted label for this object
|
boolean |
verifyDigitalObject(java.lang.String objectID)
Verifies that the specified digital object exists in the current repository
|
checkAuthorization, deleteAttribute, deleteAttributes, deleteDataElement, deleteObject, getAttribute, getAttributes, getDataElement, getDateCreated, getDateLastModified, getID, getObjectID, getRepository, getSize, listAttributes, listDataElements, performOperation, refresh, setAttribute, setAttributes, verifyDataElement
public static final java.lang.String SERIALIZED_ENCODING
public Repository(DOAuthentication auth, java.lang.String repoID) throws DOException
DOException
public Repository(DOAuthentication auth, DOServiceInfo service) throws DOException
DOException
public Repository(java.lang.String repoID, DOClientConnection conn)
public void close()
public java.lang.String toString()
DigitalObject
toString
in class DigitalObject
public void setUseEncryption(boolean encrypt)
public DOClientConnection getConnection() throws DOException
DOException
public boolean verifyDigitalObject(java.lang.String objectID) throws DOException, java.io.IOException
DOException
java.io.IOException
public StreamPair performOperation(java.lang.String objectID, java.lang.String operationID, HeaderSet parameters) throws DOException, java.io.IOException
DOException
java.io.IOException
public DigitalObject createDigitalObject(java.lang.String objectID) throws DOException
DOException
public void deleteDigitalObject(java.lang.String objectID) throws DOException, java.io.IOException
DOException
java.io.IOException
public DigitalObject getDigitalObject(java.lang.String objectID) throws DOException, java.io.IOException
DOException
java.io.IOException
public Repository.CloseableIterator listObjects() throws DOException, java.io.IOException
DOException
java.io.IOException
public java.lang.String copyObjectFrom(Repository source, java.lang.String objectID) throws DOException
DOException
public Repository.CloseableIterator<HeaderSet> search(java.lang.String query) throws DOException, java.io.IOException
DOException
java.io.IOException
public Repository.QueryResults search(java.lang.String query, java.util.List<java.lang.String> returnedFields, java.util.List<java.lang.String> sortFields, int pageSize, int pageOffset) throws DOException, java.io.IOException
DOException
java.io.IOException
public Repository.QueryResults search(java.lang.String query, java.util.List<java.lang.String> returnedFields, java.util.List<java.lang.String> sortFields, int pageSize, int pageOffset, boolean indexUpToDate) throws DOException, java.io.IOException
DOException
java.io.IOException
public Repository.QueryResults search(java.lang.String query, java.util.List<java.lang.String> returnedFields, java.util.List<java.lang.String> sortFields, int pageSize, int pageOffset, HeaderSet params) throws DOException, java.io.IOException
DOException
java.io.IOException
@Deprecated public Repository.QueryResults search(java.lang.String query, java.util.List<java.lang.String> returnedFields, java.util.List<java.lang.String> sortFields, java.lang.String sortOrder, int pageSize, int pageOffset) throws DOException, java.io.IOException
sortOrder
for all fields. Instead use parameter sortFields
and use sort fields of the form "field ASC" or "field DESC".DOException
java.io.IOException
@Deprecated public Repository.QueryResults search(java.lang.String query, java.util.List<java.lang.String> returnedFields, java.util.List<java.lang.String> sortFields, java.lang.String sortOrder, int pageSize, int pageOffset, boolean indexUpToDate) throws DOException, java.io.IOException
sortOrder
for all fields. Instead use parameter sortFields
and use sort fields of the form "field ASC" or "field DESC".DOException
java.io.IOException
@Deprecated public Repository.QueryResults search(java.lang.String query, java.util.List<java.lang.String> returnedFields, java.util.List<java.lang.String> sortFields, java.lang.String sortOrder, int pageSize, int pageOffset, HeaderSet params) throws DOException, java.io.IOException
sortOrder
for all fields. Instead use parameter sortFields
and use sort fields of the form "field ASC" or "field DESC".DOException
java.io.IOException
public Repository.QueryResults search(java.lang.String query, HeaderSet params) throws DOException, java.io.IOException
DOException
java.io.IOException