org.exist.xmlrpc
Interface RpcAPI

All Known Implementing Classes:
RpcServer

public interface RpcAPI

Defines the methods callable through the XMLRPC interface.

Author:
Wolfgang Meier

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: documents array of all document names contained in this collection.
 java.util.Date getCreationDate(User user, java.lang.String collectionName)
           
 byte[] getDocument(User user, java.lang.String name, java.lang.String encoding, int prettyPrint)
          Retrieve document by name.
 byte[] getDocument(User user, java.lang.String name, java.lang.String encoding, int prettyPrint, java.lang.String stylesheet)
          Retrieve document by name.
 java.lang.String getDocumentAsString(User user, java.lang.String name, int prettyPrint)
           
 java.lang.String getDocumentAsString(User user, java.lang.String name, int prettyPrint, java.lang.String stylesheet)
           
 java.util.Vector getDocumentListing(User user)
          Get a list of all documents contained in the database.
 java.util.Vector getDocumentListing(User user, java.lang.String collection)
          Get a list of all documents contained in the collection.
 java.util.Vector getGroups(User user)
           
 int getHits(User user, int resultId)
          Get the number of hits in the result set identified by it's result-set-id.
 java.util.Vector getIndexedElements(User user, java.lang.String collectionName, boolean inclusive)
           
 java.util.Hashtable getPermissions(User user, java.lang.String resource)
           
 java.util.Vector getTimestamps(User user, java.lang.String documentName)
           
 java.util.Hashtable getUser(User user, java.lang.String name)
           
 java.util.Vector getUsers(User user)
           
 boolean hasDocument(User user, java.lang.String name)
          Does the document identified by name exist in the repository?
 java.util.Hashtable listCollectionPermissions(User user, java.lang.String name)
           
 java.util.Hashtable listDocumentPermissions(User user, java.lang.String name)
           
 boolean parse(User user, byte[] xmlData, java.lang.String docName)
          Parse an XML document and store it into the database.
 boolean parse(User user, byte[] xmlData, java.lang.String docName, int overwrite)
          parse an XML document and store it into the database.
 boolean parse(User user, java.lang.String xml, java.lang.String docName)
           
 boolean parse(User user, java.lang.String xml, java.lang.String docName, int overwrite)
           
 boolean parseLocal(User user, java.lang.String localFile, java.lang.String docName, boolean replace)
          Parse a file previously uploaded with upload.
 java.util.Vector query(User user, byte[] xpath)
           
 java.util.Vector query(User user, java.lang.String xpath)
          Execute XPath query and return a list of results.
 java.lang.String query(User user, java.lang.String xpath, int howmany, int start, int prettyPrint)
          execute XPath query and return the resulting node set as a new document.
 java.lang.String query(User user, java.lang.String xpath, int howmany, int start, int prettyPrint, java.lang.String sortExpr)
          execute XPath query and return howmany nodes from the result set, starting at position start.
 java.util.Vector query(User user, java.lang.String xpath, java.lang.String docId, java.lang.String s_id)
           
 java.util.Hashtable queryP(User user, byte[] xpath)
           
 java.util.Hashtable queryP(User user, byte[] xpath, byte[] sortExpr)
           
 java.util.Hashtable queryP(User user, byte[] xpath, java.lang.String docName, java.lang.String s_id)
           
 java.util.Hashtable queryP(User user, byte[] xpath, java.lang.String docName, java.lang.String s_id, byte[] sortExpr)
           
 java.util.Hashtable querySummary(User user, int resultId)
          Retrieve a summary of the result set identified by it's result-set-id.
 java.util.Hashtable querySummary(User user, java.lang.String xpath)
          execute XPath query and return a summary of hits per document and hits per doctype.
 void releaseQueryResult(int handle)
           
 boolean remove(User user, java.lang.String docName)
          Remove a document from the database.
 boolean removeCollection(User user, java.lang.String name)
          Remove an entire collection from the database.
 boolean removeUser(User user, java.lang.String name)
           
 byte[] retrieve(User user, int resultId, int num, int prettyPrint, java.lang.String encoding)
          Retrieve a single result from the result-set identified by resultId.
 byte[] retrieve(User user, java.lang.String doc, java.lang.String id)
          Retrieve a single node from a document.
 byte[] retrieve(User user, java.lang.String doc, java.lang.String id, int prettyPrint)
          retrieve a single node from a document.
 byte[] retrieve(User user, java.lang.String doc, java.lang.String id, int prettyPrint, java.lang.String encoding)
          Retrieve a single node from a document.
 java.lang.String retrieveAsString(User user, java.lang.String doc, java.lang.String id, int prettyPrint)
           
 java.util.Vector scanIndexTerms(User user, java.lang.String collectionName, java.lang.String start, java.lang.String end, boolean inclusive)
           
 boolean setPermissions(User user, java.lang.String resource, int permissions)
           
 boolean setPermissions(User user, java.lang.String resource, java.lang.String permissions)
           
 boolean setPermissions(User user, java.lang.String resource, java.lang.String owner, java.lang.String ownerGroup, int permissions)
           
 boolean setPermissions(User user, java.lang.String resource, java.lang.String owner, java.lang.String ownerGroup, java.lang.String permissions)
           
 boolean setUser(User user, java.lang.String name, java.lang.String passwd, java.util.Vector groups)
           
 boolean setUser(User user, java.lang.String name, java.lang.String passwd, java.util.Vector groups, java.lang.String home)
           
 boolean shutdown(User user)
          Shut down the database.
 boolean sync(User user)
           
 java.lang.String upload(User user, byte[] chunk, int length)
          An alternative to parse() for larger XML documents.
 java.lang.String upload(User user, java.lang.String file, byte[] chunk, int length)
          An alternative to parse() for larger XML documents.
 int xupdate(User user, java.lang.String collectionName, byte[] xupdate)
           
 int xupdateResource(User user, java.lang.String resource, byte[] xupdate)
           
 

Method Detail

shutdown

public boolean shutdown(User user)
                 throws PermissionDeniedException
Shut down the database.

Returns:
boolean
Throws:
PermissionDeniedException

sync

public boolean sync(User user)

getDocument

public byte[] getDocument(User user,
                          java.lang.String name,
                          java.lang.String encoding,
                          int prettyPrint)
                   throws EXistException,
                          PermissionDeniedException
Retrieve document by name. XML content is indented if prettyPrint is set to >=0. Use supplied encoding for output. This method is provided to retrieve a document with encodings other than UTF-8. Since the data is handled as binary data, character encodings are preserved. byte[]-values are automatically BASE64-encoded by the XMLRPC library.

Parameters:
name - the document's name.
prettyPrint - pretty print XML if >0.
encoding - character encoding to use.
user -
Returns:
Document data as binary array.
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

getDocument

public byte[] getDocument(User user,
                          java.lang.String name,
                          java.lang.String encoding,
                          int prettyPrint,
                          java.lang.String stylesheet)
                   throws EXistException,
                          PermissionDeniedException
Retrieve document by name. XML content is indented if prettyPrint is set to >=0. Use supplied encoding for output and apply the specified stylesheet. This method is provided to retrieve a document with encodings other than UTF-8. Since the data is handled as binary data, character encodings are preserved. byte[]-values are automatically BASE64-encoded by the XMLRPC library.

Parameters:
name - the document's name.
prettyPrint - pretty print XML if >0.
encoding - character encoding to use.
user - Description of the Parameter
Returns:
The document value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

getDocumentAsString

public java.lang.String getDocumentAsString(User user,
                                            java.lang.String name,
                                            int prettyPrint)
                                     throws EXistException,
                                            PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

getDocumentAsString

public java.lang.String getDocumentAsString(User user,
                                            java.lang.String name,
                                            int prettyPrint,
                                            java.lang.String stylesheet)
                                     throws EXistException,
                                            PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

hasDocument

public boolean hasDocument(User user,
                           java.lang.String name)
                    throws EXistException,
                           PermissionDeniedException
Does the document identified by name exist in the repository?

Parameters:
name - Description of the Parameter
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

getDocumentListing

public java.util.Vector getDocumentListing(User user)
                                    throws EXistException,
                                           PermissionDeniedException
Get a list of all documents contained in the database.

Parameters:
user -
Returns:
list of document paths
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

getDocumentListing

public java.util.Vector getDocumentListing(User user,
                                           java.lang.String collection)
                                    throws EXistException,
                                           PermissionDeniedException
Get a list of all documents contained in the collection.

Parameters:
collection - the collection to use.
user - Description of the Parameter
Returns:
list of document paths
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

listDocumentPermissions

public java.util.Hashtable listDocumentPermissions(User user,
                                                   java.lang.String name)
                                            throws EXistException,
                                                   PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

listCollectionPermissions

public java.util.Hashtable listCollectionPermissions(User user,
                                                     java.lang.String name)
                                              throws EXistException,
                                                     PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

getCollectionDesc

public java.util.Hashtable getCollectionDesc(User user,
                                             java.lang.String rootCollection)
                                      throws EXistException,
                                             PermissionDeniedException
describe a collection This method will return a struct with the following fields:
documents array of all document names contained in this collection.
collections an array containing the names of all subcollections in this collection.
name the collection's name

Parameters:
rootCollection - Description of the Parameter
user - Description of the Parameter
Returns:
The collectionDesc value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

retrieve

public byte[] retrieve(User user,
                       java.lang.String doc,
                       java.lang.String id)
                throws EXistException,
                       PermissionDeniedException
Retrieve a single node from a document. The node is identified by it's internal id.

Parameters:
doc - the document containing the node
id - the node's internal id
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

retrieve

public byte[] retrieve(User user,
                       java.lang.String doc,
                       java.lang.String id,
                       int prettyPrint)
                throws EXistException,
                       PermissionDeniedException
retrieve a single node from a document. The node is identified by it's internal id.

Parameters:
doc - the document containing the node
id - the node's internal id
prettyPrint - result is pretty printed if >0
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

retrieve

public byte[] retrieve(User user,
                       java.lang.String doc,
                       java.lang.String id,
                       int prettyPrint,
                       java.lang.String encoding)
                throws EXistException,
                       PermissionDeniedException
Retrieve a single node from a document. The node is identified by it's internal id.

Parameters:
doc - the document containing the node
id - the node's internal id
prettyPrint - result is pretty printed if >0
encoding - character encoding to use
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

retrieveAsString

public java.lang.String retrieveAsString(User user,
                                         java.lang.String doc,
                                         java.lang.String id,
                                         int prettyPrint)
                                  throws EXistException,
                                         PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

query

public java.util.Vector query(User user,
                              java.lang.String xpath)
                       throws EXistException,
                              PermissionDeniedException
Execute XPath query and return a list of results. If the result is a node set, it will be returned as array of String[][2], which represents a two dimensional table. Every row in this table consists of a document-name / node-id pair. e.g.:
hamlet.xml 8398
hamlet.xml 8399

You may use this information with the retrieve-call to retrieve the actual nodes.

Otherwise, if the result is a set of values, each value will be converted to string. In this case the return type is an array of strings String[].

Parameters:
xpath - the XPath query to execute.
user -
Returns:
string[][2], if result is a node set, string[] otherwise.
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

query

public java.util.Vector query(User user,
                              java.lang.String xpath,
                              java.lang.String docId,
                              java.lang.String s_id)
                       throws EXistException,
                              PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

query

public java.util.Vector query(User user,
                              byte[] xpath)
                       throws EXistException,
                              PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

queryP

public java.util.Hashtable queryP(User user,
                                  byte[] xpath)
                           throws EXistException,
                                  PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

queryP

public java.util.Hashtable queryP(User user,
                                  byte[] xpath,
                                  byte[] sortExpr)
                           throws EXistException,
                                  PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

queryP

public java.util.Hashtable queryP(User user,
                                  byte[] xpath,
                                  java.lang.String docName,
                                  java.lang.String s_id,
                                  byte[] sortExpr)
                           throws EXistException,
                                  PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

queryP

public java.util.Hashtable queryP(User user,
                                  byte[] xpath,
                                  java.lang.String docName,
                                  java.lang.String s_id)
                           throws EXistException,
                                  PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

query

public java.lang.String query(User user,
                              java.lang.String xpath,
                              int howmany,
                              int start,
                              int prettyPrint)
                       throws EXistException,
                              PermissionDeniedException
execute XPath query and return the resulting node set as a new document. howmany nodes will be included, starting at position start. If prettyPrint is set to >0 (true), results are pretty printed.

Parameters:
xpath - the XPath query to execute
howmany - maximum number of results to return.
start - item in the result set to start with.
prettyPrint - turn on pretty printing if >0.
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

query

public java.lang.String query(User user,
                              java.lang.String xpath,
                              int howmany,
                              int start,
                              int prettyPrint,
                              java.lang.String sortExpr)
                       throws EXistException,
                              PermissionDeniedException
execute XPath query and return howmany nodes from the result set, starting at position start. If prettyPrint is set to >0 (true), results are pretty printed.

Parameters:
xpath - the XPath query to execute
howmany - maximum number of results to return.
start - item in the result set to start with.
prettyPrint - turn on pretty printing if >0.
sortExpr - Description of the Parameter
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

querySummary

public java.util.Hashtable querySummary(User user,
                                        java.lang.String xpath)
                                 throws EXistException,
                                        PermissionDeniedException
execute XPath query and return a summary of hits per document and hits per doctype. This method returns a struct with the following fields:
"queryTime" int
"hits" int
"documents" array of array: Object[][3]
"doctypes" array of array: Object[][2]
Documents and doctypes represent tables where each row describes one document or doctype for which hits were found. Each document entry has the following structure: docId (int), docName (string), hits (int) The doctype entry has this structure: doctypeName (string), hits (int)

Parameters:
xpath - Description of the Parameter
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

parse

public boolean parse(User user,
                     byte[] xmlData,
                     java.lang.String docName)
              throws EXistException,
                     PermissionDeniedException
Parse an XML document and store it into the database. The document will later be identified by 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.

Parameters:
xmlData - Description of the Parameter
docName - Description of the Parameter
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

parse

public boolean parse(User user,
                     byte[] xmlData,
                     java.lang.String docName,
                     int overwrite)
              throws EXistException,
                     PermissionDeniedException
parse an XML document and store it into the database. The document will later be identified by 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.

Parameters:
xmlData - Description of the Parameter
docName - Description of the Parameter
overwrite - Description of the Parameter
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

parse

public boolean parse(User user,
                     java.lang.String xml,
                     java.lang.String docName,
                     int overwrite)
              throws EXistException,
                     PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

parse

public boolean parse(User user,
                     java.lang.String xml,
                     java.lang.String docName)
              throws EXistException,
                     PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

upload

public java.lang.String upload(User user,
                               byte[] chunk,
                               int length)
                        throws EXistException,
                               PermissionDeniedException
An alternative to parse() for larger XML documents. The document is first uploaded chunk by chunk using upload(), then parseLocal() is called to actually store the uploaded file.

Parameters:
user -
chunk - the current chunk
length - total length of the file
Returns:
Throws:
EXistException
PermissionDeniedException

upload

public java.lang.String upload(User user,
                               java.lang.String file,
                               byte[] chunk,
                               int length)
                        throws EXistException,
                               PermissionDeniedException
An alternative to parse() for larger XML documents. The document is first uploaded chunk by chunk using upload(), then parseLocal() is called to actually store the uploaded file.

Parameters:
user -
chunk - the current chunk
length - total length of the file
Returns:
Throws:
EXistException
PermissionDeniedException

parseLocal

public boolean parseLocal(User user,
                          java.lang.String localFile,
                          java.lang.String docName,
                          boolean replace)
                   throws EXistException,
                          PermissionDeniedException,
                          org.xml.sax.SAXException
Parse a file previously uploaded with upload. The temporary file will be removed.

Parameters:
user -
localFile -
Throws:
EXistException
IOException
PermissionDeniedException
org.xml.sax.SAXException

remove

public boolean remove(User user,
                      java.lang.String docName)
               throws EXistException,
                      PermissionDeniedException
Remove a document from the database.

Parameters:
docName - path to the document to be removed
user -
Returns:
true on success.
Throws:
EXistException
PermissionDeniedException

removeCollection

public boolean removeCollection(User user,
                                java.lang.String name)
                         throws EXistException,
                                PermissionDeniedException
Remove an entire collection from the database.

Parameters:
name - path to the collection to be removed.
user -
Returns:
Throws:
EXistException
PermissionDeniedException

createCollection

public boolean createCollection(User user,
                                java.lang.String name)
                         throws EXistException,
                                PermissionDeniedException
Create a new collection on the database.

Parameters:
user -
name - the path to the new collection.
Returns:
Throws:
EXistException
PermissionDeniedException

executeQuery

public int executeQuery(User user,
                        byte[] xpath,
                        java.lang.String encoding)
                 throws EXistException,
                        PermissionDeniedException
Execute XPath query and return a reference to the result set. The returned reference may be used later to get a summary of results or retrieve the actual hits.

Parameters:
xpath - Description of the Parameter
encoding - Description of the Parameter
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

executeQuery

public int executeQuery(User user,
                        byte[] xpath)
                 throws EXistException,
                        PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

executeQuery

public int executeQuery(User user,
                        java.lang.String xpath)
                 throws EXistException,
                        PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

querySummary

public java.util.Hashtable querySummary(User user,
                                        int resultId)
                                 throws EXistException,
                                        PermissionDeniedException
Retrieve a summary of the result set identified by it's result-set-id. This method returns a struct with the following fields: "queryTime" int "hits" int "documents" array of array: Object[][3] "doctypes" array of array: Object[][2] Documents and doctypes represent tables where each row describes one document or doctype for which hits were found. Each document entry has the following structure: docId (int), docName (string), hits (int) The doctype entry has this structure: doctypeName (string), hits (int)

Parameters:
resultId - Description of the Parameter
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

getPermissions

public java.util.Hashtable getPermissions(User user,
                                          java.lang.String resource)
                                   throws EXistException,
                                          PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

getHits

public int getHits(User user,
                   int resultId)
            throws EXistException,
                   PermissionDeniedException
Get the number of hits in the result set identified by it's result-set-id.

Parameters:
resultId - Description of the Parameter
user - Description of the Parameter
Returns:
The hits value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

retrieve

public byte[] retrieve(User user,
                       int resultId,
                       int num,
                       int prettyPrint,
                       java.lang.String encoding)
                throws EXistException,
                       PermissionDeniedException
Retrieve a single result from the result-set identified by resultId. The XML fragment at position num in the result set is returned.

Parameters:
resultId - Description of the Parameter
num - Description of the Parameter
prettyPrint - Description of the Parameter
encoding - Description of the Parameter
user - Description of the Parameter
Returns:
Description of the Return Value
Throws:
EXistException - Description of the Exception
PermissionDeniedException - Description of the Exception

setUser

public boolean setUser(User user,
                       java.lang.String name,
                       java.lang.String passwd,
                       java.util.Vector groups,
                       java.lang.String home)
                throws EXistException,
                       PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

setUser

public boolean setUser(User user,
                       java.lang.String name,
                       java.lang.String passwd,
                       java.util.Vector groups)
                throws EXistException,
                       PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

setPermissions

public boolean setPermissions(User user,
                              java.lang.String resource,
                              java.lang.String permissions)
                       throws EXistException,
                              PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

setPermissions

public boolean setPermissions(User user,
                              java.lang.String resource,
                              int permissions)
                       throws EXistException,
                              PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

setPermissions

public boolean setPermissions(User user,
                              java.lang.String resource,
                              java.lang.String owner,
                              java.lang.String ownerGroup,
                              java.lang.String permissions)
                       throws EXistException,
                              PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

setPermissions

public boolean setPermissions(User user,
                              java.lang.String resource,
                              java.lang.String owner,
                              java.lang.String ownerGroup,
                              int permissions)
                       throws EXistException,
                              PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

getUser

public java.util.Hashtable getUser(User user,
                                   java.lang.String name)
                            throws EXistException,
                                   PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

getUsers

public java.util.Vector getUsers(User user)
                          throws EXistException,
                                 PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

removeUser

public boolean removeUser(User user,
                          java.lang.String name)
                   throws EXistException,
                          PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

getGroups

public java.util.Vector getGroups(User user)
                           throws EXistException,
                                  PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

getIndexedElements

public java.util.Vector getIndexedElements(User user,
                                           java.lang.String collectionName,
                                           boolean inclusive)
                                    throws EXistException,
                                           PermissionDeniedException
Throws:
EXistException
PermissionDeniedException

scanIndexTerms

public java.util.Vector scanIndexTerms(User user,
                                       java.lang.String collectionName,
                                       java.lang.String start,
                                       java.lang.String end,
                                       boolean inclusive)
                                throws PermissionDeniedException,
                                       EXistException
Throws:
PermissionDeniedException
EXistException

releaseQueryResult

public void releaseQueryResult(int handle)

xupdate

public int xupdate(User user,
                   java.lang.String collectionName,
                   byte[] xupdate)
            throws PermissionDeniedException,
                   EXistException,
                   org.xml.sax.SAXException
Throws:
PermissionDeniedException
EXistException
org.xml.sax.SAXException

xupdateResource

public int xupdateResource(User user,
                           java.lang.String resource,
                           byte[] xupdate)
                    throws PermissionDeniedException,
                           EXistException,
                           org.xml.sax.SAXException
Throws:
PermissionDeniedException
EXistException
org.xml.sax.SAXException

getCreationDate

public java.util.Date getCreationDate(User user,
                                      java.lang.String collectionName)
                               throws PermissionDeniedException,
                                      EXistException
Throws:
PermissionDeniedException
EXistException

getTimestamps

public java.util.Vector getTimestamps(User user,
                                      java.lang.String documentName)
                               throws PermissionDeniedException,
                                      EXistException
Throws:
PermissionDeniedException
EXistException


Copyright (C) Wolfgang Meier. All rights reserved.