gov.noaa.gdsg.xmldbremote.xmldbClient
Class XmldbClientDatabase

java.lang.Object
  gov.noaa.gdsg.xmldbremote.xmldbClient.XmldbClientDatabase

All Implemented Interfaces:

org.xmldb.api.base.Configurable, org.xmldb.api.base.Database

public class XmldbClientDatabase
extends java.lang.Object
implements org.xmldb.api.base.Database

This is an XML:DB Database API implementation which uses a SOAP stub to make remote calls.

Version:

$Id: XmldbClientDatabase.java,v 1.3 2004/12/29 01:08:05 mrxtravis Exp $

Author:

tns

Constructor Summary

XmldbClientDatabase()
Creates a new instance of XmldbClientDatabase

Method Summary

boolean	acceptsURI(java.lang.String uri) Determines if this Database accepts the specified URI
org.xmldb.api.base.Collection	getCollection(java.lang.String uri, java.lang.String userName, java.lang.String password) Returns the specified collection.
java.lang.String	getConformanceLevel() Returns the conformance level of the remote database interface.
java.lang.String	getEndPointUrl() Getter for property endPointUrl.
java.lang.String	getName() Deprecated. Use #getNames.
java.lang.String	getProperty(java.lang.String str) Throws an exceptioin as ErrorCodes.NOT_IMPLEMENTED.
java.lang.String	getRemoteDatabaseUri() Getter for property databaseUri.
org.apache.axis.client.Service	getService() Getter for property service.
void	init() Initializes the datbase
static org.xmldb.api.base.Database	newDatabase(java.lang.String endpointUrl)
static org.xmldb.api.base.Database	newDefaultDatabase()
void	setEndPointUrl(java.lang.String endPointUrl) Setter for property endPointUrl.
void	setProperty(java.lang.String str, java.lang.String str1) Throws an exceptioin as ErrorCodes.NOT_IMPLEMENTED.
void	setRemoteDatabaseUri(java.lang.String remoteDatabaseUri) Setter for property databaseUri.
void	setService(org.apache.axis.client.Service service) Setter for property service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmldbClientDatabase

public XmldbClientDatabase()

Creates a new instance of XmldbClientDatabase

Method Detail

newDefaultDatabase

public static org.xmldb.api.base.Database newDefaultDatabase()
                                                      throws org.xmldb.api.base.XMLDBException

Throws:

org.xmldb.api.base.XMLDBException

newDatabase

public static org.xmldb.api.base.Database newDatabase(java.lang.String endpointUrl)
                                               throws org.xmldb.api.base.XMLDBException

Throws:

org.xmldb.api.base.XMLDBException

init

public void init()
          throws org.xmldb.api.base.XMLDBException

Initializes the datbase

Throws:

org.xmldb.api.base.XMLDBException - All exception are caught and rethrown as one.

acceptsURI

public boolean acceptsURI(java.lang.String uri)
                   throws org.xmldb.api.base.XMLDBException

Determines if this Database accepts the specified URI

Specified by:

acceptsURI in interface org.xmldb.api.base.Database

Parameters:

uri - The URI to check.

Returns:

true if accepted, false otherwise.

Throws:

org.xmldb.api.base.XMLDBException - All exceptions are rethrown as one.

getCollection

public org.xmldb.api.base.Collection getCollection(java.lang.String uri,
                                                   java.lang.String userName,
                                                   java.lang.String password)
                                            throws org.xmldb.api.base.XMLDBException

Returns the specified collection.

Specified by:

getCollection in interface org.xmldb.api.base.Database

Parameters:

uri - The uri identifying the collection

password - The password associated with the user

userName - The user name

Returns:

The specified collection.

Throws:

org.xmldb.api.base.XMLDBException - All exceptions are rethrown as one.

getConformanceLevel

public java.lang.String getConformanceLevel()
                                     throws org.xmldb.api.base.XMLDBException

Returns the conformance level of the remote database interface.

Specified by:

getConformanceLevel in interface org.xmldb.api.base.Database

Returns:

The conformance level

Throws:

org.xmldb.api.base.XMLDBException - All exceptions are rethrown as one.

getName

public java.lang.String getName()
                         throws org.xmldb.api.base.XMLDBException

Deprecated. Use #getNames.

Returns The name.

Specified by:

getName in interface org.xmldb.api.base.Database

Returns:

A string

Throws:

org.xmldb.api.base.XMLDBException - All exceptions are rethrown as one.

getProperty

public java.lang.String getProperty(java.lang.String str)
                             throws org.xmldb.api.base.XMLDBException

Throws an exceptioin as ErrorCodes.NOT_IMPLEMENTED.

Specified by:

getProperty in interface org.xmldb.api.base.Configurable

Parameters:

str - Ignored

Returns:

Nothing, ever.

Throws:

org.xmldb.api.base.XMLDBException - Always with ErrorCodes.NOT_IMPLEMENTED

setProperty

public void setProperty(java.lang.String str,
                        java.lang.String str1)
                 throws org.xmldb.api.base.XMLDBException

Throws an exceptioin as ErrorCodes.NOT_IMPLEMENTED.

Specified by:

setProperty in interface org.xmldb.api.base.Configurable

Parameters:

str - Ignored

str1 - Ignored

Throws:

org.xmldb.api.base.XMLDBException - Always with ErrorCodes.NOT_IMPLEMENTED

getEndPointUrl

public java.lang.String getEndPointUrl()

Getter for property endPointUrl.

Returns:

Value of property endPointUrl.

setEndPointUrl

public void setEndPointUrl(java.lang.String endPointUrl)

Setter for property endPointUrl.

Parameters:

endPointUrl - New value of property endPointUrl.

getService

public org.apache.axis.client.Service getService()

Getter for property service.

Returns:

Value of property service.

setService

public void setService(org.apache.axis.client.Service service)

Setter for property service.

Parameters:

service - New value of property service.

getRemoteDatabaseUri

public java.lang.String getRemoteDatabaseUri()

Getter for property databaseUri.

Returns:

Value of property databaseUri.

setRemoteDatabaseUri

public void setRemoteDatabaseUri(java.lang.String remoteDatabaseUri)

Setter for property databaseUri.

Parameters:

remoteDatabaseUri - New value of property databaseUri.