93: -- PARAMETERS -
94: -- abspath
95: -- Absolute path in the Hierarchy of the resource
96: -- RETURNS -
97: -- the Locks element as XMLType
98: ---------------------------------------------
99: FUNCTION LockDiscovery(abspath IN VARCHAR2)
100: RETURN SYS.XMLType;
101:
96: -- RETURNS -
97: -- the Locks element as XMLType
98: ---------------------------------------------
99: FUNCTION LockDiscovery(abspath IN VARCHAR2)
100: RETURN SYS.XMLType;
101:
102: ---------------------------------------------
103: -- PROCEDURE - GetLockToken
104: -- Gets lock token for current user for XDB resource given its path
187: schemaurl IN VARCHAR2 := NULL,
188: elem IN VARCHAR2 := NULL) RETURN BOOLEAN;
189:
190: ---------------------------------------------
191: -- FUNCTION - CreateResource(VARCHAR2, SYS.XMLTYPE, VARCHAR2, VARCHAR2)
192: -- Given an XMLTYPE and a schema URL, inserts a new resource
193: -- into the hierarchy with the XMLTYPE as the contents.
194: -- PARAMETERS -
195: -- abspath
188: elem IN VARCHAR2 := NULL) RETURN BOOLEAN;
189:
190: ---------------------------------------------
191: -- FUNCTION - CreateResource(VARCHAR2, SYS.XMLTYPE, VARCHAR2, VARCHAR2)
192: -- Given an XMLTYPE and a schema URL, inserts a new resource
193: -- into the hierarchy with the XMLTYPE as the contents.
194: -- PARAMETERS -
195: -- abspath
196: -- Absolute path to the resource
189:
190: ---------------------------------------------
191: -- FUNCTION - CreateResource(VARCHAR2, SYS.XMLTYPE, VARCHAR2, VARCHAR2)
192: -- Given an XMLTYPE and a schema URL, inserts a new resource
193: -- into the hierarchy with the XMLTYPE as the contents.
194: -- PARAMETERS -
195: -- abspath
196: -- Absolute path to the resource
197: -- data
194: -- PARAMETERS -
195: -- abspath
196: -- Absolute path to the resource
197: -- data
198: -- XMLTYPE containing the resource contents
199: -- schemaurl
200: -- schema URL the XmlType conforms to (default null)
201: -- elem
202: -- element name (default null)
196: -- Absolute path to the resource
197: -- data
198: -- XMLTYPE containing the resource contents
199: -- schemaurl
200: -- schema URL the XmlType conforms to (default null)
201: -- elem
202: -- element name (default null)
203: -- RETURNS -
204: -- Returns TRUE if resource was successfully inserted or updated
203: -- RETURNS -
204: -- Returns TRUE if resource was successfully inserted or updated
205: ---------------------------------------------
206: FUNCTION CreateResource(abspath IN VARCHAR2,
207: data IN SYS.XMLTYPE,
208: schemaurl IN VARCHAR2 := NULL,
209: elem IN VARCHAR2 := NULL) RETURN BOOLEAN;
210:
211:
209: elem IN VARCHAR2 := NULL) RETURN BOOLEAN;
210:
211:
212: ---------------------------------------------
213: -- FUNCTION - CreateResource(VARCHAR2, REF SYS.XMLTYPE, BOOLEAN, BOOLEAN)
214: -- Given a PREF to an existing XMLType row, inserts a new resource
215: -- whose contents point directly at that row. That row should
216: -- not already exist inside another resource.
217: -- PARAMETERS -
210:
211:
212: ---------------------------------------------
213: -- FUNCTION - CreateResource(VARCHAR2, REF SYS.XMLTYPE, BOOLEAN, BOOLEAN)
214: -- Given a PREF to an existing XMLType row, inserts a new resource
215: -- whose contents point directly at that row. That row should
216: -- not already exist inside another resource.
217: -- PARAMETERS -
218: -- abspath
217: -- PARAMETERS -
218: -- abspath
219: -- Absolute path to the resource
220: -- data
221: -- REF to the XMLType row containing the resource contents
222: -- sticky
223: -- If TRUE creates a sticky REF, otherwise non-sticky.
224: -- Default is TRUE (for backwards compatibility).
225: -- calcSize
228: -- RETURNS -
229: -- Returns TRUE if resource was successfully inserted or updated
230: ---------------------------------------------
231: FUNCTION CreateResource(abspath IN VARCHAR2,
232: data IN REF SYS.xmltype,
233: sticky IN BOOLEAN := TRUE,
234: calcSize IN BOOLEAN := FALSE) RETURN BOOLEAN;
235:
236: ---------------------------------------------
374: -- PARAMETERS -
375: -- abspath
376: -- Absolute path in the Hierarchy of the resource whose acl doc is required
377: -- RETURNS -
378: -- Returns xmltype for acl document
379: ---------------------------------------------
380: FUNCTION getAclDocument(abspath IN VARCHAR2) RETURN sys.xmltype;
381:
382: ---------------------------------------------
376: -- Absolute path in the Hierarchy of the resource whose acl doc is required
377: -- RETURNS -
378: -- Returns xmltype for acl document
379: ---------------------------------------------
380: FUNCTION getAclDocument(abspath IN VARCHAR2) RETURN sys.xmltype;
381:
382: ---------------------------------------------
383: -- FUNCTION - getPrivileges
384: -- Gets all system and user privileges granted to the current user
386: -- PARAMETERS -
387: -- res_path
388: -- Absolute path in the Hierarchy for XDB resource
389: -- RETURNS -
390: -- Returns a XMLType instance of
392: -- granted on this resource to the current user.
393: -- It includes all granted system and user privileges.
394: -- Example :
404: --
405: --
406: --
407: ---------------------------------------------
408: FUNCTION getPrivileges(res_path IN VARCHAR2) RETURN sys.xmltype;
409:
410: ---------------------------------------------
411: -- FUNCTION - changePrivileges
412: -- change access privileges on given XDB resource
413: -- PARAMETERS -
414: -- res_path
415: -- Absolute path in the Hierarchy for XDB resource
416: -- ace
417: -- an XMLType instance of the
419: -- privileges.
420: -- If no ACE with the same principal and the same operation
421: -- (grant/deny) already exists in the ACL, the new ACE is added
434: -- RETURNS -
435: -- Returns positive integer if ACL was successfully modified
436: ---------------------------------------------
437: FUNCTION changePrivileges(res_path IN VARCHAR2,
438: ace IN xmltype)
439: RETURN pls_integer;
440:
441: ---------------------------------------------
442: -- FUNCTION - checkPrivileges
445: -- res_path
446: -- Absolute path in the Hierarchy for XDB resource
447: -- privs
448: -- Requested set of access privileges
449: -- This argument is a XMLType instance of the
451: -- Returns positive integer if all requested privileges granted
452: ---------------------------------------------
453: FUNCTION checkPrivileges(res_path IN VARCHAR2,
450: -- RETURNS -
451: -- Returns positive integer if all requested privileges granted
452: ---------------------------------------------
453: FUNCTION checkPrivileges(res_path IN VARCHAR2,
454: privs IN xmltype)
455: RETURN pls_integer;
456:
457: ---------------------------------------------
458: -- PROCEDURE - setFTPPort
572: -- Resource owner name. The pseudo user "XDBOWNER" is replaced
573: -- by this user during ACL privilege resolution
574: -- privs
575: -- Requested set of access privileges
576: -- This argument is a XMLType instance of the
578: -- Returns positive integer if all requested privileges granted
579: ---------------------------------------------
580: FUNCTION AclCheckPrivileges(acl_path IN VARCHAR2,
578: -- Returns positive integer if all requested privileges granted
579: ---------------------------------------------
580: FUNCTION AclCheckPrivileges(acl_path IN VARCHAR2,
581: owner IN VARCHAR2,
582: privs IN xmltype)
583: RETURN pls_integer;
584:
585: ---------------------------------------------
586: -- PROCEDURE - refresh
591: ---------------------------------------------
592: -- FUNCTION - get
593: -- retrieves the xdb configuration
594: -- RETURNS -
595: -- XMLType for xdb configuration
596: ---------------------------------------------
597: FUNCTION cfg_get RETURN sys.xmltype;
598:
599: ---------------------------------------------
593: -- retrieves the xdb configuration
594: -- RETURNS -
595: -- XMLType for xdb configuration
596: ---------------------------------------------
597: FUNCTION cfg_get RETURN sys.xmltype;
598:
599: ---------------------------------------------
600: -- PROCEDURE - update
601: -- Updates the xdb configuration with the input xmltype document
597: FUNCTION cfg_get RETURN sys.xmltype;
598:
599: ---------------------------------------------
600: -- PROCEDURE - update
601: -- Updates the xdb configuration with the input xmltype document
602: -- PARAMETERS -
603: -- xdbconfig
604: --- XMLType for xdb configuration
605: --------------------------------------------
600: -- PROCEDURE - update
601: -- Updates the xdb configuration with the input xmltype document
602: -- PARAMETERS -
603: -- xdbconfig
604: --- XMLType for xdb configuration
605: --------------------------------------------
606: PROCEDURE cfg_update(xdbconfig IN sys.xmltype);
607:
608: ---------------------------------------------
602: -- PARAMETERS -
603: -- xdbconfig
604: --- XMLType for xdb configuration
605: --------------------------------------------
606: PROCEDURE cfg_update(xdbconfig IN sys.xmltype);
607:
608: ---------------------------------------------
609: -- FUNCTION - GetResOID(abspath VARCHAR2)
610: -- Returns the OID of the resource, given its absolute path
642: -- RETURNS -
643: -- Nothing
644: -----------------------------------------------------------
645: PROCEDURE appendResourceMetadata(abspath IN VARCHAR2,
646: data IN SYS.xmltype);
647:
648: -----------------------------------------------------------
649: -- PROCEDURE - appendResourceMetadata
650: -- Appends the given piece of metadata identified by a REF
658: -- RETURNS -
659: -- Nothing
660: -----------------------------------------------------------
661: PROCEDURE appendResourceMetadata(abspath IN VARCHAR2,
662: data IN REF SYS.xmltype);
663:
664: -----------------------------------------------------------
665: -- PROCEDURE - deleteResourceMetadata
666: -- Deletes metadata from a resource (can only be used for SB metadata)
679: -- RETURNS -
680: -- Nothing
681: -----------------------------------------------------------
682: PROCEDURE deleteResourceMetadata(abspath IN VARCHAR2,
683: metadata IN REF SYS.XMLTYPE,
684: delete_option IN pls_integer :=
685: DELETE_RES_METADATA_CASCADE);
686:
687: -----------------------------------------------------------
727: -- RETURNS -
728: -- Nothing
729: -----------------------------------------------------------
730: PROCEDURE updateResourceMetadata(abspath IN VARCHAR2,
731: oldmetadata IN REF SYS.XMLTYPE,
732: newmetadata IN REF SYS.XMLTYPE);
733:
734: -----------------------------------------------------------
735: -- PROCEDURE - updateResourceMetadata
728: -- Nothing
729: -----------------------------------------------------------
730: PROCEDURE updateResourceMetadata(abspath IN VARCHAR2,
731: oldmetadata IN REF SYS.XMLTYPE,
732: newmetadata IN REF SYS.XMLTYPE);
733:
734: -----------------------------------------------------------
735: -- PROCEDURE - updateResourceMetadata
736: -- Updates metadata for a resource (can be used to update SB
746: -- RETURNS -
747: -- Nothing
748: -----------------------------------------------------------
749: PROCEDURE updateResourceMetadata(abspath IN VARCHAR2,
750: oldmetadata IN REF SYS.XMLTYPE,
751: newmetadata IN XMLTYPE);
752:
753: -----------------------------------------------------------
754: -- PROCEDURE - updateResourceMetadata
747: -- Nothing
748: -----------------------------------------------------------
749: PROCEDURE updateResourceMetadata(abspath IN VARCHAR2,
750: oldmetadata IN REF SYS.XMLTYPE,
751: newmetadata IN XMLTYPE);
752:
753: -----------------------------------------------------------
754: -- PROCEDURE - updateResourceMetadata
755: -- Updates metadata for a resource - can be used for both
767: -----------------------------------------------------------
768: PROCEDURE updateResourceMetadata(abspath IN VARCHAR2,
769: oldns IN VARCHAR2,
770: oldname IN VARCHAR,
771: newmetadata IN XMLTYPE);
772:
773: -----------------------------------------------------------
774: -- PROCEDURE - updateResourceMetadata
775: -- Updates metadata for a resource - can be used for both
787: -----------------------------------------------------------
788: PROCEDURE updateResourceMetadata(abspath IN VARCHAR2,
789: oldns IN VARCHAR2,
790: oldname IN VARCHAR,
791: newmetadata IN REF SYS.XMLTYPE);
792:
793: -----------------------------------------------------------
794: -- PROCEDURE - purgeResourceMetadata
795: -- Deletes all user metadata from a resource
1057: locksrc IN BOOLEAN := FALSE
1058: ) return BLOB;
1059:
1060: ---------------------------------------------
1061: -- FUNCTION - getContentXMLType
1062: -- Returns the contents of the resource as an XMLType.
1063: -- PARAMETERS -
1064: -- abspath - Absolute path of the resource.
1065: -- RETURNS -
1058: ) return BLOB;
1059:
1060: ---------------------------------------------
1061: -- FUNCTION - getContentXMLType
1062: -- Returns the contents of the resource as an XMLType.
1063: -- PARAMETERS -
1064: -- abspath - Absolute path of the resource.
1065: -- RETURNS -
1066: -- The contents as XMLType.
1062: -- Returns the contents of the resource as an XMLType.
1063: -- PARAMETERS -
1064: -- abspath - Absolute path of the resource.
1065: -- RETURNS -
1066: -- The contents as XMLType.
1067: ---------------------------------------------
1068: FUNCTION getContentXMLType (
1069: abspath IN VARCHAR2
1070: ) return SYS.XMLType;
1064: -- abspath - Absolute path of the resource.
1065: -- RETURNS -
1066: -- The contents as XMLType.
1067: ---------------------------------------------
1068: FUNCTION getContentXMLType (
1069: abspath IN VARCHAR2
1070: ) return SYS.XMLType;
1071:
1072: ---------------------------------------------
1066: -- The contents as XMLType.
1067: ---------------------------------------------
1068: FUNCTION getContentXMLType (
1069: abspath IN VARCHAR2
1070: ) return SYS.XMLType;
1071:
1072: ---------------------------------------------
1073: -- FUNCTION - getContentVarchar2
1074: -- Returns the contents of the resource as an Varchar2.
1082: ) return VARCHAR2;
1083:
1084: ---------------------------------------------
1085: -- FUNCTION - getContentXMLRef
1086: -- Returns the contents of the resource as a ref to an xmltype.
1087: -- PARAMETERS -
1088: -- abspath - Absolute path of the resource.
1089: -- RETURNS -
1090: -- The contents as a ref to an xmltype if the resource is ref
1086: -- Returns the contents of the resource as a ref to an xmltype.
1087: -- PARAMETERS -
1088: -- abspath - Absolute path of the resource.
1089: -- RETURNS -
1090: -- The contents as a ref to an xmltype if the resource is ref
1091: -- based, else null.
1092: ---------------------------------------------
1093: FUNCTION getContentXMLRef (
1094: abspath IN VARCHAR2
1091: -- based, else null.
1092: ---------------------------------------------
1093: FUNCTION getContentXMLRef (
1094: abspath IN VARCHAR2
1095: ) return ref SYS.XMLType;
1096:
1097:
1098: ---------------------------------------------
1099: -- FUNCTION - getxdb_tablespace