|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines the methods callable through the XMLRPC interface.
Method Summary | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
boolean |
createCollection(User user,
java.lang.String name)
Create a new collection on the database. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
int |
executeQuery(User user,
byte[] xpath)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
int |
executeQuery(User user,
byte[] xpath,
java.lang.String encoding)
Execute XPath query and return a reference to the result set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
int |
executeQuery(User user,
java.lang.String xpath)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.util.Hashtable |
getCollectionDesc(User user,
java.lang.String rootCollection)
describe a collection This method will return a struct with the following fields:
shutdownpublic boolean shutdown(User user) throws PermissionDeniedException
syncpublic boolean sync(User user) getDocumentpublic byte[] getDocument(User user, java.lang.String name, java.lang.String encoding, int prettyPrint) throws EXistException, PermissionDeniedException
getDocumentpublic byte[] getDocument(User user, java.lang.String name, java.lang.String encoding, int prettyPrint, java.lang.String stylesheet) throws EXistException, PermissionDeniedException
getDocumentAsStringpublic java.lang.String getDocumentAsString(User user, java.lang.String name, int prettyPrint) throws EXistException, PermissionDeniedException getDocumentAsStringpublic java.lang.String getDocumentAsString(User user, java.lang.String name, int prettyPrint, java.lang.String stylesheet) throws EXistException, PermissionDeniedException hasDocumentpublic boolean hasDocument(User user, java.lang.String name) throws EXistException, PermissionDeniedException
getDocumentListingpublic java.util.Vector getDocumentListing(User user) throws EXistException, PermissionDeniedException
getDocumentListingpublic java.util.Vector getDocumentListing(User user, java.lang.String collection) throws EXistException, PermissionDeniedException
listDocumentPermissionspublic java.util.Hashtable listDocumentPermissions(User user, java.lang.String name) throws EXistException, PermissionDeniedException listCollectionPermissionspublic java.util.Hashtable listCollectionPermissions(User user, java.lang.String name) throws EXistException, PermissionDeniedException getCollectionDescpublic java.util.Hashtable getCollectionDesc(User user, java.lang.String rootCollection) throws EXistException, PermissionDeniedException
retrievepublic byte[] retrieve(User user, java.lang.String doc, java.lang.String id) throws EXistException, PermissionDeniedException
retrievepublic byte[] retrieve(User user, java.lang.String doc, java.lang.String id, int prettyPrint) throws EXistException, PermissionDeniedException
retrievepublic byte[] retrieve(User user, java.lang.String doc, java.lang.String id, int prettyPrint, java.lang.String encoding) throws EXistException, PermissionDeniedException
retrieveAsStringpublic java.lang.String retrieveAsString(User user, java.lang.String doc, java.lang.String id, int prettyPrint) throws EXistException, PermissionDeniedException querypublic java.util.Vector query(User user, java.lang.String xpath) throws EXistException, PermissionDeniedException
querypublic java.util.Vector query(User user, java.lang.String xpath, java.lang.String docId, java.lang.String s_id) throws EXistException, PermissionDeniedException querypublic java.util.Vector query(User user, byte[] xpath) throws EXistException, PermissionDeniedException queryPpublic java.util.Hashtable queryP(User user, byte[] xpath) throws EXistException, PermissionDeniedException queryPpublic java.util.Hashtable queryP(User user, byte[] xpath, byte[] sortExpr) throws EXistException, PermissionDeniedException queryPpublic java.util.Hashtable queryP(User user, byte[] xpath, java.lang.String docName, java.lang.String s_id, byte[] sortExpr) throws EXistException, PermissionDeniedException queryPpublic java.util.Hashtable queryP(User user, byte[] xpath, java.lang.String docName, java.lang.String s_id) throws EXistException, PermissionDeniedException querypublic java.lang.String query(User user, java.lang.String xpath, int howmany, int start, int prettyPrint) throws EXistException, PermissionDeniedException
querypublic java.lang.String query(User user, java.lang.String xpath, int howmany, int start, int prettyPrint, java.lang.String sortExpr) throws EXistException, PermissionDeniedException
querySummarypublic java.util.Hashtable querySummary(User user, java.lang.String xpath) throws EXistException, PermissionDeniedException
|
xpath
- Description of the Parameteruser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic boolean parse(User user, byte[] xmlData, java.lang.String docName) throws EXistException, PermissionDeniedException
docName
. Some xmlrpc clients seem to
have problems with character encodings when sending xml content. To
avoid this, parse() accepts the xml document content as byte[]. If
overwrite
is >0, an existing document with the same name
will be replaced by the new document.
xmlData
- Description of the ParameterdocName
- Description of the Parameteruser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic boolean parse(User user, byte[] xmlData, java.lang.String docName, int overwrite) throws EXistException, PermissionDeniedException
docName
. Some xmlrpc clients seem to
have problems with character encodings when sending xml content. To
avoid this, parse() accepts the xml document content as byte[]. If
overwrite
is >0, an existing document with the same name
will be replaced by the new document.
xmlData
- Description of the ParameterdocName
- Description of the Parameteroverwrite
- Description of the Parameteruser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic boolean parse(User user, java.lang.String xml, java.lang.String docName, int overwrite) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public boolean parse(User user, java.lang.String xml, java.lang.String docName) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public java.lang.String upload(User user, byte[] chunk, int length) throws EXistException, PermissionDeniedException
user
- chunk
- the current chunklength
- total length of the file
EXistException
PermissionDeniedException
public java.lang.String upload(User user, java.lang.String file, byte[] chunk, int length) throws EXistException, PermissionDeniedException
user
- chunk
- the current chunklength
- total length of the file
EXistException
PermissionDeniedException
public boolean parseLocal(User user, java.lang.String localFile, java.lang.String docName, boolean replace) throws EXistException, PermissionDeniedException, org.xml.sax.SAXException
user
- localFile
-
EXistException
IOException
PermissionDeniedException
org.xml.sax.SAXException
public boolean remove(User user, java.lang.String docName) throws EXistException, PermissionDeniedException
docName
- path to the document to be removeduser
-
EXistException
PermissionDeniedException
public boolean removeCollection(User user, java.lang.String name) throws EXistException, PermissionDeniedException
name
- path to the collection to be removed.user
-
EXistException
PermissionDeniedException
public boolean createCollection(User user, java.lang.String name) throws EXistException, PermissionDeniedException
user
- name
- the path to the new collection.
EXistException
PermissionDeniedException
public int executeQuery(User user, byte[] xpath, java.lang.String encoding) throws EXistException, PermissionDeniedException
xpath
- Description of the Parameterencoding
- Description of the Parameteruser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic int executeQuery(User user, byte[] xpath) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public int executeQuery(User user, java.lang.String xpath) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public java.util.Hashtable querySummary(User user, int resultId) throws EXistException, PermissionDeniedException
resultId
- Description of the Parameteruser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic java.util.Hashtable getPermissions(User user, java.lang.String resource) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public int getHits(User user, int resultId) throws EXistException, PermissionDeniedException
resultId
- Description of the Parameteruser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic byte[] retrieve(User user, int resultId, int num, int prettyPrint, java.lang.String encoding) throws EXistException, PermissionDeniedException
resultId
- Description of the Parameternum
- Description of the ParameterprettyPrint
- Description of the Parameterencoding
- Description of the Parameteruser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic boolean setUser(User user, java.lang.String name, java.lang.String passwd, java.util.Vector groups, java.lang.String home) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public boolean setUser(User user, java.lang.String name, java.lang.String passwd, java.util.Vector groups) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public boolean setPermissions(User user, java.lang.String resource, java.lang.String permissions) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public boolean setPermissions(User user, java.lang.String resource, int permissions) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public boolean setPermissions(User user, java.lang.String resource, java.lang.String owner, java.lang.String ownerGroup, java.lang.String permissions) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public boolean setPermissions(User user, java.lang.String resource, java.lang.String owner, java.lang.String ownerGroup, int permissions) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public java.util.Hashtable getUser(User user, java.lang.String name) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public java.util.Vector getUsers(User user) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public boolean removeUser(User user, java.lang.String name) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public java.util.Vector getGroups(User user) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public java.util.Vector getIndexedElements(User user, java.lang.String collectionName, boolean inclusive) throws EXistException, PermissionDeniedException
EXistException
PermissionDeniedException
public java.util.Vector scanIndexTerms(User user, java.lang.String collectionName, java.lang.String start, java.lang.String end, boolean inclusive) throws PermissionDeniedException, EXistException
PermissionDeniedException
EXistException
public void releaseQueryResult(int handle)
public int xupdate(User user, java.lang.String collectionName, byte[] xupdate) throws PermissionDeniedException, EXistException, org.xml.sax.SAXException
PermissionDeniedException
EXistException
org.xml.sax.SAXException
public int xupdateResource(User user, java.lang.String resource, byte[] xupdate) throws PermissionDeniedException, EXistException, org.xml.sax.SAXException
PermissionDeniedException
EXistException
org.xml.sax.SAXException
public java.util.Date getCreationDate(User user, java.lang.String collectionName) throws PermissionDeniedException, EXistException
PermissionDeniedException
EXistException
public java.util.Vector getTimestamps(User user, java.lang.String documentName) throws PermissionDeniedException, EXistException
PermissionDeniedException
EXistException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |