23
Package oracle.xdb.spi

This chapter documents package oracle.xdb.spi. The classes contained in oracle.xdb.spi implement the service provider drivers that provide the application with common access to JNDI and JDBC interfaces.

This chapter contains these sections:

• Package oracle.xdb.spi Description
• Package oracle.xdb.spi Class Summary

---

Package oracle.xdb.spi Description

The classes contained in oracle.xdb.spi implement the JNDI API and the JNDI service provider drivers that provide the application with access to file systems and standard Web protocols.

• JNDI (Java Naming and Directory Interface) is the API for connecting Java programs to naming and directory services such as DNS, LDAP and NDS.
• JNDI SPI (Service Provider Interface) is the API for writing directory drivers.
• JDBC (Java DataBase Connectivity) is a programming interface that enables Java applications to access a database using the SQL language. JDBC is the Java counterpart of Microsoft's ODBC.

The application is written to the JNDI API, and the directory drivers are written to the JNDI SPI (Service Provider Interface). The package oracle.xdb.spi contains Oracle-specific extensions to the public standard.

In this release, the Oracle XML DB implementation of JNDI SPI supports the javax.naming interface. Directory, attribute, and event operations are not yet supported.

---

Package oracle.xdb.spi Class Summary

The classes in oracle.xdb.spi implement core JNDI and JNDI SPI interfaces for Oracle XML DB.

Table 23-1  Classes in package oracle.xdb.spi

Class	Description
XDBContext Class	Implements the javax.naming.context interface
XDBContextFactory Class	Implements javax.naming.spi.InitialContextFactory
XDBNameParser Class	Implements javax.naming.NameParser
XDBNamingEnumeration Class	Implements javax.naming.NamingEnumeration
XDBResource Class	Implements the core features for the Oracle XML DB JNDI service provider interface (SPI)
XDBResourceContext Class	Implements javax.naming.context

---

XDBContext Class

Description of XDBContext

This class implements the Java naming and context interface for Oracle XML DB, which extends javax.naming.context. The current implementation has no federation support, which makes it completely unaware of the existence of other namespaces.

Syntax of XDBContext

public class XDBContext
 
oracle.xdb.spi.XDBContext

---

Methods

XDBContext()

Description

Constructor for class XDBContext. The options are listed in the following table.

Syntax	Parameters
public XDBContext(java.util.Hashtable env)	Takes the environment to the resource.
public XDBContext(java.util.Hashtable env, java.lang.String path)	Takes the environment and path to the resource.

Parameters

env - environment to describe the properties of context.

path - initial path for the context.

---

XDBContextFactory Class

Description of XDBContextFactory

This class implements javax.naming.context .

Syntax of XDBContextFactory

public class XDBContextFactory
 
oracle.xdb.spi.XDBContextFactory

---

Constructors

XDBContextFactory()

Description

Constructor for class XDBContextFactory

Syntax

public  XDBContextFactory()

---

XDBNameParser Class

Description

Implements javax.naming.NameParser

Syntax

public class XDBNameParser
 
oracle.xdb.spi.XDBNameParser

---

XDBNamingEnumeration Class

Description

Implements javax.naming.NamingEnumeration

Syntax

public class XDBNamingEnumeration
 
oracle.xdb.spi.XDBNamingEnumeration

---

XDBResource Class

Description

This class implements the core features for the Oracle XML DB JNDI service provider interface (SPI). The current implementation has no federation support, being completely unaware of the existence of other namespaces.

Syntax

public class XDBResource extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xdb.spi.XDBResource

---

Methods

Table 23-2  Methods of XDBResource

Method	Description
XDBResource(Hashtable)	Takes the environment and path to the resource
XDBResource(Hashtable, String)	Takes the environment and path to the resource as a string.
getAuthor()	Returns author of the resource.
getComment()	Returns the DAV comment of the resource.
getContent()	Returns the content of the resource.
getContentType()	Returns the content type of the resource.
getCreateDate()	Returns the create date of the resource.
getDisplayName()	Returns the display name of the resource.
getLanguage()	Returns the language of the resource.
getLastModDate()	Returns the last modification date of the resource.
getOwnerId()	Returns the owner ID of the resource.
setACL(String)	Sets the ACL on the resource.
setAuthor(String)	Sets the author of the resource.
setComment(String)	Sets the DAV comment of the resource.
setContent(Object)	Sets the content of the resource.
setContentType(String)	Sets the content type of the resource.
setCreateDate(Date)	Sets the creation date of the resource.
setDisplayName(String)	Sets the display name of the resource.
setInheritedACL(String)	Sets the ACL on the resource.
setLanguage(String)	Sets the language of the resource.
setLastModDate(Date)	Sets the last modification date of the resource.
setOwnerId(long)	Sets the owner ID of the resource.

XDBResource(Hashtable)

Description

Takes the environment and path to the resource.

Syntax

public  XDBResource(java.util.Hashtable env)

Parameters

env - Environment passed in

path - Path to the resource

XDBResource(Hashtable, String)

Description

Takes the environment and path to the resource as a string.

Syntax

public  XDBResource(java.util.Hashtable env, java.lang.String path)

getAuthor()

Description

Returns the author of the resource

Syntax

public java.lang.String getAuthor()

getComment()

Description

Returns the DAV comment of the resource (DAV is for Web distributed authoring and versioning)

Syntax

public java.lang.String getComment()

getContent()

Description

Returns the content of the resource

Syntax

public java.lang.Object getContent()

getContentType()

Description

Returns the content type of the resource

Syntax

public java.lang.String getContentType()

getCreateDate()

Description

Returns the creation date of the resource

Syntax

public java.util.Date getCreateDate()

getDisplayName()

Description

Returns the display name of the resource

Syntax

public java.lang.String getDisplayName()

getLanguage()

Description

Returns the Language of the resource

Syntax

public java.lang.String getLanguage()

getLastModDate()

Description

Returns the last modification date of the resource

Syntax

public java.util.Date getLastModDate()

getOwnerId()

Description

Returns the owner id of the resource

Syntax

public long getOwnerId()

setACL(String)

Description

Sets the ACL on the resource

Syntax

public void setACL(java.lang.String aclpath)

Parameters

aclpath - the path to the ACL resource

setAuthor(String)

Description

Sets the author of the resource

Syntax

public void setAuthor(java.lang.String authname)

Parameters

authname - author of the resource

setComment(String)

Description

Sets the DAV comment of the resource (for Web distributed authoring and versioning)

Syntax

public void setComment(java.lang.String davcom)

Parameters

davcom - DAV comment of the resource

setContent(Object)

Description

Sets the content of the resource

Syntax

public void setContent(java.lang.Object xmlobj)

Parameters

xmlobj - content of the resource

setContentType(String)

Description

Sets the content type of the resource

Syntax

public void setContentType(java.lang.String conttype)

Parameters

conttype - content type of the resource

setCreateDate(Date)

Description

Sets the creation date of the resource

Syntax

public void setCreateDate(java.util.Date credate)

Parameters

credate - creation date of the resource

setDisplayName(String)

Description

Sets the display name of the resource

Syntax

public void setDisplayName(java.lang.String dname)

Parameters

dname - display name of the resource

setInheritedACL(String)

Description

Sets the ACL on the resource, the ACL is copied from the specified resource.

Syntax

public void setInheritedACL(java.lang.String aclpath)

Parameters

aclpath - path to the ACL to be set

setLanguage(String)

Description

Sets the language of the resource

Syntax

public void setLanguage(java.lang.String lang)

Parameters

lang - language of the resource

setLastModDate(Date)

Description

Sets the last modification date of the resource

Syntax

public void setLastModDate(java.util.Date d)

Parameters

d - last modification date of the resource

setOwnerId(long)

Description

Sets the owner id of the resource

Syntax

public void setOwnerId(long ownerid)

Parameters

ownerid - owner id of the resource

---

XDBResourceContext Class

Description of XDBResourceContext

This class provides core Oracle XML DB features for JNDI SPI. The current implementation has no federation support, being completely unaware of the existence of other namespaces. This class implements javax.naming.context.

Syntax of XDBResourceContext

public class XDBResourceContext extends oracle.xdb.spi.XDBBaseContext
 
oracle.xdb.spi.XDBBaseContext
  |
  +--oracle.xdb.spi.XDBResourceContext

---

Methods of XDBResourceContext

Table 23-3  Methods of XDBResourceContext

Method	Description
XDBResourceContext(Hashtable)	Implements the environment.
getAuthor()	Returns author of the resource
getContentType()	Returns content type of the resource
getCreateDate()	Returns creation date of the resource
getDavComment()	Returns the DAV comment of the resource
getDisplayName()	Returns the display name of the resource
getEnvironment()	Returns a copy of the environment of this context
getLanguage()	Returns the language of the resource
getLastModDate()	Returns last modification date of the resource
getOwnerId()	Returns the owner ID of the resource
setAuthor(String)	Sets the author of the resource
setContentType(String)	Sets the content type of the resource
setCreateDate(Date)	Sets the creation date of the resource
setDavComment(String)	Sets the DAV comment of the resource
setDisplayName(String)	Sets the display name of the resource
setLanguage(String)	Sets the language of the resource
setLastModDate(Date)	Sets the last modification date of the resource
setOwnerId(long)	Sets the owner ID of the resource.

XDBResourceContext(Hashtable)

Description

Implements the environment.

Syntax

public   XDBResourceContext(java.util.Hashtable env)

Parameters

env - Environment for the context

getAuthor()

Description

Returns the author of the resource

Syntax

public java.lang.String getAuthor()

getContentType()

Description

Returns the content type of the resource

Syntax

public java.lang.String getContentType()

getCreateDate()

Description

Returns the creation date of the resource

Syntax

public java.util.Date getCreateDate()

getDavComment()

Description

Returns the DAV comment of the resource

Syntax

public java.lang.String getDavComment()

getDisplayName()

Description

Returns the display name of the resource

Syntax

public java.lang.String getDisplayName()

getEnvironment()

Description

Retrieves the environment properties for this context. The result is a new copy of the environment; changes made to the returned object have no effect on the context.

Syntax

public java.util.Hashtable getEnvironment()

Overrides

XDBBaseContext.getEnvironment() in class XDBBaseContext

Returns

a copy of the environment of this context

getLanguage()

Description

Returns the Language of the resource

Syntax

public java.lang.String getLanguage()

getLastModDate()

Description

Returns the last modification date of the resource

Syntax

public java.util.Date getLastModDate()

getOwnerId()

Description

Returns the owner id of the resource

Syntax

public long getOwnerId()

setAuthor(String)

Description

Sets the author of the resource

Syntax

public void setAuthor(java.lang.String authname)

Parameters

authname - author of the resource

setContentType(String)

Description

Sets the content type of the resource

Syntax

public void setContentType(java.lang.String conttype)

Parameters

conttype - content type of the resource

setCreateDate(Date)

Description

Sets the creation date of the resource

Syntax

public void setCreateDate(java.util.Date credate)

Parameters

credate - creation date of the resource

setDavComment(String)

Description

Sets the DAV comment of the resource

Syntax

public void setDavComment(java.lang.String davcom)

Parameters

davcom - DAV comment of the resource

setDisplayName(String)

Description

Sets the display name of the resource

Syntax

public void setDisplayName(java.lang.String dname)

Parameters

dname - display name of the resource

setLanguage(String)

Description

Sets the language of the resource

Syntax

public void setLanguage(java.lang.String lang)

Parameters

lang - language of the resource

setLastModDate(Date)

Description

Sets the last modification date of the resource

Syntax

public void setLastModDate(java.util.Date d)

Parameters

d - last modification date of the resource

setOwnerId(long)

Description

Sets the owner id of the resource

Syntax

public void setOwnerId(long ownerid)

Parameters

ownerid - owner ID of the resource