|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Admin
Method Summary | |
---|---|
String |
connect(String userId,
String password)
Create a new user session. |
void |
copyCollection(String sessionId,
String collectionPath,
String destinationPath,
String newName)
Copy a collection to the destination collection and rename it. |
void |
copyResource(String sessionId,
String docPath,
String destinationPath,
String newName)
Copy a resource to the destination collection and rename it. |
boolean |
createCollection(String sessionId,
String path)
Create a new collection using the specified path. |
void |
disconnect(String sessionId)
Release a user session. |
byte[] |
getBinaryResource(String sessionId,
String name)
Retrieve a binary resource from the database |
CollectionDesc |
getCollectionDesc(String sessionId,
String collectionName)
Obtain a description of the specified collection. |
Strings |
getGroups(String sessionId)
Obtain a list of the defined database groups |
IndexedElements |
getIndexedElements(String sessionId,
String collectionName,
boolean inclusive)
Return a list of Indexed Elements for a collection |
Permissions |
getPermissions(String sessionId,
String resource)
Return the permissions of the specified collection/document |
UserDesc |
getUser(String sessionId,
String user)
Obtain information about an eXist user. |
UserDescs |
getUsers(String sessionId)
Get an list of users |
String |
hasUserLock(String sessionId,
String path)
Return the name of the user owning the lock on the specified resource |
EntityPermissionsList |
listCollectionPermissions(String sessionId,
String name)
Return a list of the permissions of the child collections of the specified parent collection |
EntityPermissionsList |
listDocumentPermissions(String sessionId,
String name)
Return a list of the permissions of the child documents of the specified parent collection |
void |
lockResource(String sessionId,
String path,
String userName)
Place a write lock on the specified resource |
void |
moveCollection(String sessionId,
String collectionPath,
String destinationPath,
String newName)
Move a collection and its contents. |
void |
moveResource(String sessionId,
String docPath,
String destinationPath,
String newName)
Move a resource. |
boolean |
removeCollection(String sessionId,
String path)
Remove the specified collection. |
boolean |
removeDocument(String sessionId,
String path)
Remove the specified document. |
void |
removeUser(String sessionId,
String name)
Remove an eXist user account. |
void |
setPermissions(String sessionId,
String resource,
String owner,
String ownerGroup,
int permissions)
Set the owner, group and access permissions for a document or collection |
void |
setUser(String sessionId,
String name,
String password,
Strings groups,
String home)
Create a new user. |
void |
store(String sessionId,
byte[] data,
String encoding,
String path,
boolean replace)
Store a new document into the database. |
void |
storeBinary(String sessionId,
byte[] data,
String path,
String mimeType,
boolean replace)
Store a binary resource in the database |
void |
unlockResource(String sessionId,
String path)
Release the lock on the specified resource |
int |
xupdate(String sessionId,
String collectionName,
String xupdate)
Apply a set of XUpdate modifications to a collection. |
int |
xupdateResource(String sessionId,
String documentName,
String xupdate)
Apply a set of XUpdate modifications to the specified document. |
Method Detail |
---|
void store(String sessionId, byte[] data, String encoding, String path, boolean replace) throws 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?
RemoteException
String connect(String userId, String password) throws RemoteException
userId
- password
-
RemoteException
- if the user cannot log invoid disconnect(String sessionId) throws RemoteException
sessionId
- a valid session id as returned by connect().
RemoteException
boolean removeCollection(String sessionId, String path) throws RemoteException
sessionId
- sessionId a unique id for the created session.path
- the full path to the collection.
RemoteException
boolean removeDocument(String sessionId, String path) throws RemoteException
sessionId
- a unique id for the created session.path
- the full path to the document.
RemoteException
boolean createCollection(String sessionId, String path) throws RemoteException
sessionId
- a unique id for the created session.path
- the full path to the collection.
RemoteException
int xupdate(String sessionId, String collectionName, String xupdate) throws RemoteException
sessionId
- a unique id for the created session.collectionName
- the full path to the collection.xupdate
- the XUpdate document to be applied.
RemoteException
int xupdateResource(String sessionId, String documentName, String xupdate) throws RemoteException
sessionId
- a unique id for the created session.documentName
- the full path to the document.xupdate
- the XUpdate document to be applied.
RemoteException
byte[] getBinaryResource(String sessionId, String name) throws RemoteException
sessionId
- the session identifiername
- the name of the binary resource
RemoteException
CollectionDesc getCollectionDesc(String sessionId, String collectionName) throws RemoteException
sessionId
- the session identifiercollectionName
- the collection
RemoteException
void setPermissions(String sessionId, String resource, String owner, String ownerGroup, int permissions) throws RemoteException
sessionId
- the session idresource
- the document/collection that will get new permissionsowner
- the new ownerownerGroup
- the new grouppermissions
- the new access permissions
RemoteException
void copyResource(String sessionId, String docPath, String destinationPath, String newName) throws RemoteException
sessionId
- the session identifierdocPath
- the resource to copdestinationPath
- the destination collectionnewName
- the new name for the resource
RemoteException
void copyCollection(String sessionId, String collectionPath, String destinationPath, String newName) throws RemoteException
sessionId
- the session identifiercollectionPath
- the collection to renamedestinationPath
- the destination collectionnewName
- the new name of the collection.
RemoteException
void setUser(String sessionId, String name, String password, Strings groups, String home) throws 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
RemoteException
UserDesc getUser(String sessionId, String user) throws RemoteException
sessionId
- the session identifieruser
- the user
RemoteException
- if user doesn't existvoid removeUser(String sessionId, String name) throws RemoteException
sessionId
- the session identifiername
- the name of the user
RemoteException
UserDescs getUsers(String sessionId) throws RemoteException
sessionId
- the session identifier
RemoteException
Strings getGroups(String sessionId) throws RemoteException
sessionId
- the session identifier
RemoteException
void moveCollection(String sessionId, String collectionPath, String destinationPath, String newName) throws RemoteException
sessionId
- the session isentifiercollectionPath
- the collection to movedestinationPath
- the new parent collectionnewName
- the new collection name
RemoteException
void moveResource(String sessionId, String docPath, String destinationPath, String newName) throws RemoteException
sessionId
- the session identifierdocPath
- the resource to movedestinationPath
- the collection to receive the moved resourcenewName
- the new name for the resource
RemoteException
void lockResource(String sessionId, String path, String userName) throws RemoteException
sessionId
- the session identifierpath
- the path of the resource to lockuserName
- the user name of the lock owner
RemoteException
void unlockResource(String sessionId, String path) throws RemoteException
sessionId
- the session identifierpath
- path of the resource to unlock
RemoteException
String hasUserLock(String sessionId, String path) throws RemoteException
sessionId
- the session identifierpath
- the resource
RemoteException
Permissions getPermissions(String sessionId, String resource) throws RemoteException
sessionId
- the session identifierresource
- the collection or document
RemoteException
EntityPermissionsList listCollectionPermissions(String sessionId, String name) throws RemoteException
sessionId
- the session identifiername
- the name of the parent collection
RemoteException
EntityPermissionsList listDocumentPermissions(String sessionId, String name) throws RemoteException
sessionId
- the session identifiername
- name of the parent collection
RemoteException
IndexedElements getIndexedElements(String sessionId, String collectionName, boolean inclusive) throws RemoteException
sessionId
- the session identifiercollectionName
- the collection nameinclusive
- include sub-collections ?
RemoteException
void storeBinary(String sessionId, byte[] data, String path, String mimeType, boolean replace) throws 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
RemoteException
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |