| Oracle® Database PL/SQL Packages and Types Reference 11g Release 1 (11.1) Part Number B28419-01 |
|
|
View PDF |
| Oracle® Database PL/SQL Packages and Types Reference 11g Release 1 (11.1) Part Number B28419-01 |
|
|
View PDF |
The DBMS_XDBZ package controls the Oracle XML DB repository security, which is based on Access Control Lists (ACLs).
This chapter contains the following topics:
Constants
Summary of DBMS_XDBZ Subprograms
See Also:
Oracle XML DB Developer's GuideThis section contains topics which relate to using the DBMS_XDBZ package.
The DBMS_XDBZ package uses the constants shown in following tables.
Table 153-1 DBMS_XDBZ Constants - Name Format
| Constant | Type | Value | Description |
|---|---|---|---|
| NAME_FORMAT_SHORT | PLS_INTEGER |
1 |
DB user name or LDAP nickname |
| NAME_FORMAT_DISTINGUISHED | PLS_INTEGER |
2 |
LDAP distinguished name |
Table 153-2 DBMS_XDBZ Constants - Enable Option
| Constant | Type | Value | Description |
|---|---|---|---|
| ENABLE_CONTENTS | PLS_INTEGER |
1 |
Enables hierarchy for contents and is used by users when calling the ENABLE_HIERARCHY Procedure |
ENABLE_RESMETADATA |
PLS_INTEGER |
2 |
Enables hierarchy for resource metadata, that is, this table will store schema based custom metadata for resources |
Table 153-3 DBMS_XDBZ Constants - Enable Option Exercised
| Constant | Type | Value | Description |
|---|---|---|---|
IS_ENABLED_CONTENTS |
PLS_INTEGER |
1 |
If hierarchy was enabled for contents, that is, the ENABLE_HIERARCHY Procedurewas called with hierarchy_type as ENABLE_CONTENTS |
IS_ENABLED_RESMETADATA |
PLS_INTEGER |
2 |
If hierarchy was enabled for resource metadata, that is, the ENABLE_HIERARCHY Procedure was called with hierarchy_type as ENABLE_RESMETADATA |
Table 153-4 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 |
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 153-5 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 |
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.
See Also:
Oracle XML DB Developer's Guide for more information aboutSyntax
DBMS_XDBZ.ENABLE_HIERARCHY( object_schema IN VARCHAR2, object_name IN VARCHAR2, hierarchy_type IN PLS_INTEGER := DBMS_XDBZ.ENABLE_CONTENTS);
Parameters
Table 153-6 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 |
hierarchy_type |
How to enable the hierarchy.
If this subprogram is called on a table, another call will have no effect. Note that you cannot enable hierarchy for both contents and resource metadata. |
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 153-7 GET_ACLOID Function Parameters
| Parameter | Description |
|---|---|
aclpath |
ACL resource path for the repository |
acloid |
The returned Object ID |
Return Values
Returns TRUE if successful.
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 153-8 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:
|
Return Values
Returns TRUE if successful.
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, hierarchy_type IN PLS_INTEGER := IS_ENABLED_CONTENTS) RETURN BOOLEAN;
Parameters
Table 153-9 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 |
hierarchy_type |
The type of hierarchy to check for.
|
Return Values
Returns TRUE if the given XMLTYPE table or view has the XDB Hierarchy enabled with the specified type.
This function purges the LDAP nickname cache. Returns TRUE if successful.
Syntax
DBMS_XDBZ.PURGELDAPCACHE RETURN BOOLEAN;
