23
Resource APIs for Java/JNDI

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.

The classes contained in oracle.xdb.spi implement the service provider drivers that provide the application with common access to Java Naming and Directory Interface (JNDI). JNDI is a programming interface from Sun for connecting Java programs to naming and directory services such as DNS, LDAP and NDS. JNDI (Java Naming and Directory Interface) is a programming interface from Sun for connecting Java programs to naming and directory services such as DNS, LDAP and NDS.

The application is written to the JNDI API, and the directory drivers are written to the JNDI SPI (Service Provider Interface). The classes in oracle.xdb.spi implement core JNDI SPI interfaces and WebDAV support for Oracle XML DB.

This chapter contains these sections:

• XDBContext Class
• XDBContextFactory Class
• XDBNameParser Class
• XDBNamingEnumeration Class
• XDBResource Class

  See Also: Oracle9i XML Database Developer's Guide - Oracle XML DB Oracle9i Supplied Java Packages Reference

---

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 of XDBContext

XDBContext()

Description

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

Syntax	Description
public XDBContext( Hashtable env);	Creates an instance of XDBContext class given the environment.
public XDBContext( Hashtable env, String path);	Creates an instance of XDBContext class given the environment and path.

Parameter	Description
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

---

Methods of XDBContextFactory

XDBContextFactory()

Description

Constructor for class XDBContextFactory.

Syntax

public  XDBContextFactory();

---

XDBNameParser Class

---

Description of XDBNameParser

Implements javax.naming.NameParser

---

Syntax of XDBNameParser

public class XDBNameParser
oracle.xdb.spi.XDBNameParser

---

XDBNamingEnumeration Class

---

Description of XDBNamingEnumeration

Implements javax.naming.NamingEnumeration

---

Syntax of XDBNamingEnumeration

public class XDBNamingEnumeration
oracle.xdb.spi.XDBNamingEnumeration

---

XDBResource Class

---

Description of XDBResource

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 of XDBResource

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

---

Methods of XDBResource

Table 23-1 Summary of  Methods of XDBResource  

Method	Description
XDBResource()	Creates a new instance of XDBResource.
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()	Sets the ACL on the resource.
setAuthor()	Sets the author of the resource.
setComment()	Sets the DAV comment of the resource.
setContent()	Sets the content of the resource.
setContentType()	Sets the content type of the resource.
setCreateDate()	Sets the creation date of the resource.
setDisplayName()	Sets the display name of the resource.
setLanguage()	Sets the language of the resource.
setLastModDate()	Sets the last modification date of the resource.
setOwnerId()	Sets the owner ID of the resource.

XDBResource()

Description

Creates a new instance of XDBResource. The options are described in the following table.

Syntax	Description
public XDBResource( Hashtable env);	Creates a new instance of XDBResource given the environment.
public XDBResource( Hashtable env, String path);	Creates a new instance of XDBResource given the environment and path.

Parameter	Description
env	Environment passed in.
path	Path to the resource

getAuthor()

Description

Retrieves the author of the resource.

Syntax

public String getAuthor();

getComment()

Description

Retrieves the DAV (Web Distributed Authoring and Versioning) comment of the resource.

Syntax

public String getComment();

getContent()

Description

Returns the content of the resource.

Syntax

public Object getContent();

getContentType()

Description

Returns the content type of the resource.

Syntax

public String getContentType();

getCreateDate()

Description

Returns the creation date of the resource.

Syntax

public Date getCreateDate();

getDisplayName()

Description

Returns the display name of the resource.

Syntax

public String getDisplayName();

getLanguage()

Description

Returns the Language of the resource.

Syntax

public String getLanguage();

getLastModDate()

Description

Returns the last modification date of the resource.

Syntax

public Date getLastModDate();

getOwnerId()

Description

Returns the owner id of the resource. The owner id value expected by this method is the user id value for the database user as provided by the catalog views such as ALL_USERS, and so on.

Syntax

public long getOwnerId();

setACL()

Description

Sets the ACL on the resource.

Syntax

public void setACL( String aclpath);

Parameter	Description
aclpath	The path to the ACL resource.

setAuthor()

Description

Sets the author of the resource.

Syntax

public void setAuthor( String authname);

Parameter	Description
authname	Author of the resource.

setComment()

Description

Sets the DAV (Web Distributed Authoring and Versioning) comment of the resource.

Syntax

public void setComment(String davcom);

Parameter	Description
davcom	DAV comment of the resource.

setContent()

Description

Sets the content of the resource.

Syntax

public void setContent( Object xmlobj);

Parameter	Description
xmlobj	Content of the resource.

setContentType()

Description

Sets the content type of the resource.

Syntax

public void setContentType( String conttype);

Parameter	Description
conttype	Content type of the resource.

setCreateDate()

Description

Sets the creation date of the resource.

Syntax

public void setCreateDate( Date credate);

Parameter	Description
credate	Creation date of the resource.

setDisplayName()

Description

Sets the display name of the resource

Syntax

public void setDisplayName( String dname);

Parameter	Description
dname	Display name of the resource.

setLanguage()

Description

Sets the language of the resource.

Syntax

public void setLanguage(String lang);

Parameter	Description
lang	Language of the resource.

setLastModDate()

Description

Sets the last modification date of the resource.

Syntax

public void setLastModDate( Date d);

Parameter	Description
d	Last modification date of the resource.

setOwnerId()

Description

Sets the owner id of the resource. The owner id value expected by this method is the user id value for the database user as provided by the catalog views such as ALL_USERS, and so on.

Syntax

public void setOwnerId( long ownerid);

Parameter	Description
ownerid	Owner id of the resource.