Oracle | DBMS

Oracle DBMS_XDB Version 26ai

General Information

Library Note

Morgan's Library Page Header

The best Oracle News for FY2026

Oracle Database 26ai will be available on generic Linux platforms in January and soon on AIX and Windows

Purpose

The DBMS_XDB package supports the following features:

Resource Management subprograms which complement Resource Views
The Access Control List (ACL)-based Security Mechanism
Configuration Session Management
Creation of the XDB username

The DBMS_XDB package subprograms and constants are deprecated with Oracle Database 12c but still present in 23ai. While all features continue to be supported for backward compatibility, Oracle recommends that you use the alternative procedures provided in each case as identified below.

AUTHID CURRENT_USER

Constants

Name	Data Type	Value
DELETE Configurations
DELETE_RESOURCE	NUMBER	1
DELETE_RECURSIVE	NUMBER	2
DELETE_FORCE	NUMBER	3
DELETE_RECURSIVE_FORCE	NUMBER	4

DELETE_RES_METADATA_CASCADE	NUMBER	1
DELETE_RES_METADATA_NOCASCADE	NUMBER	2
setListenerEndPoint Arguments
XDB_ENDPOINT_HTTP	NUMBER	1
XDB_ENDPOINT_HTTP2	NUMBER	2
XDB_ENDPOINT_HTTPS	NUMBER	2
4th setListenerEndPoint argument
XDB_PROTOCOL_TCP	NUMBER	1
XDB_PROTOCOL_TCPS	NUMBER	2
Miscellaneous
DEFAULT_LOCK_TIMEOUT	PLS_INTEGER	(60 * 60)

LINK_TYPE_HARD	NUMBER	1
LINK_TYPE_WEAK	NUMBER	2
LINK_TYPE_SYMBOLIC	NUMBER	3

ON_DENY_NEXT_CUSTOM	NUMBER	1
ON_DENY_BASIC	NUMBER	2

Dependencies

DBMS_ASSERT	DBMS_XDBUTIL_INT	GET_XDB_TABLESPACE
DBMS_CUBE_PRVTEXP	DBMS_XDB_CONFIG	LOCKTOKENLISTTYPE
DBMS_EPG	DBMS_XDB_LIB	XDB$ROOT_INFO_V
DBMS_LOB	DBMS_XDB_REPOS	XDB_MIGRATESCHEMA
DBMS_XDBRESOURCE	DBMS_XMLDOM	XMLTYPE
DBMS_XDBT	DUAL

Documented Yes

First Available Not Known

Security Model Owned by XDB with EXECUTE granted to PUBLIC

Source {ORACLE_HOME}/rdbms/admin/dbmsxdb.sql

Subprograms

ACLCHECKPRIVILEGES	DELETERESOURCE	GETXDB_TABLESPACE
ADDHTTPEXPIREMAPPING	DELETERESOURCEMETADATA	HASBLOBCONTENT
ADDMIMEMAPPING	DELETESCHEMALOCMAPPING	HASCHARCONTENT
ADDRESOURCE	DELETESERVLET	HASXMLCONTENT
ADDSCHEMALOCMAPPING	DELETESERVLETMAPPING	HASXMLREFERENCE
ADDSERVLET	DELETESERVLETSECROLE	ISFOLDER
ADDSERVLETMAPPING	DELETEXMLEXTENSION	LINK
ADDSERVLETSECROLE	EXISTSRESOURCE	LOCKDISCOVERY
ADDTOLOCKTOKENLIST	GETACLDOCUMENT	LOCKRESOURCE
ADDXMLEXTENSION	GETCONTENTBLOB	PROCESSLINKS
APPENDRESOURCEMETADATA	GETCONTENTCLOB	PURGERESOURCEMETADATA
CFG_GET	GETCONTENTVARCHAR2	REFRESHCONTENTSIZE
CFG_REFRESH	GETCONTENTXMLREF	REFRESHLOCK
CFG_UPDATE	GETCONTENTXMLTYPE	RENAMERESOURCE
CHANGEOWNER	GETFTPPORT	SETACL
CHANGEPRIVILEGES	GETHTTPPORT	SETFTPPORT
CHECKPRIVILEGES	GETHTTPREQUESTHEADER	SETHTTPPORT
CREATEFOLDER	GETLISTENERENDPOINT	SETLISTENERENDPOINT
CREATEOIDPATH	GETLOCKTOKEN	SETLISTENERLOCALACCESS
CREATERESOURCE	GETLOCKTOKENLIST	TOUCHRESOURCE
DELETEFROMLOCKTOKENLIST	GETPRIVILEGES	UNLOCKRESOURCE
DELETEHTTPEXPIREMAPPING	GETRESOID	UPDATERESOURCEMETADATA
DELETEMIMEMAPPING	GETRESOURCE

ACLCHECKPRIVILEGES

Checks the access privileges granted by specified ACL document dbms_xdb.ACLCheckPrivileges( acl_path IN VARCHAR2, owner IN VARCHAR2, privs IN XMLTYPE) RETURN PLS_INTEGER;

Deprecated in 12c

CFG_REFRESH

Refresh configuration dbms_xdb.cfgRefresh;

Deprecated in 12c: Use 
      DBMX_XDB_CONFIG.CFG_REFRESH

      

      exec dbms_xdb.cfgRefresh;

GETFTPPORT

Returns the FTP Port dbms_xdb.getFTPPort RETURN NUMBER;

Deprecated in 12c: Use 
      DBMS_XDB_CONFIG.GETFTPPORT

      

      SELECT dbms_xdb.getFTPPort;

      

      GETFTPPORT

      ----------

               0

      

      exec dbms_xdb.setFTPPort(20);

      

      SELECT dbms_xdb.getFTPPort;

      

      GETFTPPORT

      ----------

              20

GETHTTPPORT

Returns the HTMLDB Port dbms_xdb.getHTTPPort;

Deprecated in 12c: Use 
      DBMS_XDB_CONFIG.GETHTTPPORT

      

      SELECT dbms_xdb.getHTTPPort;

      

      GETHTTPPORT

      -----------

            8080

GETHTTPREQUESTHEADER

Returns the values of the passed header if called during an HTTP request dbms_xdb.getHTTPRequestHeader(header_name IN VARCHAR2) RETURN VARCHAR2;

set serveroutput on

    

      DECLARE

       rqhdr VARCHAR2(100);

      BEGIN

        rqhdr := dbms_xdb.getHTTPRequestHeader('UWHeader');

        dbms_output.put_line(rqhdr);

      END;

      /

GETLISTENERENDPOINT

Retrieves the parameters of a listener end point corresponding to the XML DB HTTP server. The parameters of both HTTP and HTTP2 end points can be retrieved by invoking this procedure. dbms_xdb.getListenerEndPoint( endpoint IN NUMBER, host OUT VARCHAR2, port OUT NUMBER, protocol OUT NUMBER);

Deprecated in 12c: Use DBMS_XDB_CONFIG.GETLISTENERENDPOINT

SETFTPPORT

Set the FTP Port dbms_xdb.setFTPPort(newport IN NUMBER);

Deprecated in 12c: Use DBMS_XDB_CONFIG.SETFTPPORT

      

      See getFTPPort Demo Above

SETHTTPPORT

Sets the HTMLDB Port dbms_xdb.setHTTPPort(newport IN NUMBER);

Deprecated in 12c: Use DBMS_XDB_CONFIG.SETHTTPPORT

      

      exec dbms_xdb.setHTTPPort(8081);

SETLISTENERENDPOINT

Sets the parameters of a listener end point corresponding to the XML DB HTTP server. Both HTTP and HTTP2 end points can be set by invoking this procedure. dbms_xdb.setListenerEndPoint( endpoint IN NUMBER, host IN VARCHAR2, port IN NUMBER, protocol IN NUMBER);

Deprecated in 12c: Use DBMS_XDB_CONFIG.SETLISTENERENDPOINT

SETLISTENERLOCALACCESS

Restricts listener end points of the XML DB HTTP server to listen only on the localhost interface if TRUE or to all listener end points if FALSE. dbms_xdb.setListenerLocalAccess(l_access IN BOOLEAN);

Deprecated in 12c: Use DBMS_XDB_CONFIG.SETLISTENERLOCALACCESS

      

      exec dbms_xdb.setListenerLocalAccess(TRUE);