|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface defines eXist's SOAP service for write operations on the database.
Method Summary | |
java.lang.String |
connect(java.lang.String user,
java.lang.String password)
Create a new user session. |
boolean |
createCollection(java.lang.String sessionId,
java.lang.String path)
Create a new collection using the specified path. |
void |
disconnect(java.lang.String sessionId)
Release a user session. |
boolean |
removeCollection(java.lang.String sessionId,
java.lang.String path)
Remove the specified collection. |
boolean |
removeDocument(java.lang.String sessionId,
java.lang.String path)
Remove the specified document. |
void |
store(java.lang.String sessionId,
byte[] data,
java.lang.String encoding,
java.lang.String path,
boolean replace)
Store a new document into the database. |
int |
xupdate(java.lang.String sessionId,
java.lang.String collectionName,
java.lang.String xupdate)
Apply a set of XUpdate modifications to a collection. |
int |
xupdateResource(java.lang.String sessionId,
java.lang.String documentName,
java.lang.String xupdate)
Apply a set of XUpdate modifications to the specified document. |
Method Detail |
public java.lang.String connect(java.lang.String user, java.lang.String password) throws java.rmi.RemoteException
user
- password
-
java.rmi.RemoteException
- if the user cannot log inpublic void disconnect(java.lang.String sessionId) throws java.rmi.RemoteException
sessionId
- a valid session id as returned by connect().
java.rmi.RemoteException
public void store(java.lang.String sessionId, byte[] data, java.lang.String encoding, java.lang.String path, boolean replace) throws java.rmi.RemoteException
sessionId
- a unique id for the created session.data
- the document contents as base64 encoded binary data.encoding
- the character encoding used for the document data.path
- the target path for the new document.replace
- should an existing document be replaced?
java.rmi.RemoteException
public boolean removeCollection(java.lang.String sessionId, java.lang.String path) throws java.rmi.RemoteException
sessionId
- sessionId a unique id for the created session.path
- the full path to the collection.
java.rmi.RemoteException
public boolean removeDocument(java.lang.String sessionId, java.lang.String path) throws java.rmi.RemoteException
sessionId
- a unique id for the created session.path
- the full path to the document.
java.rmi.RemoteException
public boolean createCollection(java.lang.String sessionId, java.lang.String path) throws java.rmi.RemoteException
sessionId
- a unique id for the created session.path
- the full path to the collection.
java.rmi.RemoteException
public int xupdate(java.lang.String sessionId, java.lang.String collectionName, java.lang.String xupdate) throws java.rmi.RemoteException
sessionId
- a unique id for the created session.collectionName
- the full path to the collection.xupdate
- the XUpdate document to be applied.
java.rmi.RemoteException
public int xupdateResource(java.lang.String sessionId, java.lang.String documentName, java.lang.String xupdate) throws java.rmi.RemoteException
sessionId
- a unique id for the created session.documentName
- the full path to the document.xupdate
- the XUpdate document to be applied.
java.rmi.RemoteException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |