org.exist.soap
Class QuerySoapBindingStub

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

public class QuerySoapBindingStub
extends org.apache.axis.client.Stub
implements Query


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
QuerySoapBindingStub()
           
QuerySoapBindingStub(javax.xml.rpc.Service service)
           
QuerySoapBindingStub(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.
 void disconnect(java.lang.String in0)
          Release a user session.
 java.lang.String getResource(java.lang.String in0, java.lang.String in1, boolean in2, boolean in3)
          Retrieve a document from the database.
 Collection listCollection(java.lang.String in0, java.lang.String in1)
          Get information on the specified collection.
 QueryResponse query(java.lang.String in0, java.lang.String in1)
           
 java.lang.String[] retrieve(java.lang.String in0, int in1, int in2, boolean in3, boolean in4, java.lang.String in5)
          Retrieve a set of query results from the last query executed within the current session.
 java.lang.String[] retrieveByDocument(java.lang.String in0, int in1, int in2, java.lang.String in3, boolean in4, boolean in5, java.lang.String in6)
          For the specified document, retrieve a set of query results from the last query executed within the current session.
 
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

QuerySoapBindingStub

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

QuerySoapBindingStub

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

QuerySoapBindingStub

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

getResource

public java.lang.String getResource(java.lang.String in0,
                                    java.lang.String in1,
                                    boolean in2,
                                    boolean in3)
                             throws java.rmi.RemoteException
Description copied from interface: Query
Retrieve a document from the database.

Specified by:
getResource in interface Query
Parameters:
in0 - a valid session id as returned by connect().
in1 - the full path to the document.
in2 - should the document be pretty-printed (indented)?
in3 - should xinclude tags be expanded?
Returns:
the resource as string
Throws:
java.rmi.RemoteException

query

public QueryResponse query(java.lang.String in0,
                           java.lang.String in1)
                    throws java.rmi.RemoteException
Specified by:
query in interface Query
Parameters:
in0 - a valid session id as returned by connect().
in1 - XPath query string.
Returns:
QueryResponse describing the query results.
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: Query
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 Query
Parameters:
in0 -
in1 -
Returns:
session-id a unique id for the created session
Throws:
java.rmi.RemoteException - if the user cannot log in

retrieve

public java.lang.String[] retrieve(java.lang.String in0,
                                   int in1,
                                   int in2,
                                   boolean in3,
                                   boolean in4,
                                   java.lang.String in5)
                            throws java.rmi.RemoteException
Description copied from interface: Query
Retrieve a set of query results from the last query executed within the current session. The first result to be retrieved from the result set is defined by the start-parameter. Results are counted from 1.

Specified by:
retrieve in interface Query
Parameters:
in0 - a valid session id as returned by connect().
in1 - the first result to retrieve.
in2 - number of results to be returned.
in3 - should the XML be pretty-printed?
in4 - should xinclude tags be expanded?
in5 - highlight matching search terms within elements or attributes. Possible values are: "elements" for elements only, "attributes" for attributes only, "both" for elements and attributes, "none" to disable highlighting. For elements, matching terms are surrounded by <exist:match> tags. For attributes, terms are marked with the char sequence "||".
Returns:
Throws:
java.rmi.RemoteException

disconnect

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

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

retrieveByDocument

public java.lang.String[] retrieveByDocument(java.lang.String in0,
                                             int in1,
                                             int in2,
                                             java.lang.String in3,
                                             boolean in4,
                                             boolean in5,
                                             java.lang.String in6)
                                      throws java.rmi.RemoteException
Description copied from interface: Query
For the specified document, retrieve a set of query results from the last query executed within the current session. Only hits in the given document (identified by its path) are returned. The first result to be retrieved from the result set is defined by the start-parameter. Results are counted from 1.

Specified by:
retrieveByDocument in interface Query
Parameters:
in0 - a valid session id as returned by connect().
in1 - the first result to retrieve.
in2 - number of results to be returned.
in3 - the full path to the document.
in4 - should the XML be pretty-printed?
in5 - should xinclude tags be expanded?
in6 - highlight matching search terms within elements or attributes. Possible values are: "elements" for elements only, "attributes" for attributes only, "both" for elements and attributes, "none" to disable highlighting. For elements, matching terms are surrounded by <exist:match> tags. For attributes, terms are marked with the char sequence "||".
Returns:
Throws:
java.rmi.RemoteException

listCollection

public Collection listCollection(java.lang.String in0,
                                 java.lang.String in1)
                          throws java.rmi.RemoteException
Description copied from interface: Query
Get information on the specified collection.

Specified by:
listCollection in interface Query
Parameters:
in0 - a valid session id as returned by connect().
in1 - the full path to the collection.
Returns:
Throws:
java.rmi.RemoteException


Copyright (C) Wolfgang Meier. All rights reserved.