|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
java.lang.String |
connect(java.lang.String userId,
java.lang.String password)
Create a new user session. |
void |
copyCollection(java.lang.String sessionId,
java.lang.String collectionPath,
java.lang.String destinationPath,
java.lang.String newName)
Copy a collection to the destination collection and rename it. |
void |
copyResource(java.lang.String sessionId,
java.lang.String docPath,
java.lang.String destinationPath,
java.lang.String newName)
Copy a resource to the destination collection and rename it. |
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. |
byte[] |
getBinaryResource(java.lang.String sessionId,
java.lang.String name)
Retrieve a binary resource from the database |
CollectionDesc |
getCollectionDesc(java.lang.String sessionId,
java.lang.String collectionName)
Obtain a description of the specified collection. |
Strings |
getGroups(java.lang.String sessionId)
Obtain a list of the defined database groups |
IndexedElements |
getIndexedElements(java.lang.String sessionId,
java.lang.String collectionName,
boolean inclusive)
Return a list of Indexed Elements for a collection |
Permissions |
getPermissions(java.lang.String sessionId,
java.lang.String resource)
Return the permissions of the specified collection/document |
UserDesc |
getUser(java.lang.String sessionId,
java.lang.String user)
Obtain information about an eXist user. |
UserDescs |
getUsers(java.lang.String sessionId)
Get an list of users |
java.lang.String |
hasUserLock(java.lang.String sessionId,
java.lang.String path)
Return the name of the user owning the lock on the specified resource |
EntityPermissionsList |
listCollectionPermissions(java.lang.String sessionId,
java.lang.String name)
Return a list of the permissions of the child collections of the specified parent collection |
EntityPermissionsList |
listDocumentPermissions(java.lang.String sessionId,
java.lang.String name)
Return a list of the permissions of the child documents of the specified parent collection |
void |
lockResource(java.lang.String sessionId,
java.lang.String path,
java.lang.String userName)
Place a write lock on the specified resource |
void |
moveCollection(java.lang.String sessionId,
java.lang.String collectionPath,
java.lang.String destinationPath,
java.lang.String newName)
Move a collection and its contents. |
void |
moveResource(java.lang.String sessionId,
java.lang.String docPath,
java.lang.String destinationPath,
java.lang.String newName)
Move a resource. |
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 |
removeUser(java.lang.String sessionId,
java.lang.String name)
Remove an eXist user account. |
void |
setPermissions(java.lang.String sessionId,
java.lang.String resource,
java.lang.String owner,
java.lang.String ownerGroup,
int permissions)
Set the owner, group and access permissions for a document or collection |
void |
setUser(java.lang.String sessionId,
java.lang.String name,
java.lang.String password,
Strings groups,
java.lang.String home)
Create a new user. |
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. |
void |
storeBinary(java.lang.String sessionId,
byte[] data,
java.lang.String path,
java.lang.String mimeType,
boolean replace)
Store a binary resource in the database |
void |
unlockResource(java.lang.String sessionId,
java.lang.String path)
Release the lock on the specified resource |
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 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 java.lang.String connect(java.lang.String userId, java.lang.String password) throws java.rmi.RemoteException
userId
- 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 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
public byte[] getBinaryResource(java.lang.String sessionId, java.lang.String name) throws java.rmi.RemoteException
sessionId
- the session identifiername
- the name of the binary resource
java.rmi.RemoteException
public CollectionDesc getCollectionDesc(java.lang.String sessionId, java.lang.String collectionName) throws java.rmi.RemoteException
sessionId
- the session identifiercollectionName
- the collection
java.rmi.RemoteException
public void setPermissions(java.lang.String sessionId, java.lang.String resource, java.lang.String owner, java.lang.String ownerGroup, int permissions) throws java.rmi.RemoteException
sessionId
- the session idresource
- the document/collection that will get new permissionsowner
- the new ownerownerGroup
- the new grouppermissions
- the new access permissions
java.rmi.RemoteException
public void copyResource(java.lang.String sessionId, java.lang.String docPath, java.lang.String destinationPath, java.lang.String newName) throws java.rmi.RemoteException
sessionId
- the session identifierdocPath
- the resource to copdestinationPath
- the destination collectionnewName
- the new name for the resource
java.rmi.RemoteException
public void copyCollection(java.lang.String sessionId, java.lang.String collectionPath, java.lang.String destinationPath, java.lang.String newName) throws java.rmi.RemoteException
sessionId
- the session identifiercollectionPath
- the collection to renamedestinationPath
- the destination collectionnewName
- the new name of the collection.
java.rmi.RemoteException
public void setUser(java.lang.String sessionId, java.lang.String name, java.lang.String password, Strings groups, java.lang.String home) throws java.rmi.RemoteException
sessionId
- the session identifiername
- the name of the new userpassword
- the password for the new usergroups
- the new user should belong to these groups
java.rmi.RemoteException
public UserDesc getUser(java.lang.String sessionId, java.lang.String user) throws java.rmi.RemoteException
sessionId
- the session identifieruser
- the user
java.rmi.RemoteException
- if user doesn't existpublic void removeUser(java.lang.String sessionId, java.lang.String name) throws java.rmi.RemoteException
sessionId
- the session identifiername
- the name of the user
java.rmi.RemoteException
public UserDescs getUsers(java.lang.String sessionId) throws java.rmi.RemoteException
sessionId
- the session identifier
java.rmi.RemoteException
public Strings getGroups(java.lang.String sessionId) throws java.rmi.RemoteException
sessionId
- the session identifier
java.rmi.RemoteException
public void moveCollection(java.lang.String sessionId, java.lang.String collectionPath, java.lang.String destinationPath, java.lang.String newName) throws java.rmi.RemoteException
sessionId
- the session isentifiercollectionPath
- the collection to movedestinationPath
- the new parent collectionnewName
- the new collection name
java.rmi.RemoteException
public void moveResource(java.lang.String sessionId, java.lang.String docPath, java.lang.String destinationPath, java.lang.String newName) throws java.rmi.RemoteException
sessionId
- the session identifierdocPath
- the resource to movedestinationPath
- the collection to receive the moved resourcenewName
- the new name for the resource
java.rmi.RemoteException
public void lockResource(java.lang.String sessionId, java.lang.String path, java.lang.String userName) throws java.rmi.RemoteException
sessionId
- the session identifierpath
- the path of the resource to lockuserName
- the user name of the lock owner
java.rmi.RemoteException
public void unlockResource(java.lang.String sessionId, java.lang.String path) throws java.rmi.RemoteException
sessionId
- the session identifierpath
- path of the resource to unlock
java.rmi.RemoteException
public java.lang.String hasUserLock(java.lang.String sessionId, java.lang.String path) throws java.rmi.RemoteException
sessionId
- the session identifierpath
- the resource
java.rmi.RemoteException
public Permissions getPermissions(java.lang.String sessionId, java.lang.String resource) throws java.rmi.RemoteException
sessionId
- the session identifierresource
- the collection or document
java.rmi.RemoteException
public EntityPermissionsList listCollectionPermissions(java.lang.String sessionId, java.lang.String name) throws java.rmi.RemoteException
sessionId
- the session identifiername
- the name of the parent collection
java.rmi.RemoteException
public EntityPermissionsList listDocumentPermissions(java.lang.String sessionId, java.lang.String name) throws java.rmi.RemoteException
sessionId
- the session identifiername
- name of the parent collection
java.rmi.RemoteException
public IndexedElements getIndexedElements(java.lang.String sessionId, java.lang.String collectionName, boolean inclusive) throws java.rmi.RemoteException
sessionId
- the session identifiercollectionName
- the collection nameinclusive
- include sub-collections ?
java.rmi.RemoteException
public void storeBinary(java.lang.String sessionId, byte[] data, java.lang.String path, java.lang.String mimeType, boolean replace) throws java.rmi.RemoteException
sessionId
- the session identifierdata
- the binary datapath
- the path for the new resourcemimeType
- the mime type for the resourcereplace
- replace resource if it already exists
java.rmi.RemoteException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |