|
|||||||||||
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. |
java.lang.String |
insert(java.lang.String docid,
java.lang.String xmlDocument,
java.lang.String schema)
Insert an XML document into the repository. |
void |
login(java.lang.String username,
java.lang.String password)
Method used to log in to a metacat server. |
void |
logout()
Method used to log out a metacat server. |
java.lang.String |
query(java.lang.String xmlQuery)
Query the metacat document store with the given metacat-compatible query document, and return the result set as a String |
java.lang.String |
read(java.lang.String docid)
Read an XML document from the metacat server session, accessed by docid, and returned as a String. |
void |
setMetacatUrl(java.lang.String metacatUrl)
When the MetacatFactory creates an instance it needs to set the MetacatUrl to which connections should be made. |
java.lang.String |
update(java.lang.String docid,
java.lang.String xmlDocument,
java.lang.String schema)
Update an XML document in the repository. |
Method Detail |
public void login(java.lang.String username, java.lang.String password)
username
- the username of the user, like an LDAP DNpassword
- the password for that user for authenticationpublic void logout()
MetacatInaccessibleException
- when the metacat server can not be
reached or does not respondpublic java.lang.String read(java.lang.String docid)
docid
- the identifier of the document to be read
public java.lang.String query(java.lang.String xmlQuery)
public java.lang.String insert(java.lang.String docid, java.lang.String xmlDocument, java.lang.String schema)
docid
- the docid to insert the documentxmlDocument
- a String for accessing the XML document to be insertedschema
- a String for accessing the DTD or XML Schema for
the document
public java.lang.String update(java.lang.String docid, java.lang.String xmlDocument, java.lang.String schema)
docid
- the docid to updatexmlDocument
- a String for accessing the XML text to be updatedschema
- a String for accessing the DTD or XML Schema for
the document
public java.lang.String delete(java.lang.String docid)
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 void setMetacatUrl(java.lang.String metacatUrl)
metacatUrl
- the URL for the metacat server
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |