|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.xmlrpc.RpcServer
Handler class for XMLRPC calls.
To allow calls by many parallel users, RpcServer does not directly execute calls. Instead it delegates all calls to instances of the inner class RpcConnection, which run in their own thread.
On startup, RpcServer creates a pool of RpcConnections. For every call the server first gets a RpcConnection object from the pool, executes the call and releases the RpcConnection.
If the pool's maximum of concurrent connections (MAX_CONNECT) is reached, RpcServer will block until a connection is available.
All methods returning XML data will return UTF-8 encoded strings, unless an encoding is specified. Methods that allow to set the encoding will always return byte[] instead of string. byte[]-values are handled as binary data and are automatically BASE64-encoded by the XMLRPC engine. This way the correct character encoding is preserved during transport.
Field Summary |
Fields inherited from interface org.exist.xmlrpc.RpcAPI |
BASE_URI, COLUMN, ERROR, LINE, NAMESPACES, SORT_EXPR, STATIC_DOCUMENTS, VARIABLES |
Constructor Summary | |
RpcServer(Configuration conf,
java.lang.String databaseid)
Constructor for the RpcServer object |
Method Summary | |
boolean |
backup(User user,
java.lang.String userbackup,
java.lang.String password,
java.lang.String destcollection,
java.lang.String collection)
|
java.util.Hashtable |
compile(User user,
byte[] xquery,
java.util.Hashtable parameters)
|
boolean |
configureCollection(User user,
java.lang.String collection,
java.lang.String configuration)
|
boolean |
copyCollection(User user,
java.lang.String name,
java.lang.String namedest)
|
boolean |
copyCollection(User user,
java.lang.String collectionPath,
java.lang.String destinationPath,
java.lang.String newName)
|
boolean |
copyResource(User user,
java.lang.String docPath,
java.lang.String destinationPath,
java.lang.String newName)
|
boolean |
createCollection(User user,
java.lang.String name)
Create a new collection on the database. |
boolean |
createCollection(User user,
java.lang.String name,
java.util.Date created)
|
java.lang.String |
createId(User user,
java.lang.String collection)
|
java.lang.String |
createResourceId(User user,
java.lang.String collection)
|
boolean |
dataBackup(User user,
java.lang.String dest)
|
java.util.Hashtable |
describeCollection(User user,
java.lang.String rootCollection)
|
java.util.Hashtable |
describeResource(User user,
java.lang.String resourceName)
|
java.util.Hashtable |
execute(User user,
java.lang.String path,
java.util.Hashtable parameters)
Execute XPath/Xquery from path file (stored inside eXist) returned reference may be used later to get a summary of results or retrieve the actual hits. |
int |
executeQuery(User user,
byte[] xpath,
java.util.Hashtable parameters)
|
int |
executeQuery(User user,
byte[] xpath,
java.lang.String encoding,
java.util.Hashtable parameters)
Execute XPath query and return a reference to the result set. |
int |
executeQuery(User user,
java.lang.String xpath,
java.util.Hashtable parameters)
|
byte[] |
getBinaryResource(User user,
java.lang.String name)
|
java.util.Hashtable |
getCollectionDesc(User user,
java.lang.String rootCollection)
Describe a collection: returns a struct with the following fields: |
java.util.Date |
getCreationDate(User user,
java.lang.String collectionName)
|
java.util.Vector |
getDocType(User user,
java.lang.String documentName)
|
byte[] |
getDocument(User user,
java.lang.String name,
java.util.Hashtable parametri)
Retrieve document by name. |
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,
java.util.Hashtable parameters)
Retrieve a document. |
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 |
getDocumentChunk(User user,
java.lang.String name,
java.util.Hashtable parameters)
|
byte[] |
getDocumentChunk(User user,
java.lang.String name,
int start,
int len)
|
java.util.Hashtable |
getDocumentData(User user,
java.lang.String name,
java.util.Hashtable parameters)
Retrieve the specified document, but limit the number of bytes transmitted to avoid memory shortage on the server. |
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 |
getNextChunk(User user,
java.lang.String handle,
int offset)
|
java.util.Hashtable |
getPermissions(User user,
java.lang.String docName)
|
int |
getResourceCount(User user,
java.lang.String collectionName)
Returns the number of resources in the collection identified by collectionName. |
java.util.Vector |
getTimestamps(User user,
java.lang.String documentName)
|
java.util.Hashtable |
getUser(User user,
java.lang.String name)
Gets the user attribute of the RpcServer object |
java.util.Vector |
getUsers(User user)
|
boolean |
hasCollection(User user,
java.lang.String name)
does a document called name exist in the repository? |
boolean |
hasDocument(User user,
java.lang.String name)
does a document called name exist in the repository? |
java.lang.String |
hasUserLock(User user,
java.lang.String path)
|
boolean |
isValid(User user,
java.lang.String name)
|
boolean |
isXACMLEnabled(User user)
Returns true if XACML is enabled for the current database instance |
java.util.Hashtable |
listCollectionPermissions(User user,
java.lang.String name)
|
java.util.Hashtable |
listDocumentPermissions(User user,
java.lang.String name)
|
boolean |
lockResource(User user,
java.lang.String path,
java.lang.String userName)
|
boolean |
moveCollection(User user,
java.lang.String collectionPath,
java.lang.String destinationPath,
java.lang.String newName)
|
boolean |
moveResource(User user,
java.lang.String docPath,
java.lang.String destinationPath,
java.lang.String newName)
|
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,
byte[] xmlData,
java.lang.String docName,
int overwrite,
java.util.Date created,
java.util.Date modified)
|
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. |
boolean |
parseLocal(User user,
java.lang.String localFile,
java.lang.String docName,
boolean replace,
java.util.Date created,
java.util.Date modified)
|
java.lang.String |
printDiagnostics(User user,
java.lang.String query,
java.util.Hashtable parameters)
Returns a diagnostic dump of the expression structure after compiling the query. |
byte[] |
query(User user,
byte[] xquery,
int howmany,
int start,
java.util.Hashtable parameters)
execute XPath query and return howmany nodes from the result set, starting at position start . |
java.util.Hashtable |
queryP(User user,
byte[] xpath,
java.util.Hashtable parameters)
|
java.util.Hashtable |
queryP(User user,
byte[] xpath,
java.lang.String docName,
java.lang.String s_id,
java.util.Hashtable parameters)
|
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. |
boolean |
reindexCollection(User user,
java.lang.String name)
|
boolean |
releaseQueryResult(User user,
int handle)
|
boolean |
remove(User user,
java.lang.String docName)
remove a document from the repository. |
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,
java.util.Hashtable parameters)
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,
java.util.Hashtable parameters)
retrieve a single node from a document. |
byte[] |
retrieveAll(User user,
int resultId,
java.util.Hashtable parameters)
|
java.lang.String |
retrieveAsString(User user,
java.lang.String doc,
java.lang.String id,
java.util.Hashtable parameters)
|
java.util.Vector |
scanIndexTerms(User user,
java.lang.String xpath,
java.lang.String start,
java.lang.String end)
|
java.util.Vector |
scanIndexTerms(User user,
java.lang.String collectionName,
java.lang.String start,
java.lang.String end,
boolean inclusive)
|
boolean |
setDocType(User user,
java.lang.String documentName,
java.lang.String doctypename,
java.lang.String publicid,
java.lang.String systemid)
|
boolean |
setPermissions(User user,
java.lang.String resource,
int permissions)
|
boolean |
setPermissions(User user,
java.lang.String resource,
java.lang.String permissions)
Sets the permissions attribute of the RpcServer object |
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)
Sets the permissions attribute of the RpcServer object |
boolean |
setUser(User user,
java.lang.String name,
java.lang.String password,
java.lang.String digestPassword,
java.util.Vector groups)
|
boolean |
setUser(User user,
java.lang.String name,
java.lang.String password,
java.lang.String digestPassword,
java.util.Vector groups,
java.lang.String home)
Sets the password attribute of the RpcServer object |
boolean |
shutdown(User user)
Shut down the database immediately. |
boolean |
shutdown(User user,
long delay)
Shut down the database after the specified delay (in milliseconds). |
boolean |
storeBinary(User user,
byte[] data,
java.lang.String docName,
java.lang.String mimeType,
boolean replace)
Store data as a binary resource. |
boolean |
storeBinary(User user,
byte[] data,
java.lang.String docName,
java.lang.String mimeType,
boolean replace,
java.util.Date created,
java.util.Date modified)
|
boolean |
sync(User user)
|
boolean |
unlockResource(User user,
java.lang.String path)
|
java.lang.String |
upload(User user,
byte[] data,
int length)
An alternative to parse() for larger XML documents. |
java.lang.String |
upload(User user,
java.lang.String file,
byte[] data,
int length)
An alternative to parse() for larger XML documents. |
java.lang.String |
uploadCompressed(User user,
byte[] data,
int length)
|
java.lang.String |
uploadCompressed(User user,
java.lang.String file,
byte[] data,
int length)
|
int |
xupdate(User user,
java.lang.String collectionName,
byte[] xupdate)
|
int |
xupdateResource(User user,
java.lang.String resource,
byte[] xupdate)
|
int |
xupdateResource(User user,
java.lang.String resource,
byte[] xupdate,
java.lang.String encoding)
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RpcServer(Configuration conf, java.lang.String databaseid) throws EXistException
conf
- Description of the Parameter
EXistException
- Description of the ExceptionMethod Detail |
public boolean createCollection(User user, java.lang.String name) throws EXistException, PermissionDeniedException
RpcAPI
createCollection
in interface RpcAPI
user
- name
- the path to the new collection.
PermissionDeniedException
EXistException
public boolean createCollection(User user, java.lang.String name, java.util.Date created) throws EXistException, PermissionDeniedException
createCollection
in interface RpcAPI
EXistException
PermissionDeniedException
public java.lang.String createId(User user, java.lang.String collection) throws EXistException, PermissionDeniedException, java.net.URISyntaxException
EXistException
PermissionDeniedException
java.net.URISyntaxException
public int executeQuery(User user, java.lang.String xpath, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
executeQuery
in interface RpcAPI
EXistException
PermissionDeniedException
public int executeQuery(User user, byte[] xpath, java.lang.String encoding, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
RpcAPI
executeQuery
in interface RpcAPI
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, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
executeQuery
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Hashtable getCollectionDesc(User user, java.lang.String rootCollection) throws EXistException, PermissionDeniedException
RpcAPI
name The name of the collection owner The name of the user owning the collection. group The group owning the collection. permissions The permissions that apply to this collection (int value) created The creation date of this collection (long value) collections An array containing the names of all subcollections. documents An array containing a struct for each document in the collection.Each of the elements in the "documents" array is another struct containing the properties of the document:
name The full path of the document. owner The name of the user owning the document. group The group owning the document. permissions The permissions that apply to this document (int) type Type of the resource: either "XMLResource" or "BinaryResource"
getCollectionDesc
in interface RpcAPI
rootCollection
- Description of the Parameteruser
- Description of the Parameter
PermissionDeniedException
- Description of the Exception
EXistException
- Description of the Exceptionpublic java.util.Hashtable describeResource(User user, java.lang.String resourceName) throws EXistException, PermissionDeniedException
describeResource
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Hashtable describeCollection(User user, java.lang.String rootCollection) throws EXistException, PermissionDeniedException
describeCollection
in interface RpcAPI
EXistException
PermissionDeniedException
public byte[] getDocument(User user, java.lang.String name, java.lang.String encoding, int prettyPrint) throws EXistException, PermissionDeniedException
RpcAPI
getDocument
in interface RpcAPI
name
- the document's name.prettyPrint
- pretty print XML if >0.encoding
- character encoding to use.user
-
EXistException
PermissionDeniedException
public byte[] getDocument(User user, java.lang.String name, java.lang.String encoding, int prettyPrint, java.lang.String stylesheet) throws EXistException, PermissionDeniedException
RpcAPI
getDocument
in interface RpcAPI
name
- the document's name.prettyPrint
- pretty print XML if >0.encoding
- character encoding to use.user
- Description of the Parameter
EXistException
PermissionDeniedException
public java.lang.String getDocumentAsString(User user, java.lang.String name, int prettyPrint) throws EXistException, PermissionDeniedException
getDocumentAsString
in interface RpcAPI
EXistException
PermissionDeniedException
public java.lang.String getDocumentAsString(User user, java.lang.String name, int prettyPrint, java.lang.String stylesheet) throws EXistException, PermissionDeniedException
getDocumentAsString
in interface RpcAPI
EXistException
PermissionDeniedException
public byte[] getBinaryResource(User user, java.lang.String name) throws EXistException, PermissionDeniedException
getBinaryResource
in interface RpcAPI
EXistException
PermissionDeniedException
public java.lang.String getDocumentAsString(User user, java.lang.String name, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
getDocumentAsString
in interface RpcAPI
EXistException
PermissionDeniedException
public byte[] getDocument(User user, java.lang.String name, java.util.Hashtable parametri) throws EXistException, PermissionDeniedException
RpcAPI
parameters
.
Valid keys may either be taken from OutputKeys
or
EXistOutputKeys
. For example, the encoding is identified by
the value of key OutputKeys.ENCODING
.
getDocument
in interface RpcAPI
name
- the document's name.parametri
- Hashtable of parameters.
EXistException
PermissionDeniedException
public java.util.Hashtable getDocumentData(User user, java.lang.String name, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
RpcAPI
getDocumentData
in interface RpcAPI
user
- name
- parameters
-
PermissionDeniedException
EXistException
public java.util.Hashtable getNextChunk(User user, java.lang.String handle, int offset) throws EXistException, PermissionDeniedException
getNextChunk
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Vector getDocumentListing(User user) throws EXistException, PermissionDeniedException
RpcAPI
getDocumentListing
in interface RpcAPI
user
-
PermissionDeniedException
- Description of the Exception
EXistException
- Description of the Exceptionpublic java.util.Vector getDocumentListing(User user, java.lang.String collection) throws EXistException, PermissionDeniedException
RpcAPI
getDocumentListing
in interface RpcAPI
collection
- the collection to use.user
- Description of the Parameter
PermissionDeniedException
- Description of the Exception
EXistException
- Description of the Exceptionpublic java.util.Hashtable listDocumentPermissions(User user, java.lang.String name) throws EXistException, PermissionDeniedException
listDocumentPermissions
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Hashtable listCollectionPermissions(User user, java.lang.String name) throws EXistException, PermissionDeniedException
listCollectionPermissions
in interface RpcAPI
EXistException
PermissionDeniedException
public int getHits(User user, int resultId) throws EXistException, PermissionDeniedException
RpcAPI
getHits
in interface RpcAPI
resultId
- Description of the Parameteruser
- Description of the Parameter
PermissionDeniedException
- Description of the Exception
EXistException
- Description of the Exceptionpublic java.util.Hashtable getPermissions(User user, java.lang.String docName) throws EXistException, PermissionDeniedException
getPermissions
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Date getCreationDate(User user, java.lang.String collectionName) throws PermissionDeniedException, EXistException
getCreationDate
in interface RpcAPI
PermissionDeniedException
EXistException
public java.util.Vector getTimestamps(User user, java.lang.String documentName) throws PermissionDeniedException, EXistException
getTimestamps
in interface RpcAPI
PermissionDeniedException
EXistException
public java.util.Hashtable getUser(User user, java.lang.String name) throws EXistException, PermissionDeniedException
getUser
in interface RpcAPI
user
- Description of the Parametername
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic java.util.Vector getUsers(User user) throws EXistException, PermissionDeniedException
getUsers
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Vector getGroups(User user) throws EXistException, PermissionDeniedException
getGroups
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Vector getIndexedElements(User user, java.lang.String collectionName, boolean inclusive) throws EXistException, PermissionDeniedException
getIndexedElements
in interface RpcAPI
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
scanIndexTerms
in interface RpcAPI
PermissionDeniedException
EXistException
public java.util.Vector scanIndexTerms(User user, java.lang.String xpath, java.lang.String start, java.lang.String end) throws PermissionDeniedException, EXistException, XPathException
scanIndexTerms
in interface RpcAPI
PermissionDeniedException
EXistException
XPathException
public boolean hasDocument(User user, java.lang.String name) throws EXistException, PermissionDeniedException
name
exist in the repository?
hasDocument
in interface RpcAPI
name
- Description of the Parameteruser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic boolean hasCollection(User user, java.lang.String name) throws EXistException, PermissionDeniedException
name
exist in the repository?
hasCollection
in interface RpcAPI
name
- Description of the Parameteruser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic int getResourceCount(User user, java.lang.String collectionName) throws EXistException, PermissionDeniedException
RpcAPI
getResourceCount
in interface RpcAPI
collectionName
- user
-
PermissionDeniedException
EXistException
public 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[].
parse
in interface RpcAPI
xmlData
- the document's XML content as UTF-8 encoded array of bytes.docName
- the document's nameuser
- 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
RpcAPI
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.
parse
in interface RpcAPI
xmlData
- The document datadocName
- The path where the document will be storedoverwrite
- Overwrite an existing document with the same path?
PermissionDeniedException
EXistException
public boolean parse(User user, byte[] xmlData, java.lang.String docName, int overwrite, java.util.Date created, java.util.Date modified) throws EXistException, PermissionDeniedException
parse
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean parse(User user, java.lang.String xml, java.lang.String docName, int overwrite) throws EXistException, PermissionDeniedException
parse
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean parseLocal(User user, java.lang.String localFile, java.lang.String docName, boolean replace) throws EXistException, PermissionDeniedException, org.xml.sax.SAXException
parseLocal
in interface RpcAPI
user
- localFile
-
EXistException
java.io.IOException
PermissionDeniedException
org.xml.sax.SAXException
public boolean parseLocal(User user, java.lang.String localFile, java.lang.String docName, boolean replace, java.util.Date created, java.util.Date modified) throws EXistException, PermissionDeniedException, org.xml.sax.SAXException
parseLocal
in interface RpcAPI
EXistException
PermissionDeniedException
org.xml.sax.SAXException
public java.lang.String uploadCompressed(User user, byte[] data, int length) throws EXistException, PermissionDeniedException
uploadCompressed
in interface RpcAPI
EXistException
PermissionDeniedException
public java.lang.String uploadCompressed(User user, java.lang.String file, byte[] data, int length) throws EXistException, PermissionDeniedException
uploadCompressed
in interface RpcAPI
EXistException
PermissionDeniedException
public java.lang.String upload(User user, byte[] data, int length) throws EXistException, PermissionDeniedException
RpcAPI
upload
in interface RpcAPI
user
- data
- the current chunklength
- total length of the file
PermissionDeniedException
EXistException
public java.lang.String upload(User user, java.lang.String file, byte[] data, int length) throws EXistException, PermissionDeniedException
RpcAPI
upload
in interface RpcAPI
user
- data
- the current chunkfile
- the name of the file to which the chunk will be appended. This
should be the file name returned by the first call to upload.length
- total length of the file
PermissionDeniedException
EXistException
public boolean parse(User user, java.lang.String xml, java.lang.String docName) throws EXistException, PermissionDeniedException
parse
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean storeBinary(User user, byte[] data, java.lang.String docName, java.lang.String mimeType, boolean replace) throws EXistException, PermissionDeniedException
RpcAPI
storeBinary
in interface RpcAPI
user
- data
- the data to be storeddocName
- the path to the new documentreplace
- if true, an old document with the same path will be overwritten
EXistException
PermissionDeniedException
public boolean storeBinary(User user, byte[] data, java.lang.String docName, java.lang.String mimeType, boolean replace, java.util.Date created, java.util.Date modified) throws EXistException, PermissionDeniedException
storeBinary
in interface RpcAPI
EXistException
PermissionDeniedException
public java.lang.String createResourceId(User user, java.lang.String collection) throws EXistException, PermissionDeniedException
createResourceId
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Hashtable compile(User user, byte[] xquery, java.util.Hashtable parameters) throws java.lang.Exception
compile
in interface RpcAPI
java.lang.Exception
public java.util.Hashtable queryP(User user, byte[] xpath, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
queryP
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Hashtable queryP(User user, byte[] xpath, java.lang.String docName, java.lang.String s_id, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
queryP
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Hashtable execute(User user, java.lang.String path, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
RpcAPI
execute
in interface RpcAPI
EXistException
PermissionDeniedException
public java.lang.String printDiagnostics(User user, java.lang.String query, java.util.Hashtable parameters) throws PermissionDeniedException, EXistException
RpcAPI
printDiagnostics
in interface RpcAPI
user
- query
-
EXistException
PermissionDeniedException
public boolean releaseQueryResult(User user, int handle)
releaseQueryResult
in interface RpcAPI
public byte[] query(User user, byte[] xquery, int howmany, int start, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
start
. If prettyPrint
is set to >0 (true), results are pretty printed.
query
in interface RpcAPI
xquery
- parameters
- howmany
- maximum number of results to return.start
- item in the result set to start with.user
-
EXistException
PermissionDeniedException
public java.util.Hashtable querySummary(User user, int resultId) throws EXistException, PermissionDeniedException, XPathException
RpcAPI
querySummary
in interface RpcAPI
resultId
- Description of the Parameteruser
- Description of the Parameter
PermissionDeniedException
- Description of the Exception
EXistException
- Description of the Exception
XPathException
public java.util.Hashtable querySummary(User user, java.lang.String xpath) throws EXistException, PermissionDeniedException
querySummary
in interface RpcAPI
xpath
- Description of the Parameteruser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic boolean remove(User user, java.lang.String docName) throws EXistException, PermissionDeniedException
remove
in interface RpcAPI
docName
- Description of the Parameteruser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic boolean copyCollection(User user, java.lang.String collectionPath, java.lang.String destinationPath, java.lang.String newName) throws EXistException, PermissionDeniedException
copyCollection
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean moveCollection(User user, java.lang.String collectionPath, java.lang.String destinationPath, java.lang.String newName) throws EXistException, PermissionDeniedException
moveCollection
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean moveResource(User user, java.lang.String docPath, java.lang.String destinationPath, java.lang.String newName) throws EXistException, PermissionDeniedException
moveResource
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean copyResource(User user, java.lang.String docPath, java.lang.String destinationPath, java.lang.String newName) throws EXistException, PermissionDeniedException
copyResource
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean removeCollection(User user, java.lang.String name) throws EXistException, PermissionDeniedException
RpcAPI
removeCollection
in interface RpcAPI
name
- path to the collection to be removed.user
-
EXistException
PermissionDeniedException
public boolean removeUser(User user, java.lang.String name) throws EXistException, PermissionDeniedException
removeUser
in interface RpcAPI
EXistException
PermissionDeniedException
public byte[] retrieve(User user, java.lang.String doc, java.lang.String id) throws EXistException, PermissionDeniedException
retrieve
in interface RpcAPI
doc
- the document containing the nodeid
- the node's internal iduser
- Description of the Parameter
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic byte[] retrieve(User user, java.lang.String doc, java.lang.String id, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
retrieve
in interface RpcAPI
doc
- the document containing the nodeid
- the node's internal iduser
- Description of the Parameterparameters
-
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic java.lang.String retrieveAsString(User user, java.lang.String doc, java.lang.String id, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
retrieveAsString
in interface RpcAPI
EXistException
PermissionDeniedException
public byte[] retrieve(User user, int resultId, int num, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
RpcAPI
retrieve
in interface RpcAPI
parameters
- resultId
- num
- user
-
EXistException
PermissionDeniedException
public byte[] retrieveAll(User user, int resultId, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException
retrieveAll
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean setPermissions(User user, java.lang.String resource, java.lang.String permissions) throws EXistException, PermissionDeniedException
setPermissions
in interface RpcAPI
user
- The new permissions valueresource
- The new permissions valuepermissions
- The new permissions value
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic boolean setPermissions(User user, java.lang.String resource, java.lang.String owner, java.lang.String ownerGroup, java.lang.String permissions) throws EXistException, PermissionDeniedException
setPermissions
in interface RpcAPI
user
- The new permissions valueresource
- The new permissions valuepermissions
- The new permissions valueowner
- The new permissions valueownerGroup
- The new permissions value
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic boolean setPermissions(User user, java.lang.String resource, int permissions) throws EXistException, PermissionDeniedException
setPermissions
in interface RpcAPI
EXistException
PermissionDeniedException
RpcAPI.setPermissions(org.exist.security.User,
java.lang.String, int)
public boolean setPermissions(User user, java.lang.String resource, java.lang.String owner, java.lang.String ownerGroup, int permissions) throws EXistException, PermissionDeniedException
setPermissions
in interface RpcAPI
EXistException
PermissionDeniedException
RpcAPI.setPermissions(org.exist.security.User,
java.lang.String, java.lang.String, java.lang.String, int)
public boolean setUser(User user, java.lang.String name, java.lang.String password, java.lang.String digestPassword, java.util.Vector groups, java.lang.String home) throws EXistException, PermissionDeniedException
setUser
in interface RpcAPI
user
- The new password valuename
- The new password valuepassword
- The new password valuegroups
- The new user value
EXistException
- Description of the Exception
PermissionDeniedException
- Description of the Exceptionpublic boolean setUser(User user, java.lang.String name, java.lang.String password, java.lang.String digestPassword, java.util.Vector groups) throws EXistException, PermissionDeniedException
setUser
in interface RpcAPI
EXistException
PermissionDeniedException
public int xupdate(User user, java.lang.String collectionName, byte[] xupdate) throws PermissionDeniedException, EXistException, org.xml.sax.SAXException
xupdate
in interface RpcAPI
PermissionDeniedException
EXistException
org.xml.sax.SAXException
public int xupdateResource(User user, java.lang.String resource, byte[] xupdate) throws PermissionDeniedException, EXistException, org.xml.sax.SAXException
xupdateResource
in interface RpcAPI
PermissionDeniedException
EXistException
org.xml.sax.SAXException
public int xupdateResource(User user, java.lang.String resource, byte[] xupdate, java.lang.String encoding) throws PermissionDeniedException, EXistException, org.xml.sax.SAXException
xupdateResource
in interface RpcAPI
PermissionDeniedException
EXistException
org.xml.sax.SAXException
public boolean shutdown(User user) throws PermissionDeniedException
RpcAPI
shutdown
in interface RpcAPI
PermissionDeniedException
public boolean shutdown(User user, long delay) throws PermissionDeniedException
RpcAPI
shutdown
in interface RpcAPI
PermissionDeniedException
public boolean sync(User user)
sync
in interface RpcAPI
public boolean isXACMLEnabled(User user)
RpcAPI
isXACMLEnabled
in interface RpcAPI
public boolean dataBackup(User user, java.lang.String dest) throws PermissionDeniedException
dataBackup
in interface RpcAPI
PermissionDeniedException
public boolean copyCollection(User user, java.lang.String name, java.lang.String namedest) throws EXistException, PermissionDeniedException
copyCollection
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean lockResource(User user, java.lang.String path, java.lang.String userName) throws EXistException, PermissionDeniedException
lockResource
in interface RpcAPI
EXistException
PermissionDeniedException
public java.lang.String hasUserLock(User user, java.lang.String path) throws EXistException, PermissionDeniedException
hasUserLock
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean unlockResource(User user, java.lang.String path) throws EXistException, PermissionDeniedException
unlockResource
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Vector getDocumentChunk(User user, java.lang.String name, java.util.Hashtable parameters) throws EXistException, PermissionDeniedException, java.io.IOException
getDocumentChunk
in interface RpcAPI
EXistException
PermissionDeniedException
java.io.IOException
public byte[] getDocumentChunk(User user, java.lang.String name, int start, int len) throws EXistException, PermissionDeniedException, java.io.IOException
getDocumentChunk
in interface RpcAPI
EXistException
PermissionDeniedException
java.io.IOException
public boolean reindexCollection(User user, java.lang.String name) throws EXistException, PermissionDeniedException
reindexCollection
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean backup(User user, java.lang.String userbackup, java.lang.String password, java.lang.String destcollection, java.lang.String collection) throws EXistException, PermissionDeniedException
backup
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean configureCollection(User user, java.lang.String collection, java.lang.String configuration) throws EXistException, PermissionDeniedException
configureCollection
in interface RpcAPI
EXistException
PermissionDeniedException
public boolean isValid(User user, java.lang.String name) throws EXistException, PermissionDeniedException
isValid
in interface RpcAPI
EXistException
PermissionDeniedException
public java.util.Vector getDocType(User user, java.lang.String documentName) throws PermissionDeniedException, EXistException
getDocType
in interface RpcAPI
PermissionDeniedException
EXistException
public boolean setDocType(User user, java.lang.String documentName, java.lang.String doctypename, java.lang.String publicid, java.lang.String systemid) throws EXistException, PermissionDeniedException
setDocType
in interface RpcAPI
EXistException
PermissionDeniedException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |