org.exist.soap
Class AdminSoapBindingImpl

java.lang.Object
  extended byorg.exist.soap.AdminSoapBindingImpl
All Implemented Interfaces:
Admin, java.rmi.Remote

public class AdminSoapBindingImpl
extends java.lang.Object
implements Admin

Description of the Class

Author:
Wolfgang Meier

Constructor Summary
AdminSoapBindingImpl()
          Constructor for the AdminSoapBindingImpl object
 
Method Summary
 java.lang.String connect(java.lang.String user, java.lang.String password)
          Create a new user session.
 boolean createCollection(java.lang.String sessionId, java.lang.String collection)
          Create a new collection using the specified path.
 void disconnect(java.lang.String id)
          Release a user session.
 boolean removeCollection(java.lang.String sessionId, java.lang.String collection)
          Remove the specified collection.
 boolean removeDocument(java.lang.String sessionId, java.lang.String path)
          Description of the Method
 void store(java.lang.String sessionId, byte[] data, java.lang.String encoding, java.lang.String path, boolean replace)
          Description of the Method
 int xupdate(java.lang.String sessionId, java.lang.String collectionName, java.lang.String xupdate)
          Apply a set of XUpdate modifications to a collection.
 int xupdateResource(java.lang.String sessionId, java.lang.String documentName, java.lang.String xupdate)
          Apply a set of XUpdate modifications to the specified document.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AdminSoapBindingImpl

public AdminSoapBindingImpl()
Constructor for the AdminSoapBindingImpl object

Method Detail

connect

public java.lang.String connect(java.lang.String user,
                                java.lang.String password)
                         throws java.rmi.RemoteException
Description copied from interface: Admin
Create a new user session. Authenticates the user against the database. The user has to be a valid database user. If the provided user information is valid, a new session will be registered on the server and a session id will be returned. The session will be valid for at least 60 minutes. Please call disconnect() to release the session. Sessions are shared between the Query and Admin services. A session created through the Query service can be used with the Admin service and vice versa.

Specified by:
connect in interface Admin
Parameters:
user -
password -
Returns:
session-id a unique id for the created session
Throws:
java.rmi.RemoteException - if the user cannot log in

disconnect

public void disconnect(java.lang.String id)
                throws java.rmi.RemoteException
Description copied from interface: Admin
Release a user session. This will free all resources (including result sets).

Specified by:
disconnect in interface Admin
Parameters:
id - a valid session id as returned by connect().
Throws:
java.rmi.RemoteException

createCollection

public boolean createCollection(java.lang.String sessionId,
                                java.lang.String collection)
                         throws java.rmi.RemoteException
Description copied from interface: Admin
Create a new collection using the specified path.

Specified by:
createCollection in interface Admin
Parameters:
sessionId - a unique id for the created session.
collection - the full path to the collection.
Returns:
Throws:
java.rmi.RemoteException

removeCollection

public boolean removeCollection(java.lang.String sessionId,
                                java.lang.String collection)
                         throws java.rmi.RemoteException
Description copied from interface: Admin
Remove the specified collection.

Specified by:
removeCollection in interface Admin
Parameters:
sessionId - sessionId a unique id for the created session.
collection - the full path to the collection.
Returns:
true on success.
Throws:
java.rmi.RemoteException

removeDocument

public boolean removeDocument(java.lang.String sessionId,
                              java.lang.String path)
                       throws java.rmi.RemoteException
Description of the Method

Specified by:
removeDocument in interface Admin
Parameters:
path - Description of the Parameter
sessionId - a unique id for the created session.
Returns:
Description of the Return Value
Throws:
java.rmi.RemoteException - Description of the Exception

store

public void store(java.lang.String sessionId,
                  byte[] data,
                  java.lang.String encoding,
                  java.lang.String path,
                  boolean replace)
           throws java.rmi.RemoteException
Description of the Method

Specified by:
store in interface Admin
Parameters:
data - Description of the Parameter
encoding - Description of the Parameter
path - Description of the Parameter
replace - Description of the Parameter
sessionId - a unique id for the created session.
Throws:
java.rmi.RemoteException - Description of the Exception

xupdate

public int xupdate(java.lang.String sessionId,
                   java.lang.String collectionName,
                   java.lang.String xupdate)
            throws java.rmi.RemoteException
Description copied from interface: Admin
Apply a set of XUpdate modifications to a collection.

Specified by:
xupdate in interface Admin
Parameters:
sessionId - a unique id for the created session.
collectionName - the full path to the collection.
xupdate - the XUpdate document to be applied.
Returns:
Throws:
java.rmi.RemoteException

xupdateResource

public int xupdateResource(java.lang.String sessionId,
                           java.lang.String documentName,
                           java.lang.String xupdate)
                    throws java.rmi.RemoteException
Description copied from interface: Admin
Apply a set of XUpdate modifications to the specified document.

Specified by:
xupdateResource in interface Admin
Parameters:
sessionId - a unique id for the created session.
documentName - the full path to the document.
xupdate - the XUpdate document to be applied.
Returns:
Throws:
java.rmi.RemoteException


Copyright (C) Wolfgang Meier. All rights reserved.