183 DBMS_XDB_CONFIG

Overview

PL/SQL package DBMS_XDB_CONFIG is the Oracle XML DB resource application program interface (API) for PL/SQL for DBAs to configure their system. This API provides functions and procedures to access and manage Oracle XML DB Repository resources using PL/SQL. It includes methods for managing resource security and Oracle XML DB configuration.

Oracle XML DB Repository is modeled on XML, and provides a database file system for any data. The repository maps path names (or URLs) onto database objects of XMLType and provides management facilities for these objects.

PL/SQL package DBMS_XDB_CONFIG is an API that you can use to manage all of the following:

• Oracle XML DB resources

• Oracle XML DB security based on access control lists (ACLs). An ACL is a list of access control entries (ACEs) that determines which principals (users and roles) have access to which resources.

• Oracle XML DB configuration

Security Model

Owned by XDB, the DBMS_XDB_CONFIG package must be created by SYS or XDB. The EXECUTE privilege is granted to PUBLIC. Subprograms in this package are executed using the privileges of the current user.

Constants

The DBMS_XDB_CONFIG package uses the constants shown in Table 183-1, "DBMS_XDB_CONFIG Constants".

ADDHTTPEXPIREMAPPING Procedure

This procedure adds to 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_REPOS.ADDHTTPEXPIREMAPPING (
     pattern    IN    VARCHAR2,
     expire     IN    VARCHAR2);

base [plus] (num type)*
-- base: now | modification
-- type: year|years|month|months|week|weeks|day|days|
minute|minutess|second|seconds

DBMS_XDB_REPOS.ADDHTTPEXPIREMAPPING ('/public/test1/*', 'now plus 4 weeks');
DBMS_XDB_REPOS.ADDHTTPEXPIREMAPPING (
             '/public/test2/*', 'modification plus 1 day 30 seconds');

ADDMIMEMAPPING Procedure

This procedure adds the following mime mapping to XDB configuration:

<mime-mapping>
<extension>extension</extension>
<mime-type>mimetype</mime-type>
</mime-mapping>

DBMS_XDB_CONFIG.ADDMIMEMAPPING(
     extension    IN   VARCHAR2,
     mimetype     IN   VARCHAR2);

ADDSCHEMALOCMAPPING Procedure

This procedure adds the following schema location mapping to the XDB configuration:

<schemaLocation-mapping>
     <namespace>namespace</namespace>
     <element>element</element>
      <schemaURL>schemaURL</schemaURL>
</schemaLocation-mapping>

DBMS_XDB_CONFIG.ADDSCHEMALOCMAPPING(
     namespace    IN   VARCHAR2,
     element      IN   VARCHAR2,
     schemaURL    IN   VARCHAR2);

ADDSERVLET Procedure

This procedure adds the following servlet to XDB configuration:

<servlet>
     <servlet-name>name</servlet-name>     <servlet-language>language</servlet-language>
     <display-name>dispname</display-name>
     <description>descript</description>
     <servlet-class>class</servlet-class>
     <servlet-schema>schema</servlet-schema>
</servlet>

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);

ADDSERVLETMAPPING Procedure

This procedure adds the following servlet mapping to XDB configuration:

<servlet-mapping>     <servlet-pattern>pattern</servlet-pattern>     <servlet-name>name</servlet-name></servlet-mapping>

DBMS_XDB_CONFIG.ADDSERVLETMAPPING(
     pattern   IN   VARCHAR2,     name      IN   VARCHAR2);

ADDSERVLETSECROLE Procedure

This procedure adds the following security role REF to a specified servlet in XDB configuration:

<security-role-ref>
     <role-name>rolename</role-name>
     <role-link>rolelink</role-link>
     <description>descript</description>
</security-role-ref>

DBMS_XDB_CONFIG.ADDSERVLETSECROLE(
     servname    IN   VARCHAR2,     rolename    IN   VARCHAR2,     rolelink    IN   VARCHAR2,     descript    IN   VARCHAR2 := NULL);

ADDXMLEXTENSION Procedure

This procedure adds the following XML extension to the XDB configuration under <xml-extensions>:

<extension>extension</extension>

DBMS_XDB_CONFIG.ADDXMLEXTENSION(
     extension    IN   VARCHAR2);

CFG_GET Function

This function retrieves the session's configuration information as an XMLType instance.

DBMS_XDB_CONFIG.CFG_GET 
 RETURN SYS.XMLType;

CFG_REFRESH Procedure

This procedure refreshes the session's configuration information to the latest configuration.

DBMS_XDB_CONFIG.CFG_REFRESH;

CFG_UPDATE Procedure

This procedure updates the configuration information and commits the change.

DBMS_XDB_CONFIG.CFG_UPDATE(
   xdbconfig   IN  SYS.XMLTYPE);

DELETEHTTPEXPIREMAPPING Procedure

This procedure deletes from XDB$CONFIG all mappings of the URL pattern to an expiration date.

DBMS_XDB_REPOS.DELETEHTTPEXPIREMAPPING(
     pattern  IN   VARCHAR2);

DELETEMIMEMAPPING Procedure

This procedure deletes the mime mapping for a specified extension from the XDB configuration.

DBMS_XDB_CONFIG.DELETEMIMEMAPPING(
     extension    IN   VARCHAR2);

DELETESCHEMALOCMAPPING Procedure

This procedure deletes the schema location mapping for a specified schema URL from the XDB configuration.

DBMS_XDB_CONFIG.DELETESCHEMALOCMAPPING(
     schemaURL    IN   VARCHAR2);

DELETESERVLET Procedure

This procedure deletes a servlet from the XDB configuration.

DBMS_XDB_CONFIG.DELETESERVLET(
     name        IN   VARCHAR2);

DELETESERVLETMAPPING Procedure

This procedure deletes the servlet mapping for a specified servlet name from the XDB configuration.

DBMS_XDB_CONFIG.DELETESERVLETMAPPING(
     name      IN   VARCHAR2);

DELETESERVLETSECROLE Procedure

This procedure deletes the specified role from a servlet in the XDB configuration.

DBMS_XDB_CONFIG.DELETESERVLETSECROLE(
     servname    IN   VARCHAR2,     rolename    IN   VARCHAR2);

DELETEXMLEXTENSION Procedure

This procedure deletes the specified XML extension from the XDB configuration.

DBMS_XDB_CONFIG.DELETEXMLEXTENSION(
     extension    IN   VARCHAR2);

ENABLEDIGESTAUTHENTICATION Procedure

This procedure enables digest authentication. It will list digest as the first authentication mechanism to be used by the XML DB HTTP server.

DBMS_XDB_CONFIG.ENABLEDIGESTAUTHENTICATION;

GETFTPPORT Function

This procedure gets the value of the current FTP port.

DBMS_XDB_CONFIG.GETFTPPORT
 RETURN NUMBER;

GETHTTPPORT Function

This function gets the value of the current HTTP port.

DBMS_XDB_CONFIG.GETHTTPPORT
 RETURN NUMBER;

GETHTTPCONFIGREALM Function

This function gets the realm name. Definition of a realm is referenced in IETF's RFC2617.

DBMS_XDB_CONFIG.GETHTTPCONFIGREALM
 RETURN VARCHAR2;

GETHTTPSPORT Function

This procedure gets the value of the current HTTPS port.

DBMS_XDB_CONFIG.GETHTTPPORT
 RETURN NUMBER;

GETLISTENERENDPOINT Procedure

This procedure 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_CONFIG.GETLISTENERENDPOINT (
   endpoint  IN   NUMBER, 
   host      OUT  VARCHAR2,    port      OUT  NUMBER, 
   protocol  OUT  NUMBER);

SETFTPPORT Procedure

This procedure sets the FTP port to a new value.

DBMS_XDB_CONFIG.SETFTPPORT(
   new_port  IN  NUMBER);

SETHTTPPORT Procedure

This procedure sets the HTTP port to a new value.

DBMS_XDB_CONFIG.SETHTTPPORT(
   new_port  IN  NUMBER);

SETHTTPCONFIGREALM Procedure

This procedure modifies the realm value.

DBMS_XDB_CONFIG.SETHTTPCONFIGREALM(
   realm IN VARCHAR2);

SETHTTPSPORT Procedure

This procedure sets the HTTP port to a new value.

DBMS_XDB_CONFIG.SETHTTPSPORT(
   new_port  IN  NUMBER);

SETLISTENERENDPOINT Procedure

This procedure 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);

SETLISTENERLOCALACCESS Procedure

This procedure restricts all listener end points of the XML DB HTTP server to listen either only on the localhost interface (when l_access is set to TRUE) or to listen on both localhost and non-localhost interfaces (when l_access is set to FALSE).

DBMS_XDB_CONFIG.SETLISTENERLOCALACCESS (
   l_access   BOOLEAN);

USEDPORT Procedure

This procedure obtains the port numbers used by other pluggable databases in the same consolidation database.

DBMS_XDB_CONFIG.USEDPORT;