net.axyana.qizxopen.xquery
Interface XQueryServer

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

XQueryBasicEngine

public interface XQueryServer

extends java.rmi.Remote

Represents a XQuery engine/server from the application point of view.

This object provides direct connections (XQueryConnection), or DataSources which can in turn open connections.

The default implementation class is XQueryBasicEngine. The set up of the actual engine is performed on the implementation, not on this interface.

Method Summary

XQueryConnection	getConnection(java.util.Properties properties) Opens a new connection without access to an XML Library.
XQueryConnection	getConnection(java.lang.String libraryPath, java.util.Properties properties) Opens a new connection to a particular XML Library.
XQueryDataSource	getDataSource(java.lang.String libraryPath) Creates a XQueryDataSource
XQMetadata	getProductInfo() Returns an object describing the XQuery Engine (Similar to XQMetaData in the XQJ specification).

Method Detail

getProductInfo

public XQMetadata getProductInfo()
                          throws java.rmi.RemoteException

Returns an object describing the XQuery Engine (Similar to XQMetaData in the XQJ specification).

Throws:

java.rmi.RemoteException

getConnection

public XQueryConnection getConnection(java.util.Properties properties)
                               throws XQueryException,
                                      java.rmi.RemoteException

Opens a new connection without access to an XML Library.

Access to XML Libraries is still possible provided that there is a XMLLibraryServer and access rights are granted.

Parameters:

properties - a set of named properties for authentification and configuration purpose. May be null if no authentification enforced.

Throws:

XQueryException

java.rmi.RemoteException

getConnection

public XQueryConnection getConnection(java.lang.String libraryPath,
                                      java.util.Properties properties)
                               throws XQueryException,
                                      java.rmi.RemoteException

Opens a new connection to a particular XML Library.

This Library becomes the default one. Access to other Libraries controlled by the same XMLLibraryServer is possible if access rights are granted.

Throws:

XQueryException

java.rmi.RemoteException

getDataSource

public XQueryDataSource getDataSource(java.lang.String libraryPath)
                               throws XQueryException,
                                      java.rmi.RemoteException

Creates a XQueryDataSource

Throws:

XQueryException

java.rmi.RemoteException