112
DBMS_XDBZ

The DBMS_XDBZ package controls the Oracle XML DB repository security, which is based on Access Control Lists (ACLs).

This chapter contains the following topic:

• Summary of DBMS_XDBZ Subprograms

  See Also: Oracle XML DB Developer's Guide

---

Summary of DBMS_XDBZ Subprograms

Table 112-1  DBMS_XDBZ Package Subprograms

Method	Description
DISABLE_HIERARCHY Procedure	Disables repository support for the specified XMLType table or view
ENABLE_HIERARCHY Procedure	Enables repository support for the specified XMLType table or view
GET_ACLOID Function	Retrieves the ACL Object ID for the specified resource
GET_USERID Function	Retrieves the user ID for the specified user
IS_HIERARCHY_ENABLED Function	Determines if repository support for the specified XMLType table or view is enabled
PURGELDAPCACHE Function	Purges the LDAP nickname cache

---

DISABLE_HIERARCHY Procedure

This procedure disables repository support for a particular XMLType table or view.

Syntax

DBMS_XDBZ.DISABLE_HIERARCHY(
   object_schema IN VARCHAR2,
   object_name   IN VARCHAR2);

Parameters

Table 112-2 DISABLE_HIERARCHY Procedure Parameters

Parameter	Description
object_schema	The schema name of the XMLType table or view.
object_name	The name of the XMLType table or view.

---

ENABLE_HIERARCHY Procedure

This procedure enables repository support for a particular XMLType table or view. This allows the use of a uniform ACL-based security model across all documents in the repository.

Syntax

DBMS_XDBZ.ENABLE_HIERARCHY(
   object_schema   IN   VARCHAR2,
   object_name     IN   VARCHAR2);

Parameters

Table 112-3 ENABLE_HIERARCHY Procedure Parameters

Parameter	Description
object_schema	The schema name of the XMLType table or view.
object_name	The name of the XMLType table or view.

---

GET_ACLOID Function

This function retrieves the ACL Object ID for the specified resource, if the repository path is known.

Syntax

DBMS_XDBZ.GET_ACLOID(
   aclpath   IN   VARCHAR2,
   acloid    OUT  RAW)
 RETURN BOOLEAN;

Parameters

Table 112-4 GET_ACLOID Function Parameters

Parameter	Description
aclpath	ACL resource path for the repository.
acloid	The returned Object ID.

Return Values

Returns TRUE if successful.

---

GET_USERID Function

This function retrieves the user ID for the specified user name. The local database is searched first, and if found, the USERID is returned in 4-byte database format. Otherwise, the LDAP directory is searched, if available, and if found, the USERID is returned in 4-byte database format.

Syntax

DBMS_XDBZ.GET_USERID(
   username IN  VARCHAR2,
   userid   OUT RAW,
   format   IN  BINARY_INTEGER := NAME_FORMAT_SHORT)
 RETURN BOOLEAN;

Parameters

Table 112-5 GET_USERID Function Parameters

Parameter	Description
username	Name of the database or LDAP user.
userid	Return parameter for the matching user id.
format	Format of the specified user name; valid options are: DBMS_XDBZ.NAME_FORMAT_SHORT (default) -- DB user name or LDAP nickname DBMS_XDBZ.NAME_FORMAT_DISTINGUISHIED -- LDAP distinguished name.

Return Values

Returns TRUE if successful.

---

IS_HIERARCHY_ENABLED Function

This function determines if repository support for the specified XMLType table or view is enabled.

Syntax

DBMS_XDBZ.IS_HIERARCHY_ENABLED(
   object_schema IN VARCHAR2,
   object_name   IN VARCHAR2)
 RETURN BOOLEAN;

Parameters

Table 112-6 IS_HIERARCHY_ENABLED Function Parameters

Parameter	Description
object_schema	The schema name of the XMLType table or view.
object_name	The name of the XMLType table or view.

Return Values

Returns TRUE if enabled.

---

PURGELDAPCACHE Function

This function purges the LDAP nickname cache. Returns TRUE if successful.

Syntax

DBMS_XDBZ.PURGELDAPCACHE
 RETURN BOOLEAN;