1 PACKAGE dbms_resconfig AUTHID CURRENT_USER IS
2
3 ------------
4 -- CONSTANTS
5 --
6 ------------
7 DELETE_RESOURCE CONSTANT NUMBER := 1;
8 DELETE_RECURSIVE CONSTANT NUMBER := 2;
9 APPEND_RESOURCE CONSTANT NUMBER := 1;
10 APPEND_RECURSIVE CONSTANT NUMBER := 2;
11
12 ---------------------------------------------
13 -- FUNCTION - getResConfig
14 -- Returns the resource configuration at the specified position of the
15 -- target resource's configuration list.
16 -- PARAMETERS -
17 -- respath
18 -- Absolute path in the Hierarchy of the resource
19 -- pos
20 -- position of element to return. Position must be >= 0 and < the length of
21 -- the resource's configuration list.
22 -- RETURNS -
23 -- Returns contents of resource configuration.
24 ---------------------------------------------
25 FUNCTION getResConfig(respath IN VARCHAR2, pos IN PLS_INTEGER)
26 RETURN sys.XMLType;
27
28 ---------------------------------------------
29 -- PROCEDURE - addResConfig
30 -- Inserts the resource configuration specified by rcpath at the given position in the target resource's configuration list.
31 --
32 -- PARAMETERS:
33 -- respath - absolute path of the target resource.
34 -- rcpath - absolute path of the resource configuration to be inserted. An exception is raised if rcpath already exists in the target's configuration list.
35 -- pos - index at which the new configuration is to be inserted. If this parameter is not specified then the new configuration is appended to the end of the list. An exception is raised if the index is out of range (i.e., pos < 0 or pos > the size of the target resource's configuration list).
36
37 ---------------------------------------------
38
39 PROCEDURE addResConfig(respath IN VARCHAR2, rcpath IN VARCHAR2,
40 pos IN PLS_INTEGER := NULL);
41 PRAGMA SUPPLEMENTAL_LOG_DATA(addResConfig, AUTO);
42
43 ---------------------------------------------
44 -- FUNCTION getResConfigPaths
45 -- Returns a list of resource configuration paths defined in the target resource's configuration list.
46 --
47
48 -- PARAMETERS:
49 -- respath - absolute path of the target resource.
50 ---------------------------------------------
51 Function getResConfigPaths(respath IN VARCHAR2) return XDB$STRING_LIST_T;
52
53 ---------------------------------------------
54 -- PROCEDURE appendResConfig
55 -- Appends the resource configuration specified by rcpath to the target resource's configuration list if it is not already included in the list.
56
57 -- PARAMETERS
58 -- respath - absolute path of the target resource.
59 -- rcpath - absolute path of the resource configuration to be appended at the end of the target's configuration list. If rcpath already exists in the list then nothing is appended.
60 -- appendOption - either APPEND_RESOURCE or APPEND_RECURSIVE. If APPEND_RESOURCE is specified then only the target resource is affected. If APPEND_RECURSIVE is specified then the target resource and all its descendents will be affected.
61 ---------------------------------------------
62 Procedure appendResConfig(respath IN VARCHAR2, rcpath IN VARCHAR2, appendOption IN PLS_INTEGER);
63 PRAGMA SUPPLEMENTAL_LOG_DATA(appendResConfig, AUTO);
64
65 ---------------------------------------------
66 -- PROCEDURE deleteResConfig
67 -- Removes the configuration at the given position in the target resource's configuration list.
68 -- PARAMETERS
69 -- respath - absolute path of the target resource.
70 -- pos - the index of the configuration to be removed. An exception is raised if the index is out of range (i.e., pos < 0 or pos >= the size of the target resource's configuration list.
71 ---------------------------------------------
72 Procedure deleteResConfig(respath IN VARCHAR2, pos IN PLS_INTEGER);
73 PRAGMA SUPPLEMENTAL_LOG_DATA(deleteResConfig, AUTO);
74
75 ---------------------------------------------
76 -- PROCEDURE deleteResConfig
77 -- Removes the configuration specified by rcpath from the target resource's configuration list. Shifts any subsequent elements to the left. Users must have write-config privilege on all affected resources to execute this.
78
79 -- PARAMETERS
80 -- respath - absolute path of the target resource.
81 -- rcpath - absolute path of the resource configuration to be deleted if found in list.
82 -- deleteOption - either DELETE_RESOURCE or DELETE_RECURSIVE. If DELETE_RESOURCE is specified then only the configuration list of the target resource is affected. If DELETE_RECURSIVE is specified then the configuration list of the target resource and all its descendents will be affected.
83
84 ---------------------------------------------
85 Procedure deleteResConfig(respath IN VARCHAR2, rcpath IN VARCHAR2,
86 deleteOption IN PLS_INTEGER);
87 PRAGMA SUPPLEMENTAL_LOG_DATA(deleteResConfig, AUTO);
88
89 ---------------------------------------------
90 -- FUNCTION getListeners
91 -- Returns the list of listeners applicable for a given resource. The value returned by this function is an XML document containing the <event-listeners> element of the XDBResconfig.xsd schema. It contains all the listeners applicable to the target resource, including repository-level listeners. From the returned XML document users can use the EXTRACT operator to retrieve the listeners defined for a specific event. Users must have the required access privilege on all resource configurations referenced by the repository and the target resource; otherwise, an error is returned.
92
93 -- PARAMETERS
94 -- path - absolute path of the target resource.
95 ---------------------------------------------
96 function getListeners(path IN VARCHAR2) return SYS.XMLType;
97
98 ---------------------------------------------
99 -- FUNCTION getRepositoryResConfig
100
101 -- Description:
102 -- Returns the resource configuration at the specified position of the repository's configuration list. Users must have the required read privilege on the requested resource configuration; otherwise, an error is returned.
103 -- Parameters:
104 -- pos - index of element to return. An exception is raised if the index is out of range (i.e., pos < 0 or pos >= the size of the repository's configuration list).
105 ---------------------------------------------
106 Function getRepositoryResConfig(pos IN PLS_INTEGER) return SYS.XMLType;
107
108 ---------------------------------------------
109 -- FUNCTION getRepositoryResConfigPaths
110
111 -- Description:
112 -- Returns a list of resource configuration paths defined for the repository. Users must be able to access all the referenced resource configurations; otherwise, an error is returned.
113 ---------------------------------------------
114 Function getRepositoryResConfigPaths return XDB$STRING_LIST_T;
115
116 ---------------------------------------------
117 -- PROCEDURE addRepositoryResConfig
118
119 -- Description:
120 -- Inserts the resource configuration specified by rcpath at the given position of the repository's configuration list. Shifts the element currently at that position (if any) and any subsequent elements to the right. An error is raised if the document referenced by rcpath is not based on XDBResConfig.xsd schema. Users must have XDBADMIN role and read privilege on the resource configuration to be inserted; otherwise, an error is returned.
121 -- Parameters:
122 -- rcpath - absolute path of the resource configuration to be inserted. An exception is raised if rcpath already exists in the repository's configuration list.
123 -- pos - index at which the new configuration is to be inserted. If this parameter is not specified then the new configuration is appended to the end of the list. An exception is raised if the index is out of range (i.e., pos < 0 or pos > the size of the repository's configuration list).
124 ---------------------------------------------
125 Procedure addRepositoryResConfig(rcpath IN VARCHAR2, pos IN PLS_INTEGER := NULL);
126 PRAGMA SUPPLEMENTAL_LOG_DATA(addRepositoryResConfig, AUTO_WITH_COMMIT);
127
128 ---------------------------------------------
129 -- PROCEDURE deleteRepositoryResConfig
130
131 -- Description:
132 -- Removes the configuration at the given position in the repository's configuration list. Shifts any subsequent elements to the left. Users must have XDBADMIN role to execute this.
133 -- This statement is treated as if it is a DDL statement. This means the system will implicitly commit before and after this statement.
134 -- Parameters:
135 -- pos - the index of the configuration to be removed. An exception is raised if the index is out of range (i.e., pos < 0 or pos >= the size of the repository's configuration list).
136 ---------------------------------------------
137 Procedure deleteRepositoryResConfig(pos IN PLS_INTEGER);
138 PRAGMA SUPPLEMENTAL_LOG_DATA(deleteRepositoryResConfig, AUTO_WITH_COMMIT);
139
140 end dbms_resconfig;
[Home] [Help]