org.exist.soap
Class AdminSoapBindingStub

java.lang.Object
  extended byorg.apache.axis.client.Stub
      extended byorg.exist.soap.AdminSoapBindingStub
All Implemented Interfaces:
Admin, java.rmi.Remote, javax.xml.rpc.Stub

public class AdminSoapBindingStub
extends org.apache.axis.client.Stub
implements Admin


Field Summary
 
Fields inherited from class org.apache.axis.client.Stub
cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service
 
Fields inherited from interface javax.xml.rpc.Stub
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY
 
Constructor Summary
AdminSoapBindingStub()
           
AdminSoapBindingStub(javax.xml.rpc.Service service)
           
AdminSoapBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
 java.lang.String connect(java.lang.String in0, java.lang.String in1)
          Create a new user session.
 boolean createCollection(java.lang.String in0, java.lang.String in1)
          Create a new collection using the specified path.
 void disconnect(java.lang.String in0)
          Release a user session.
 boolean removeCollection(java.lang.String in0, java.lang.String in1)
          Remove the specified collection.
 boolean removeDocument(java.lang.String in0, java.lang.String in1)
          Remove the specified document.
 void store(java.lang.String in0, byte[] in1, java.lang.String in2, java.lang.String in3, boolean in4)
          Store a new document into the database.
 int xupdate(java.lang.String in0, java.lang.String in1, java.lang.String in2)
          Apply a set of XUpdate modifications to a collection.
 int xupdateResource(java.lang.String in0, java.lang.String in1, java.lang.String in2)
          Apply a set of XUpdate modifications to the specified document.
 
Methods inherited from class org.apache.axis.client.Stub
_getProperty, _getPropertyNames, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AdminSoapBindingStub

public AdminSoapBindingStub()
                     throws org.apache.axis.AxisFault

AdminSoapBindingStub

public AdminSoapBindingStub(java.net.URL endpointURL,
                            javax.xml.rpc.Service service)
                     throws org.apache.axis.AxisFault

AdminSoapBindingStub

public AdminSoapBindingStub(javax.xml.rpc.Service service)
                     throws org.apache.axis.AxisFault
Method Detail

store

public void store(java.lang.String in0,
                  byte[] in1,
                  java.lang.String in2,
                  java.lang.String in3,
                  boolean in4)
           throws java.rmi.RemoteException
Description copied from interface: Admin
Store a new document into the database. The document will be stored using the name and location as specified by the path argument. To avoid any conflicts with the SOAP transport layer, document contents are passed as base64 encoded binary data. Internally, all documents are stored in UTF-8 encoding. The method will automatically replace an already existing document with the same path if the replace argument is set to true (and the user has sufficient privileges).

Specified by:
store in interface Admin
Parameters:
in0 - a unique id for the created session.
in1 - the document contents as base64 encoded binary data.
in2 - the character encoding used for the document data.
in3 - the target path for the new document.
in4 - should an existing document be replaced?
Throws:
java.rmi.RemoteException

connect

public java.lang.String connect(java.lang.String in0,
                                java.lang.String in1)
                         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:
in0 -
in1 -
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 in0)
                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:
in0 - a valid session id as returned by connect().
Throws:
java.rmi.RemoteException

removeCollection

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

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

removeDocument

public boolean removeDocument(java.lang.String in0,
                              java.lang.String in1)
                       throws java.rmi.RemoteException
Description copied from interface: Admin
Remove the specified document.

Specified by:
removeDocument in interface Admin
Parameters:
in0 - a unique id for the created session.
in1 - the full path to the document.
Returns:
true on success.
Throws:
java.rmi.RemoteException

createCollection

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

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

xupdate

public int xupdate(java.lang.String in0,
                   java.lang.String in1,
                   java.lang.String in2)
            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:
in0 - a unique id for the created session.
in1 - the full path to the collection.
in2 - the XUpdate document to be applied.
Returns:
Throws:
java.rmi.RemoteException

xupdateResource

public int xupdateResource(java.lang.String in0,
                           java.lang.String in1,
                           java.lang.String in2)
                    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:
in0 - a unique id for the created session.
in1 - the full path to the document.
in2 - the XUpdate document to be applied.
Returns:
Throws:
java.rmi.RemoteException


Copyright (C) Wolfgang Meier. All rights reserved.