|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface provides methods for initializing and logging in to a Metacat server, and then querying, reading, transforming, inserting, updating and deleting documents from that server.
Method Summary | |
java.lang.String |
delete(java.lang.String docid)
Delete an XML document in the repository. |
int |
getNewestDocRevision(java.lang.String docId)
The method will return the lasted revision in metacat server for a given document id. |
java.lang.String |
getSessionId()
Get the session identifier for this session. |
java.lang.String |
insert(java.lang.String docid,
java.io.Reader xmlDocument,
java.io.Reader schema)
Insert an XML document into the repository. |
java.lang.String |
login(java.lang.String username,
java.lang.String password)
Method used to log in to a metacat server. |
java.lang.String |
logout()
Method used to log out a metacat server. |
java.io.Reader |
query(java.io.Reader xmlQuery)
Query the metacat document store with the given metacat-compatible query document, and return the result set as a Reader. |
java.io.Reader |
read(java.lang.String docid)
Read an XML document from the metacat server session, accessed by docid, and returned as a Reader. |
java.io.Reader |
readInlineData(java.lang.String inlinedataid)
Read inline data from the metacat server session, accessed by inlinedataid, and returned as a Reader. |
java.lang.String |
setAccess(java.lang.String _docid,
java.lang.String _principal,
java.lang.String _permission,
java.lang.String _permType,
java.lang.String _permOrder)
set the access on an XML document in the repository. |
void |
setMetacatUrl(java.lang.String metacatUrl)
When the MetacatFactory creates an instance it needs to set the MetacatUrl to which connections should be made. |
void |
setSessionId(java.lang.String sessionId)
Set the session identifier for this session. |
java.lang.String |
update(java.lang.String docid,
java.io.Reader xmlDocument,
java.io.Reader schema)
Update an XML document in the repository. |
java.lang.String |
upload(java.lang.String docid,
java.io.File file)
Upload an XML document into the repository. |
java.lang.String |
upload(java.lang.String docid,
java.lang.String fileName,
java.io.InputStream fileData,
int size)
Upload an XML document into the repository. |
Method Detail |
public java.lang.String login(java.lang.String username, java.lang.String password) throws MetacatAuthException, MetacatInaccessibleException
username
- the username of the user, like an LDAP DNpassword
- the password for that user for authentication
MetacatAuthException
- when the username/password could
not be authenticated
MetacatInaccessibleException
public java.lang.String logout() throws MetacatInaccessibleException, MetacatException
MetacatInaccessibleException
- when the metacat server can not be
reached or does not respond
MetacatException
public java.io.Reader read(java.lang.String docid) throws InsufficientKarmaException, MetacatInaccessibleException, MetacatException
docid
- the identifier of the document to be read
InsufficientKarmaException
- when the user has insufficent rights
for the operation
MetacatInaccessibleException
- when the metacat server can not be
reached or does not respond
MetacatException
- when the metacat server generates another errorpublic java.io.Reader readInlineData(java.lang.String inlinedataid) throws InsufficientKarmaException, MetacatInaccessibleException, MetacatException
inlinedataid
- the identifier of the document to be read
InsufficientKarmaException
- when the user has insufficent rights
for the operation
MetacatInaccessibleException
- when the metacat server can not be
reached or does not respond
MetacatException
- when the metacat server generates another errorpublic java.io.Reader query(java.io.Reader xmlQuery) throws MetacatInaccessibleException, java.io.IOException
xmlQuery
- a Reader for accessing the XML version of the query
MetacatInaccessibleException
java.io.IOException
public java.lang.String insert(java.lang.String docid, java.io.Reader xmlDocument, java.io.Reader schema) throws InsufficientKarmaException, MetacatException, java.io.IOException, MetacatInaccessibleException
docid
- the docid to insert the documentxmlDocument
- a Reader for accessing the XML document to be insertedschema
- a Reader for accessing the DTD or XML Schema for
the document
InsufficientKarmaException
- when the user has insufficent rights
for the operation
MetacatInaccessibleException
- when the metacat server can not be
reached or does not respond
MetacatException
- when the metacat server generates another error
java.io.IOException
- when there is an error reading the xml documentpublic java.lang.String update(java.lang.String docid, java.io.Reader xmlDocument, java.io.Reader schema) throws InsufficientKarmaException, MetacatException, java.io.IOException, MetacatInaccessibleException
docid
- the docid to updatexmlDocument
- a Reader for accessing the XML text to be updatedschema
- a Reader for accessing the DTD or XML Schema for
the document
InsufficientKarmaException
- when the user has insufficent rights
for the operation
MetacatInaccessibleException
- when the metacat server can not be
reached or does not respond
MetacatException
- when the metacat server generates another error
java.io.IOException
- when there is an error reading the xml documentpublic java.lang.String upload(java.lang.String docid, java.io.File file) throws InsufficientKarmaException, MetacatException, java.io.IOException, MetacatInaccessibleException
docid
- the docid to insert the document
InsufficientKarmaException
- when the user has insufficent rights
for the operation
MetacatInaccessibleException
- when the metacat server can not be
reached or does not respond
MetacatException
- when the metacat server generates another error
java.io.IOException
- when there is an error reading the xml documentpublic java.lang.String upload(java.lang.String docid, java.lang.String fileName, java.io.InputStream fileData, int size) throws InsufficientKarmaException, MetacatException, java.io.IOException, MetacatInaccessibleException
docid
- the docid to insert the documentfileName
- the name of the documentfileData
- InputStream of the document that has to be insertedsize
- size of the data being sent. If more data is
found in the InputStream, an error would be reported.
InsufficientKarmaException
- when the user has insufficent rights
for the operation
MetacatInaccessibleException
- when the metacat server can not be
reached or does not respond
MetacatException
- when the metacat server generates another error
java.io.IOException
- when there is an error reading the xml documentpublic java.lang.String delete(java.lang.String docid) throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException
docid
- the docid to delete
InsufficientKarmaException
- when the user has insufficent rights
for the operation
MetacatInaccessibleException
- when the metacat server can not be
reached or does not respond
MetacatException
- when the metacat server generates another errorpublic java.lang.String setAccess(java.lang.String _docid, java.lang.String _principal, java.lang.String _permission, java.lang.String _permType, java.lang.String _permOrder) throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException
_docid
- the docid of the document for which the access should be applied._principal
- the document's principal_permission
- the access permission to be applied to the docid
{e.g. read,write,all}_permType
- the permission type to be applied to the document
{e.g. allow or deny}_permOrder
- the order that the document's permissions should be
processed {e.g. denyFirst or allowFirst}
InsufficientKarmaException
- when the user has insufficent rights
for the operation
MetacatInaccessibleException
- when the metacat server can not be
reached or does not respond
MetacatException
- when the metacat server generates another errorpublic void setMetacatUrl(java.lang.String metacatUrl)
metacatUrl
- the URL for the metacat serverpublic java.lang.String getSessionId()
public void setSessionId(java.lang.String sessionId)
public int getNewestDocRevision(java.lang.String docId) throws MetacatException
docId
- String the given docid you want to use. the docid it self
can have or haven't revision number
MetacatException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |