Oracle | DBMS_XDB

Oracle DBMS_XDB_CONFIG Version 21c

General Information

Library Note

Morgan's Library Page Header

ACE Director Alum Daniel Morgan, founder of Morgan's Library, is scheduling complimentary technical Workshops on Database Security for the first 30 Oracle Database customers located anywhere in North America, EMEA, LATAM, or APAC that send an email to asra_us@oracle.com. Request a Workshop for your organization today.

Purpose Provides an interface for configuring Oracle XML DB and via its repository table xdb.xdb$config

AUTHID CURRENT_USER

Constants

Name	Data Type	Value
Constant number for 1st argument of setListenerEndPoint
XDB_ENDPOINT_HTTP	NUMBER	1
XDB_ENDPOINT_HTTP2	NUMBER	2
Constant number for 4th argument of setListenerEndPoint
XDB_PROTOCOL_TCP	NUMBER	1
XDB_PROTOCOL_TCPS	NUMBER	2
ON_DENY_NEXT_CUSTOM	NUMBER	1
ON_DENY_BASIC CONSTANT	NUMBER	2

Dependencies

DBMS_ASSERT	DBMS_STANDARD	DUAL
DBMS_GSM_CLOUDADMIN	DBMS_XDB	XDB$ROOT_INFO_V
DBMS_GSM_XDB	DBMS_XDB_LIB	XDB_REALM_VIEW
DBMS_PRIV_CAPTURE	DBMS_XMLDOM	XMLTYPE

Documented Yes

Exceptions

Error Code	Reason
ORA-30952	Illegal configuration of HTTP/HTTPS in xdbconfig.xml

First Available Not known

Security Model Owned by XDB with EXECUTE granted to PUBLIC

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

Subprograms

ADDAUTHENTICATIONMAPPING	DELETEDEFAULTTYPEMAPPINGS	GETHTTPSPORT
ADDAUTHENTICATIONMETHOD	DELETEHTTPEXPIREMAPPING	GETLISTENERENDPOINT
ADDDEFAULTTYPEMAPPINGS	DELETEMIMEMAPPING	GETREMOTEHTTPPORT
ADDHTTPEXPIREMAPPING	DELETESCHEMALOCMAPPING	GETREMOTEHTTPSPORT
ADDMIMEMAPPING	DELETESERVLET	ISGLOBALPORTENABLED
ADDSCHEMALOCMAPPING	DELETESERVLETMAPPING	SETDEFAULTTYPEMAPPINGS
ADDSERVLET	DELETESERVLETSECROLE	SETDYNAMICGROUPSTORE
ADDSERVLETMAPPING	DELETETRUSTMAPPING	SETFTPPORT
ADDSERVLETSECROLE	DELETETRUSTSCHEME	SETGLOBALPORTENABLED
ADDTRUSTMAPPING	DELETEXMLEXTENSION	SETHTTPCONFIGREALM
ADDTRUSTSCHEME	ENABLECUSTOMAUTHENTICATION	SETHTTPPORT
ADDXMLEXTENSION	ENABLECUSTOMTRUST	SETHTTPSPORT
CFG_GET	ENABLEDIGESTAUTHENTICATION	SETLISTENERENDPOINT
CFG_REFRESH	GETFTPPORT	SETLISTENERLOCALACCESS
CFG_UPDATE	GETHTTPCONFIGREALM	SETREMOTEHTTPPORT
CLEARHTTPDIGESTS	GETHTTPPORT	SETREMOTEHTTPSPORT
DELETEAUTHENTICATIONMAPPING	GETHTTPREQUESTHEADER	USEDPORT
DELETEAUTHENTICATIONMETHOD

ADDAUTHENTICATIONMAPPING

Adds a mapping from the authentication method name to a URL pattern (in xdb.xdb$config) dbms_xdb_config.addAuthenticationMapping( addAuthenticationMapping(pattern IN VARCHAR2, name IN VARCHAR2, user_prefix IN VARCHAR2 := NULL, on_deny IN NUMBER := NULL); PRAGMA SUPPLEMENTAL_LOG_DATA(addAuthenticationMapping, UNSUPPORTED_WITH_COMMIT);

TBD

ADDAUTHENTICATIONMETHOD

Adds to xdb.xdb$config a custom authentication method entry dbms_xdb_config.addAuthenticationMethod( name IN VARCHAR2, description IN VARCHAR2, implement_schema IN VARCHAR2, implement_method IN VARCHAR2, language IN VARCHAR2 := 'PL/SQL'); PRAGMA SUPPLEMENTAL_LOG_DATA(addAuthenticationMethod, UNSUPPORTED_WITH_COMMIT);

CREATE OR REPLACE FUNCTION authfunc(uname IN VARCHAR2) RETURN BOOLEAN

      AUTHID DEFINER AS

      BEGIN

        RETURN TRUE;

      END authfunc;

      /

      

      exec dbms_xdb_config.addAuthenticationMethod('UWXDBAuth', 'Functionality Test', 'SYS', 'AUTHFUNC');

      

      SELECT *

      FROM xdb.xdb$config;

      

      -- review the XML in SQL*Plus for the <custom-authentication-list> section

ADDDEFAULTTYPEMAPPINGS

Undocumented dbms_xdb_config.addDefaultTypeMappings(version IN VARCHAR2 := 'pre-11.2');

exec dbms_xdb_config.addDefaultTypeMappings;

ADDHTTPEXPIREMAPPING

Adds to xdb.xdb$config a mapping of the URL pattern to an expiration date. This will control the Expire headers for URLs matching the pattern dbms_xdb_config.addHTTPExpireMapping( pattern IN VARCHAR2, expire IN VARCHAR2);

exec dbms_xdb_config.addHTTPExpireMapping('/public/test1/*', 'now plus 4 weeks');

      exec dbms_xdb_config.addHTTPExpireMapping('/public/test2/*', 'modification plus 1 day 30 seconds');

      

      SELECT * FROM xdb.xdb$config;

      

      -- find the following section in the output:

       <expire xmlns="https://xmlns.oracle.com/xdb/xdbconfig.xsd">

        <expire-mapping xmlns="https://xmlns.oracle.com/xdb/xdbconfig.xsd">

          <expire-pattern>/public/test1/*</expire-pattern>

          <expire-default>now plus 4 weeks</expire-default>

        </expire-mapping>

        <expire-mapping xmlns="https://xmlns.oracle.com/xdb/xdbconfig.xsd">

          <expire-pattern>/public/test2/*</expire-pattern>

          <expire-default>modification plus 1 day 30 seconds</expire-default>

        </expire-mapping>

      </expire>

      

      exec dbms_xdb_config.deleteHttpExpireMapping('*');

ADDMIMEMAPPING

Adds a mime mapping to the XDB configuration dbms_xdb_config.addMimeMapping( extension IN VARCHAR2, mimetype IN VARCHAR2);

exec xdb.dbms_xdb_config.addMimeMapping('avi', 'video/x-msvideo');

      

      SELECT * FROM xdb.xdb$config;

      

      -- find the following section in the output:

       <mime-mapping>

        <extension>avi</extension>

        <mime-type>video/x-msvideo</mime-type>

      </mime-mapping>

      

      exec xdb.dbms_xdb_config.deleteMimeMapping('avi');

ADDSCHEMALOCMAPPING

Adds a schema location mapping to the XDB configuration dbms_xdb_config.addSchemaLocMapping( namespace IN VARCHAR2, element IN VARCHAR2, schemaURL IN VARCHAR2);

TBD

ADDSERVLET

Adds a servelet to the XDB configuration dbms_xdb_config.addServlet( name IN VARCHAR2, language IN VARCHAR2, dispname IN VARCHAR2, icon IN VARCHAR2 := NULL, descript IN VARCHAR2 := NULL, class IN VARCHAR2 := NULL, jspfile IN VARCHAR2 := NULL, plsql IN VARCHAR2 := NULL, schema IN VARCHAR2 := NULL);

TBD

ADDSERVLETMAPPING

Adds a servelet mapping to the XDB configuration dbms_xdb_config.addSerletMapping( pattern IN VARCHAR2, name IN VARCHAR2);

TBD

ADDSERVLETSECROLE

Adds the following security role REF to a specified servlet in XDB configuration dbms_xdb_config.addServletSecRole( servname IN VARCHAR2, rolename IN VARCHAR2, rolelink IN VARCHAR2, descript IN VARCHAR2 := NULL);

TBD

ADDTRUSTMAPPING

Undocumented dbms_xdb_config.addTrustMapping( pattern IN VARCHAR2, auth_name IN VARCHAR2, trust_name IN VARCHAR2, user_prefix IN VARCHAR2 := NULL); PRAGMA SUPPLEMENTAL_LOG_DATA(addTrustMapping, UNSUPPORTED_WITH_COMMIT);

TBD

ADDTRUSTSCHEME

Undocumented dbms_xdb_config.addTrustScheme(name IN VARCHAR2, description IN VARCHAR2, session_user IN VARCHAR2, parsing_schema IN VARCHAR2, system_level IN BOOLEAN := TRUE, require_parsing_schema IN BOOLEAN := TRUE, allow_registration IN BOOLEAN := TRUE); PRAGMA SUPPLEMENTAL_LOG_DATA(addTrustScheme, UNSUPPORTED_WITH_COMMIT);

TBD

ADDXMLEXTENSION

Adds the appropriate XML extension to the XDB configuration dbms_xdb_config.addXMLExtension(extension IN VARCHAR2);

exec dbms_xdb_config.addXMLExtension('rels');

      

      SELECT * FROM xdb.xdb$config;

      

      -- find the following section in the output:

      <xml-extensions xmlns="https://xmlns.oracle.com/xdb/xdbconfig.xsd">

        <extension xmlns="https://xmlns.oracle.com/xdb/xdbconfig.xsd">rels</extension>

      </xml-extensions>

      

      exec dbms_xdb_config.deleteXMLExtension('rels');

CFG_GET

Returns the xdb configuration dbms_xdb_config.cfg_get RETURN sys.xmltype;

SELECT dbms_xdb_config.cfg_get

      FROM dual;

CFG_REFRESH

Refreshes the session configuration with the latest configuration dbms_xdb_config.cfg_refresh;

exec dbms_xdb_config.cfg_refresh;

      

      PL/SQL procedure successfully completed.

CFG_UPDATE

Updates the xdb configuration with the input xmltype document dbms_xdb_config.cfg_update(xdbconfig IN sys.XMLType);

TBD

CLEARHTTPDIGESTS

Clears the MD5 digests stored in sys.user$ dbms_xdb_config.ClearHTTPDigests;

exec dbms_xdb_config.ClearHTTPDigests;

      

      PL/SQL procedure successfully completed.

DELETEAUTHENTICATIONMAPPING

Deletes a mapping from the authentication method name to a URL pattern (from xdb$onfig) dbms_xdb_config.deleteAuthenticationMapping( pattern IN VARCHAR2, name IN VARCHAR2); PRAGMA SUPPLEMENTAL_LOG_DATA(deleteAuthenticationMapping, UNSUPPORTED_WITH_COMMIT);

TBD

DELETEAUTHENTICATIONMETHOD

Deletes from xdb.xdb$config a custom authentication method entry dbms_xdb_config.deleteAuthenticationMethod(name IN VARCHAR2); PRAGMA SUPPLEMENTAL_LOG_DATA(deleteAuthenticationMethod, UNSUPPORTED_WITH_COMMIT);

exec dbms_xdb_config.deleteAuthenticationMethod('ZZYZX');

      

      -- Note that this does not raise an exception even when the name provided does not exist.

DELETEDEFAULTTYPEMAPPINGS

Deletes the default type mappings from xdbconfig dbms_xdb_config.deleteDefaultTypeMappings;

exec deleteDefaultTypeMappings;

DELETEHTTPEXPIREMAPPING

Deletes from xdb.xdb$config all mappings of the URL pattern to an expiration date dbms_xdb_config.deleteHTTPExpireMapping(pattern IN VARCHAR2);

See addHTTPExpireMapping Demo Above

DELETEMIMEMAPPING

Deletes a mime mapping from xdb.xdb$config dbms_xdb_config.deleteMimeMapping(extension IN VARCHAR2);

See addMimeMapping Demo Above

DELETESCHEMALOCMAPPING

Delete a schema location mapping dbms_xdb_config.dleteSchemaLocMapping(schemaURL IN VARCHAR2);

TBD

DELETESERVLET

Delete a servlet dbms_xdb_config.deleteServlet(name IN VARCHAR2);

TBD

DELETESERVLETMAPPING

Delete a servlet mapping dbms_xdb_config.deleteServletMapping(name IN VARCHAR2);

TBD

DELETESERVLETSECROLE

Delete a security role ref from a servlet dbms_xdb_config.deleteServletSecRole( servname IN VARCHAR2, rolename IN VARCHAR2);

TBD

DELETETRUSTMAPPING

Undocumented dbms_xdb_config.deleteTrustMapping( pattern IN VARCHAR2, name IN VARCHAR2); PRAGMA SUPPLEMENTAL_LOG_DATA(deleteTrustMapping, UNSUPPORTED_WITH_COMMIT);

TBD

DELETETRUSTSCHEME

Undocumented dbms_xdb_config.deleteTrustScheme( name IN VARCHAR2, system_level IN BOOLEAN := TRUE); PRAGMA SUPPLEMENTAL_LOG_DATA(deleteTrustScheme, UNSUPPORTED_WITH_COMMIT);

TBD

DELETEXMLEXTENSION

Deletes an XML extension dbms_xdb_config.deleteXMLExtention(extension IN VARCHAR2);

See addXMLExtension Demo Above

ENABLECUSTOMAUTHENTICATION

Undocumented dbms_xdb_config.enableCustomAuthentication; PRAGMA SUPPLEMENTAL_LOG_DATA(enableCustomAuthentication, UNSUPPORTED_WITH_COMMIT);

exec dbms_xdb_config.enableCustomAuthentication;

ENABLECUSTOMTRUST

Undocumented dbms_xdb_config.enableCustomTrust; PRAGMA SUPPLEMENTAL_LOG_DATA(enableCustomTrust, UNSUPPORTED_WITH_COMMIT);

exec dbms_xdb_config.enableCustomTrust;

ENABLEDIGESTAUTHENTICATION

Enables digest authentication dbms_xdb_config.enableDigestAuthentication; PRAGMA SUPPLEMENTAL_LOG_DATA(enableDigestAuthentication, UNSUPPORTED_WITH_COMMIT);

exec dbms_xdb_config.enableDigestAuthentication;

GETFTPPORT

Returns the current value of FTP port dbms_xdb_config.getFTPPort RETURN NUMBER;

exec dbms_xdb_config.setFTPPort(20);

      

      SELECT dbms_xdb_config.getFTPPort

      FROM dual;

GETHTTPCONFIGREALM

Undocumented dbms_xdb_config.getHTTPConfigRealm RETURN VARCHAR2;

SELECT dbms_xdb_config.getHTTPConfigRealm

      FROM dual;

      

      GETHTTPCONFIGREALM

      -------------------

      XDB

GETHTTPPORT

gets the current value of HTTP port dbms_xdb_config.getHTTPPort RETURN NUMBER;

See SETHTTPPORT Demo Below

GETHTTPREQUESTHEADER

For custom authentication if called during an HTTP request serviced by XDB, returns the values of the passed header. Returns NULL if none is present. dbms_xdb_config.getHTTPRequestHeader(header_name IN VARCHAR2) RETURN VARCHAR2;

TBD

GETHTTPSPORT

Returns the current value of HTTPs port dbms_xdb_config.getHTTPsPort RETURN NUMBER;

See SETHTTPsPORT Demo Below

GETLISTENERENDPOINT

Returns 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_config.getListenerEndPoint( endpoint IN NUMBER, host OUT VARCHAR2, port OUT NUMBER, protocol OUT NUMBER);

exec dbms_xdb_config.setListenerEndPoint(dbms_xdb_config.xdb_endpoint_http2, 'Perrito5', 5500, dbms_xdb_config.xdb_protocol_tcp);

      

      DECLARE

       hval VARCHAR2(30);

       pval NUMBER;

       lval NUMBER;

      BEGIN

        dbms_xdb_config.getListenerEndPoint(dbms_xdb_config.xdb_endpoint_http2, hval, pval, lval);

        dbms_output.put_line('Host: ' || hval);

        dbms_output.put_line('Port: ' || TO_CHAR(pval));

        dbms_output.put_line('Protocol: ' || TO_CHAR(lval));

      END;

      /

GETREMOTEHTTPPORT

Returns the current value of remote HTTP port dbms_xdb_config.getRemoteHTTPPort;

SELECT dbms_xdb_config.getRemoteHTTPPort

      FROM dual;

      

      GETREMOTEHTTPPORT

      -----------------

      

      

      exec dbms_xdb_config.setRemoteHTTPPort(80);

      

      PL/SQL procedure successfully completed.

      

      SELECT dbms_xdb_config.getRemoteHTTPPort

      FROM dual;

      

      GETREMOTEHTTPPORT

      -----------------

                    
      80

GETREMOTEHTTPSPORT

Returns the current value of remote HTTPs (with SSL) port dbms_xdb_config.getRemoteHTTPSPort;

SELECT dbms_xdb_config.getRemoteHTTPSPort

      FROM dual;

      

      GETREMOTEHTTPSPORT

      ------------------

      

      

      exec dbms_xdb_config.setRemoteHTTPSPort(443);

      

      PL/SQL procedure successfully completed.

      

      SELECT dbms_xdb_config.getRemoteHTTPSPort

      FROM dual;

      

      GETREMOTEHTTPSPORT

      ------------------

                     443

ISGLOBALPORTENABLED

Returns the flag that determines if a servlet will permit/disable global port messages. If not defined the default value is returned, which is FALSE for the root and TRUE for PDBs dbms_xdb_config.isGlobalPortEnabled RETURN BOOLEAN;

BEGIN

        IF dbms_xdb_config.isGlobalPortEnabled THEN

          dbms_output.put_line('Global Port Enabled');

        ELSE

          dbms_output.put_line('Global Port Not Enabled');

        END IF;

      END;

      /

      Global Port Enabled

      

      PL/SQL procedure successfully completed.

SETDEFAULTTYPEMAPPINGS

Sets the value of default-type-mappings in xdbconfig dbms_xdb_config.setDefaultTypeMappings(setDefaultTypeMappings(version IN VARCHAR2);
-- valid values are "pre-11.2" or "post-11.2"

exec dbms_xdb_config.setDefaultTypeMappings('post-11.2');

SETDYNAMICGROUPSTORE

Undocumented dbms_xdb_config.setDynamicGroupStore(is_dynamic IN BOOLEAN := TRUE); PRAGMA SUPPLEMENTAL_LOG_DATA(setDynamicGroupStore, UNSUPPORTED_WITH_COMMIT);

exec dbms_xdb_config.setDynamicGroupStore;

SETFTPPORT

Sets the FTP port to new value dbms_xdb_config.setFTPPort(new_port IN NUMBER);

See getFTPPort Demo Above

SETGLOBALPORTENABLED

Sets/clears flag in servlet that will permit/disable global port messages from the root's port to executing the servlet in a target PDB dbms_xdb_config.setGlobalPortEnabled(isenabled IN BOOLEAN);

exec dbms_xdb_config.setGlobalPortEnabled(TRUE);

      

      PL/SQL procedure successfully completed.

SETHTTPCONFIGREALM

Undocumented dbms_xdb_config.setHTTPConfigRealm(setHttpConfigRealm(realm IN VARCHAR2);

TBD

SETHTTPPORT

Sets the HTTP port to new value dbms_xdb_config.setHTTPPort(new_port IN NUMBER);

SELECT  dbms_xdb_config.getHTTPPort FROM dual;

      

       GETHTTPPORT

      ------------

                 0

      

      exec dbms_xdb_config.setHTTPPort(22);

      

      PL/SQL procedure successfully completed.

      

      SELECT dbms_xdb_config.getHTTPPort FROM dual;

      

       GETHTTPPORT

      ------------

                22

SETHTTPSPORT

Sets the HTTPs port to new value dbms_xdb_config.setHTTPsPort(new_port IN NUMBER);

SELECT  dbms_xdb_config.getHTTPsPort FROM dual;

      

      GETHTTPSPORT

      ------------

                 0

      

      exec dbms_xdb_config.setHTTPsPort(23);

      

      PL/SQL procedure successfully completed.

      

      SELECT dbms_xdb_config.getHTTPsPort FROM dual;

      

      GETHTTPSPORT

      ------------

                23

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_config.setListenerEndPoint( endpoint IN NUMBER, host IN VARCHAR2, port IN NUMBER, protocol IN NUMBER);

See getListenerEndPoint Demo Above

SETLISTENERLOCALACCESS

Restricts all listener end points of the XML DB HTTP server to listen only on the localhost interface (when l_access is TRUE) or allows all listener end points of the XML DB HTTP server to listen on both localhost and non-localhost interfaces (when l_access is FALSE). dbms_xdb_config.setListenerLocalAccess(l_access IN BOOLEAN);

exec dbms_xdb_config.setListenerLocalAccess(TRUE);

SETREMOTEHTTPPORT

Sets the Remote HTTP port to new value dbms_xdb_config.setRemoteHTTPPort(new_port IN NUMBER);

exec dbms_xdb_config.setRemoteHTTPPort(80);

      

      PL/SQL procedure successfully completed.

SETREMOTEHTTPSPORT

Sets the Remote HTTP port (with SSL) to new value dbms_xdb_config.setRemoteHTTPSPort(new_port IN NUMBER);

exec dbms_xdb_config.setRemoteHTTPSPort(443);

      

      PL/SQL procedure successfully completed.

USEDPORT

Return the protocol port numbers of all pdbs dbms_xdb_config.usedport RETURN sys.XMLType;

SELECT dbms_xdb_config.usedport

      FROM dual;

      

      USEDPORT

      ------------------------------

      <portlist>

  <port>

    <pdbid>1</pdbid>

    <rhttpport>80</rhttpport>

  </port>

      </portlist>