[Home] [Help]
1: PACKAGE DBMS_LDAP_UTL AS
2:
3: /**
4: *************************************************************************************************
5: * NAME
2:
3: /**
4: *************************************************************************************************
5: * NAME
6: * DBMS_LDAP_UTL
7: *
8: * DESCRIPTION
9: * Package specification for DBMS_LDAP_UTL
10: * This pakcage contains Oracle EXtension utility functions.
5: * NAME
6: * DBMS_LDAP_UTL
7: *
8: * DESCRIPTION
9: * Package specification for DBMS_LDAP_UTL
10: * This pakcage contains Oracle EXtension utility functions.
11: * These functions can be used for authentication or querying information
12: * on users, groups or subscribers in the LDAP server.
13: *
15: * N/A
16: *
17: * REQUIRES
18: * 1. Most of the functions accept a valid ldap session as an argument.
19: * This ldap session has to be obtained from DBMS_LDAP.init() function.
20: * 2. The functions in the package lookup the Oracle Context schema in the
21: * LDAP server to query information on users, groups and subscribers.
22: *
23: * PARAMETERS
44: VERSION CONSTANT VARCHAR2(256) := '2';
45: INTERFACE_VERSION CONSTANT VARCHAR2(256) := '2';
46:
47: --
48: -- DBMS_LDAP_UTL data type definitions
49: --
50:
51: -- We use RAW(32) as a data structure to store external pointers
52: -- It is big enough to store 256 bit pointers!
65: INDEX BY BINARY_INTEGER;
66:
67: -- String collection.
68: SUBTYPE STRING_COLLECTION IS
69: DBMS_LDAP.STRING_COLLECTION;
70:
71: -- Binval collection.
72: SUBTYPE BINVAL_COLLECTION IS
73: DBMS_LDAP.BINVAL_COLLECTION;
69: DBMS_LDAP.STRING_COLLECTION;
70:
71: -- Binval collection.
72: SUBTYPE BINVAL_COLLECTION IS
73: DBMS_LDAP.BINVAL_COLLECTION;
74:
75: -- BLOB collection.
76: SUBTYPE BLOB_COLLECTION IS
77: DBMS_LDAP.BLOB_COLLECTION;
73: DBMS_LDAP.BINVAL_COLLECTION;
74:
75: -- BLOB collection.
76: SUBTYPE BLOB_COLLECTION IS
77: DBMS_LDAP.BLOB_COLLECTION;
78:
79: -- Session.
80: SUBTYPE SESSION IS DBMS_LDAP.SESSION;
81:
76: SUBTYPE BLOB_COLLECTION IS
77: DBMS_LDAP.BLOB_COLLECTION;
78:
79: -- Session.
80: SUBTYPE SESSION IS DBMS_LDAP.SESSION;
81:
82: --
83: -- DBMS_LDAP_UTL function definitions
84: --
79: -- Session.
80: SUBTYPE SESSION IS DBMS_LDAP.SESSION;
81:
82: --
83: -- DBMS_LDAP_UTL function definitions
84: --
85: /**
86: *******************************************************************************
87: * NAME
105: * (VARCHAR2 ) interface_version - Version of the Interface.
106: *
107: * RETURNS
108: *
109: * DBMS_LDAP_UTL.SUCCESS - Version Supported.
110: * DBMS_LDAP_UTL.GENERAL_ERROR - Version not Supported.
111: *
112: *
113: * USAGE
106: *
107: * RETURNS
108: *
109: * DBMS_LDAP_UTL.SUCCESS - Version Supported.
110: * DBMS_LDAP_UTL.GENERAL_ERROR - Version not Supported.
111: *
112: *
113: * USAGE
114: * N/A
115: *
116: * EXAMPLES
117: *
118: * SEE
119: * DBMS_LDAP_UTL.create_user_handle()
120: *
121: ******************************************************************************
122: */
123: FUNCTION check_interface_version ( interface_version IN VARCHAR2)
149: * subscriber.
150: * (PLS_INTEGER ) subscriber_type - The type of subscriber id that
151: * is passed.
152: * Valid values for this argument are:
153: * - DBMS_LDAP_UTL.TYPE_DN
154: * - DBMS_LDAP_UTL.TYPE_GUID
155: * - DBMS_LDAP_UTL.TYPE_NICKNAME
156: * - DBMS_LDAP_UTL.TYPE_DEFAULT
157: * (VARCHAR2 ) subscriber_id - The subscriber id representing
150: * (PLS_INTEGER ) subscriber_type - The type of subscriber id that
151: * is passed.
152: * Valid values for this argument are:
153: * - DBMS_LDAP_UTL.TYPE_DN
154: * - DBMS_LDAP_UTL.TYPE_GUID
155: * - DBMS_LDAP_UTL.TYPE_NICKNAME
156: * - DBMS_LDAP_UTL.TYPE_DEFAULT
157: * (VARCHAR2 ) subscriber_id - The subscriber id representing
158: * the subscriber entry.
151: * is passed.
152: * Valid values for this argument are:
153: * - DBMS_LDAP_UTL.TYPE_DN
154: * - DBMS_LDAP_UTL.TYPE_GUID
155: * - DBMS_LDAP_UTL.TYPE_NICKNAME
156: * - DBMS_LDAP_UTL.TYPE_DEFAULT
157: * (VARCHAR2 ) subscriber_id - The subscriber id representing
158: * the subscriber entry.
159: * This can be NULL if
152: * Valid values for this argument are:
153: * - DBMS_LDAP_UTL.TYPE_DN
154: * - DBMS_LDAP_UTL.TYPE_GUID
155: * - DBMS_LDAP_UTL.TYPE_NICKNAME
156: * - DBMS_LDAP_UTL.TYPE_DEFAULT
157: * (VARCHAR2 ) subscriber_id - The subscriber id representing
158: * the subscriber entry.
159: * This can be NULL if
160: * subscriber_type is :
157: * (VARCHAR2 ) subscriber_id - The subscriber id representing
158: * the subscriber entry.
159: * This can be NULL if
160: * subscriber_type is :
161: * - DBMS_LDAP_UTL.TYPE_DEFAULT
162: * then the default subscriber
163: * would be fetched from
164: * Root Oracle Context.
165: *
164: * Root Oracle Context.
165: *
166: * RETURNS
167: *
168: * DBMS_LDAP_UTL.LDAP_SUCCESS - On a successful completion.
169: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
170: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
171: *
172: *
165: *
166: * RETURNS
167: *
168: * DBMS_LDAP_UTL.LDAP_SUCCESS - On a successful completion.
169: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
170: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
171: *
172: *
173: * USAGE
166: * RETURNS
167: *
168: * DBMS_LDAP_UTL.LDAP_SUCCESS - On a successful completion.
169: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
170: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
171: *
172: *
173: * USAGE
174: * N/A
175: *
176: * EXAMPLES
177: *
178: * SEE
179: * DBMS_LDAP_UTL.get_subscriber_properties().
180: *
181: ******************************************************************************
182: */
183: FUNCTION create_subscriber_handle ( subscriber_hd OUT HANDLE,
207: * RETURN PLS_INTEGER;
208: *
209: * REQUIRES
210: * This function requires a valid ldap session handle which
211: * has to be obtained from DBMS_LDAP.init() function.
212: *
213: * PARAMETERS
214: * (SESSION ) ld - A valid ldap session handle.
215: * (HANDLE ) subscriber_handle - The subscriber handle
218: * the subscriber.
219: * (PLS_INTEGER ) ptype - Type of properties to be
220: * returned.
221: * Valid values:
222: * - DBMS_LDAP_UTL.ENTRY_PROPERITES
223: * - DBMS_LDAP_UTL.COMMON_PROPERITES : To retrieve Subscriber's Oracle Context Properties.
224: * (PROPERTY_SET_COLLECTION ) ret_pset_coll - The subscriber details
225: * containing the requested
226: * attributes by the caller.
219: * (PLS_INTEGER ) ptype - Type of properties to be
220: * returned.
221: * Valid values:
222: * - DBMS_LDAP_UTL.ENTRY_PROPERITES
223: * - DBMS_LDAP_UTL.COMMON_PROPERITES : To retrieve Subscriber's Oracle Context Properties.
224: * (PROPERTY_SET_COLLECTION ) ret_pset_coll - The subscriber details
225: * containing the requested
226: * attributes by the caller.
227: *
226: * attributes by the caller.
227: *
228: * RETURNS
229: *
230: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
231: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
232: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
233: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
234: * DN entries exist in the
227: *
228: * RETURNS
229: *
230: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
231: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
232: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
233: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
234: * DN entries exist in the
235: * directory for the given
228: * RETURNS
229: *
230: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
231: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
232: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
233: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
234: * DN entries exist in the
235: * directory for the given
236: * subscriber.
229: *
230: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
231: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
232: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
233: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
234: * DN entries exist in the
235: * directory for the given
236: * subscriber.
237: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
233: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
234: * DN entries exist in the
235: * directory for the given
236: * subscriber.
237: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
238: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
239: * DBMS_LDAP error codes - Returns proper LDAP error codes
240: * for unconditional failures
241: * while carrying out
234: * DN entries exist in the
235: * directory for the given
236: * subscriber.
237: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
238: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
239: * DBMS_LDAP error codes - Returns proper LDAP error codes
240: * for unconditional failures
241: * while carrying out
242: * LDAP operations by the ldap
235: * directory for the given
236: * subscriber.
237: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
238: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
239: * DBMS_LDAP error codes - Returns proper LDAP error codes
240: * for unconditional failures
241: * while carrying out
242: * LDAP operations by the ldap
243: * server.
244: *
245: *
246: * USAGE
247: * This function can only be called after a valid
248: * ldap session is obtained from a call to DBMS_LDAP.init().
249: *
250: * EXAMPLES
251: *
252: * SEE
249: *
250: * EXAMPLES
251: *
252: * SEE
253: * DBMS_LDAP.init(), DBMS_LDAP_UTL.create_subscriber_handle().
254: *
255: ******************************************************************************
256: */
257: FUNCTION get_subscriber_properties( ld IN SESSION,
284: * RETURN PLS_INTEGER;
285: *
286: * REQUIRES
287: * This function requires a valid ldap session handle which
288: * has to be obtained from DBMS_LDAP.init() function.
289: *
290: * PARAMETERS
291: * (SESSION ) ld - A valid ldap session handle.
292: * (HANDLE ) subscriber_handle - The subscriber handle
295: * the subscriber.
296: * (PLS_INTEGER ) ptype - Type of properties to be
297: * returned.
298: * Valid values:
299: * - DBMS_LDAP_UTL.DEFAULT_RAD_PROPERTIES
300: * - DBMS_LDAP_UTL.COMMON_PROPERITES : To retrieve Subscriber's Oracle Context Properties.
301: * (VARCHAR2) filter - Ldap filter to further
302: * refine the user properties
303: * returned by function.
296: * (PLS_INTEGER ) ptype - Type of properties to be
297: * returned.
298: * Valid values:
299: * - DBMS_LDAP_UTL.DEFAULT_RAD_PROPERTIES
300: * - DBMS_LDAP_UTL.COMMON_PROPERITES : To retrieve Subscriber's Oracle Context Properties.
301: * (VARCHAR2) filter - Ldap filter to further
302: * refine the user properties
303: * returned by function.
304: * (PROPERTY_SET_COLLECTION ) ret_pset_coll - The subscriber details
306: * attributes by the caller.
307: *
308: * RETURNS
309: *
310: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
311: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
312: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
313: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
314: * DN entries exist in the
307: *
308: * RETURNS
309: *
310: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
311: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
312: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
313: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
314: * DN entries exist in the
315: * directory for the given
308: * RETURNS
309: *
310: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
311: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
312: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
313: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
314: * DN entries exist in the
315: * directory for the given
316: * subscriber.
309: *
310: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
311: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
312: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
313: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
314: * DN entries exist in the
315: * directory for the given
316: * subscriber.
317: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
313: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
314: * DN entries exist in the
315: * directory for the given
316: * subscriber.
317: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
318: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
319: * DBMS_LDAP error codes - Returns proper LDAP error codes
320: * for unconditional failures
321: * while carrying out
314: * DN entries exist in the
315: * directory for the given
316: * subscriber.
317: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
318: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
319: * DBMS_LDAP error codes - Returns proper LDAP error codes
320: * for unconditional failures
321: * while carrying out
322: * LDAP operations by the ldap
315: * directory for the given
316: * subscriber.
317: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
318: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
319: * DBMS_LDAP error codes - Returns proper LDAP error codes
320: * for unconditional failures
321: * while carrying out
322: * LDAP operations by the ldap
323: * server.
324: *
325: *
326: * USAGE
327: * This function can only be called after a valid
328: * ldap session is obtained from a call to DBMS_LDAP.init().
329: *
330: * EXAMPLES
331: *
332: * SEE
329: *
330: * EXAMPLES
331: *
332: * SEE
333: * DBMS_LDAP.init(), DBMS_LDAP_UTL.create_subscriber_handle().
334: *
335: ******************************************************************************
336: */
337: FUNCTION get_subscriber_ext_properties( ld IN SESSION,
362: * RETURN PLS_INTEGER;
363: *
364: * REQUIRES
365: * This function requires a valid ldap session handle which
366: * has to be obtained from DBMS_LDAP.init() function.
367: *
368: * PARAMETERS
369: * (SESSION ) ld - A valid ldap session handle.
370: * (HANDLE ) subscriber_handle - The subscriber handle
371: * (VARCHAR2 ) dn - The subscriber DN
372: *
373: * RETURNS
374: *
375: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
376: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
377: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
378: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
379: * DN entries exist in the
372: *
373: * RETURNS
374: *
375: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
376: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
377: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
378: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
379: * DN entries exist in the
380: * directory for the given
373: * RETURNS
374: *
375: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
376: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
377: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
378: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
379: * DN entries exist in the
380: * directory for the given
381: * subscriber.
374: *
375: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
376: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
377: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
378: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
379: * DN entries exist in the
380: * directory for the given
381: * subscriber.
382: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
378: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
379: * DN entries exist in the
380: * directory for the given
381: * subscriber.
382: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
383: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
384: * DBMS_LDAP error codes - Returns proper LDAP error codes
385: * for unconditional failures
386: * while carrying out
379: * DN entries exist in the
380: * directory for the given
381: * subscriber.
382: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
383: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
384: * DBMS_LDAP error codes - Returns proper LDAP error codes
385: * for unconditional failures
386: * while carrying out
387: * LDAP operations by the ldap
380: * directory for the given
381: * subscriber.
382: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
383: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
384: * DBMS_LDAP error codes - Returns proper LDAP error codes
385: * for unconditional failures
386: * while carrying out
387: * LDAP operations by the ldap
388: * server.
389: *
390: *
391: * USAGE
392: * This function can only be called after a valid
393: * ldap session is obtained from a call to DBMS_LDAP.init().
394: *
395: * EXAMPLES
396: *
397: * SEE
394: *
395: * EXAMPLES
396: *
397: * SEE
398: * DBMS_LDAP.init().
399: *
400: ******************************************************************************
401: */
402: FUNCTION get_subscriber_dn( ld IN SESSION,
424: * PARAMETERS
425: * (PROPERTY_SET_COLLECTION ) pset_collection - Property set collection
426: * returned from one of the
427: * following functions:
428: * - DBMS_LDAP_UTL.get_group_membership().
429: * - DBMS_LDAP_UTL.get_subscriber_properties().
430: * - DBMS_LDAP_UTL.get_user_properties().
431: * - DBMS_LDAP_UTL.get_group_properties().
432: *
425: * (PROPERTY_SET_COLLECTION ) pset_collection - Property set collection
426: * returned from one of the
427: * following functions:
428: * - DBMS_LDAP_UTL.get_group_membership().
429: * - DBMS_LDAP_UTL.get_subscriber_properties().
430: * - DBMS_LDAP_UTL.get_user_properties().
431: * - DBMS_LDAP_UTL.get_group_properties().
432: *
433: * RETURNS
426: * returned from one of the
427: * following functions:
428: * - DBMS_LDAP_UTL.get_group_membership().
429: * - DBMS_LDAP_UTL.get_subscriber_properties().
430: * - DBMS_LDAP_UTL.get_user_properties().
431: * - DBMS_LDAP_UTL.get_group_properties().
432: *
433: * RETURNS
434: * NONE
427: * following functions:
428: * - DBMS_LDAP_UTL.get_group_membership().
429: * - DBMS_LDAP_UTL.get_subscriber_properties().
430: * - DBMS_LDAP_UTL.get_user_properties().
431: * - DBMS_LDAP_UTL.get_group_properties().
432: *
433: * RETURNS
434: * NONE
435: *
439: *
440: * EXAMPLES
441: *
442: * SEE
443: * DBMS_LDAP_UTL.get_group_membership(), DBMS_LDAP_UTL.get_subscriber_properties(), DBMS_LDAP_UTL.get_user_properties(), DBMS_LDAP_UTL.get_group_properties().
444: *
445: ******************************************************************************
446: */
447: PROCEDURE free_propertyset_collection ( pset_collection IN OUT PROPERTY_SET_COLLECTION);
473: * user.
474: * (PLS_INTEGER ) user_type - The type of user id that
475: * is passed.
476: * Valid values for this argument are:
477: * - DBMS_LDAP_UTL.TYPE_DN
478: * - DBMS_LDAP_UTL.TYPE_GUID
479: * - DBMS_LDAP_UTL.TYPE_NICKNAME
480: * (VARCHAR2 ) user_id - The user id representing
481: * the user entry.
474: * (PLS_INTEGER ) user_type - The type of user id that
475: * is passed.
476: * Valid values for this argument are:
477: * - DBMS_LDAP_UTL.TYPE_DN
478: * - DBMS_LDAP_UTL.TYPE_GUID
479: * - DBMS_LDAP_UTL.TYPE_NICKNAME
480: * (VARCHAR2 ) user_id - The user id representing
481: * the user entry.
482: *
475: * is passed.
476: * Valid values for this argument are:
477: * - DBMS_LDAP_UTL.TYPE_DN
478: * - DBMS_LDAP_UTL.TYPE_GUID
479: * - DBMS_LDAP_UTL.TYPE_NICKNAME
480: * (VARCHAR2 ) user_id - The user id representing
481: * the user entry.
482: *
483: * RETURNS
481: * the user entry.
482: *
483: * RETURNS
484: *
485: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
486: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
487: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
488: *
489: *
482: *
483: * RETURNS
484: *
485: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
486: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
487: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
488: *
489: *
490: * USAGE
483: * RETURNS
484: *
485: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
486: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
487: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
488: *
489: *
490: * USAGE
491: * N/A
492: *
493: * EXAMPLES
494: *
495: * SEE
496: * DBMS_LDAP_UTL.get_user_properties(), DBMS_LDAP_UTL.set_user_handle_properties().
497: *
498: ******************************************************************************
499: */
500: FUNCTION create_user_handle ( user_hd OUT HANDLE,
528: * user.
529: * (PLS_INTEGER ) property_type - The type of property that
530: * is passed.
531: * Valid values for this argument are:
532: * - DBMS_LDAP_UTL.SUBSCRIBER_HANDLE
533: * (HANDLE ) property - The property describing
534: * the user entry.
535: *
536: * RETURNS
534: * the user entry.
535: *
536: * RETURNS
537: *
538: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
539: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
540: * DBMS_LDAP_UTL.RESET_HANDLE - When caller tries to reset
541: * the existing handle
542: * properties.
535: *
536: * RETURNS
537: *
538: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
539: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
540: * DBMS_LDAP_UTL.RESET_HANDLE - When caller tries to reset
541: * the existing handle
542: * properties.
543: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
536: * RETURNS
537: *
538: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
539: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
540: * DBMS_LDAP_UTL.RESET_HANDLE - When caller tries to reset
541: * the existing handle
542: * properties.
543: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
544: *
539: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
540: * DBMS_LDAP_UTL.RESET_HANDLE - When caller tries to reset
541: * the existing handle
542: * properties.
543: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
544: *
545: *
546: * USAGE
547: * Subscriber Handle need not be set in User Handle Properties
550: *
551: * EXAMPLES
552: *
553: * SEE
554: * DBMS_LDAP_UTL.get_user_properties().
555: *
556: ******************************************************************************
557: */
558: FUNCTION set_user_handle_properties ( user_hd IN HANDLE,
582: * RETURN PLS_INTEGER;
583: *
584: * REQUIRES
585: * This function requires a valid ldap session handle which
586: * has to be obtained from DBMS_LDAP.init() function.
587: *
588: *
589: * PARAMETERS
590: * (SESSION ) ld - A valid ldap session handle.
594: * the user.
595: * (PLS_INTEGER ) ptype - Type of properties to be
596: * returned.
597: * Valid values:
598: * - DBMS_LDAP_UTL.ENTRY_PROPERITES
599: * - DBMS_LDAP_UTL.NICKNAME_PROPERTY
600: * (PROPERTY_SET_COLLECTION ) ret_pset_collection - The user details
601: * containing the requested
602: * attributes by the caller.
595: * (PLS_INTEGER ) ptype - Type of properties to be
596: * returned.
597: * Valid values:
598: * - DBMS_LDAP_UTL.ENTRY_PROPERITES
599: * - DBMS_LDAP_UTL.NICKNAME_PROPERTY
600: * (PROPERTY_SET_COLLECTION ) ret_pset_collection - The user details
601: * containing the requested
602: * attributes by the caller.
603: *
602: * attributes by the caller.
603: *
604: * RETURNS
605: *
606: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
607: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
608: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
609: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
610: * DN entries exist in the
603: *
604: * RETURNS
605: *
606: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
607: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
608: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
609: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
610: * DN entries exist in the
611: * directory for the given
604: * RETURNS
605: *
606: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
607: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
608: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
609: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
610: * DN entries exist in the
611: * directory for the given
612: * user.
605: *
606: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
607: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
608: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
609: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
610: * DN entries exist in the
611: * directory for the given
612: * user.
613: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
609: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
610: * DN entries exist in the
611: * directory for the given
612: * user.
613: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
614: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
615: * DBMS_LDAP error codes - Returns proper LDAP error codes
616: * for unconditional failures
617: * while carrying out
610: * DN entries exist in the
611: * directory for the given
612: * user.
613: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
614: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
615: * DBMS_LDAP error codes - Returns proper LDAP error codes
616: * for unconditional failures
617: * while carrying out
618: * LDAP operations by the ldap
611: * directory for the given
612: * user.
613: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
614: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
615: * DBMS_LDAP error codes - Returns proper LDAP error codes
616: * for unconditional failures
617: * while carrying out
618: * LDAP operations by the ldap
619: * server.
620: *
621: *
622: * USAGE
623: * This function requires a valid ldap session handle which
624: * has to be obtained from DBMS_LDAP.init() function.
625: *
626: * This function requires a valid subscriber handle to be set
627: * in the user handle properties if the user type is of:
628: * - DBMS_LDAP_UTL.TYPE_NICKNAME.
624: * has to be obtained from DBMS_LDAP.init() function.
625: *
626: * This function requires a valid subscriber handle to be set
627: * in the user handle properties if the user type is of:
628: * - DBMS_LDAP_UTL.TYPE_NICKNAME.
629: * This function doesn't identify a NULL subscriber handle
630: * as a default subscriber.
631: * Default subscriber can be obtained from :
632: * - DBMS_LDAP_UTL.create_subscriber_handle()
628: * - DBMS_LDAP_UTL.TYPE_NICKNAME.
629: * This function doesn't identify a NULL subscriber handle
630: * as a default subscriber.
631: * Default subscriber can be obtained from :
632: * - DBMS_LDAP_UTL.create_subscriber_handle()
633: * where a NULL subscriber_id is passed as an argument.
634: * If the user type is any of the following:
635: * - DBMS_LDAP_UTL.TYPE_GUID.
636: * - DBMS_LDAP_UTL.TYPE_DN.
631: * Default subscriber can be obtained from :
632: * - DBMS_LDAP_UTL.create_subscriber_handle()
633: * where a NULL subscriber_id is passed as an argument.
634: * If the user type is any of the following:
635: * - DBMS_LDAP_UTL.TYPE_GUID.
636: * - DBMS_LDAP_UTL.TYPE_DN.
637: * then the subscriber handle need not be set in the user
638: * handle properties, even if set it would be ignored.
639: *
632: * - DBMS_LDAP_UTL.create_subscriber_handle()
633: * where a NULL subscriber_id is passed as an argument.
634: * If the user type is any of the following:
635: * - DBMS_LDAP_UTL.TYPE_GUID.
636: * - DBMS_LDAP_UTL.TYPE_DN.
637: * then the subscriber handle need not be set in the user
638: * handle properties, even if set it would be ignored.
639: *
640: * EXAMPLES
639: *
640: * EXAMPLES
641: *
642: * SEE
643: * DBMS_LDAP.init(), DBMS_LDAP_UTL.create_user_handle().
644: *
645: ******************************************************************************
646: */
647: FUNCTION get_user_properties( ld IN SESSION,
671: * RETURN PLS_INTEGER;
672: *
673: * REQUIRES
674: * This function requires a valid ldap session handle which
675: * has to be obtained from DBMS_LDAP.init() function.
676: *
677: * PARAMETERS
678: * (SESSION ) ld - A valid ldap session handle.
679: * (HANDLE ) user_handle - The user handle
680: * (VARCHAR2 ) dn - The user DN
681: *
682: * RETURNS
683: *
684: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
685: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
686: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
687: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
688: * DN entries exist in the
681: *
682: * RETURNS
683: *
684: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
685: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
686: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
687: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
688: * DN entries exist in the
689: * directory for the given
682: * RETURNS
683: *
684: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
685: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
686: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
687: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
688: * DN entries exist in the
689: * directory for the given
690: * user.
683: *
684: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
685: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
686: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
687: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
688: * DN entries exist in the
689: * directory for the given
690: * user.
691: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
687: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
688: * DN entries exist in the
689: * directory for the given
690: * user.
691: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
692: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
693: * DBMS_LDAP error codes - Returns proper LDAP error codes
694: * for unconditional failures
695: * while carrying out
688: * DN entries exist in the
689: * directory for the given
690: * user.
691: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
692: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
693: * DBMS_LDAP error codes - Returns proper LDAP error codes
694: * for unconditional failures
695: * while carrying out
696: * LDAP operations by the ldap
689: * directory for the given
690: * user.
691: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
692: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
693: * DBMS_LDAP error codes - Returns proper LDAP error codes
694: * for unconditional failures
695: * while carrying out
696: * LDAP operations by the ldap
697: * server.
698: *
699: *
700: * USAGE
701: * This function can only be called after a valid
702: * ldap session is obtained from a call to DBMS_LDAP.init().
703: *
704: * EXAMPLES
705: *
706: * SEE
703: *
704: * EXAMPLES
705: *
706: * SEE
707: * DBMS_LDAP.init().
708: *
709: ******************************************************************************
710: */
711: FUNCTION get_user_dn( ld IN SESSION,
739: * group.
740: * (PLS_INTEGER ) group_type - The type of group id that
741: * is passed.
742: * Valid values for this argument are:
743: * - DBMS_LDAP_UTL.TYPE_DN
744: * - DBMS_LDAP_UTL.TYPE_GUID
745: * - DBMS_LDAP_UTL.TYPE_NICKNAME
746: * (VARCHAR2 ) group_id - The group id representing
747: * the group entry.
740: * (PLS_INTEGER ) group_type - The type of group id that
741: * is passed.
742: * Valid values for this argument are:
743: * - DBMS_LDAP_UTL.TYPE_DN
744: * - DBMS_LDAP_UTL.TYPE_GUID
745: * - DBMS_LDAP_UTL.TYPE_NICKNAME
746: * (VARCHAR2 ) group_id - The group id representing
747: * the group entry.
748: *
741: * is passed.
742: * Valid values for this argument are:
743: * - DBMS_LDAP_UTL.TYPE_DN
744: * - DBMS_LDAP_UTL.TYPE_GUID
745: * - DBMS_LDAP_UTL.TYPE_NICKNAME
746: * (VARCHAR2 ) group_id - The group id representing
747: * the group entry.
748: *
749: * RETURNS
747: * the group entry.
748: *
749: * RETURNS
750: *
751: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
752: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
753: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
754: *
755: *
748: *
749: * RETURNS
750: *
751: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
752: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
753: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
754: *
755: *
756: * USAGE
749: * RETURNS
750: *
751: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
752: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
753: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
754: *
755: *
756: * USAGE
757: * N/A
759: *
760: * EXAMPLES
761: *
762: * SEE
763: * DBMS_LDAP_UTL.get_group_properties(), DBMS_LDAP_UTL.set_group_handle_properties().
764: *
765: ******************************************************************************
766: */
767: FUNCTION create_group_handle ( group_hd OUT HANDLE,
795: * group.
796: * (PLS_INTEGER ) property_type - The type of property that
797: * is passed.
798: * Valid values for this argument are:
799: * - DBMS_LDAP_UTL.GROUP_HANDLE
800: * (HANDLE ) property - The property describing
801: * the group entry.
802: *
803: * RETURNS
801: * the group entry.
802: *
803: * RETURNS
804: *
805: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
806: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
807: * DBMS_LDAP_UTL.RESET_HANDLE - When caller tries to reset
808: * the existing handle
809: * properties.
802: *
803: * RETURNS
804: *
805: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
806: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
807: * DBMS_LDAP_UTL.RESET_HANDLE - When caller tries to reset
808: * the existing handle
809: * properties.
810: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
803: * RETURNS
804: *
805: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
806: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
807: * DBMS_LDAP_UTL.RESET_HANDLE - When caller tries to reset
808: * the existing handle
809: * properties.
810: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
811: *
806: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
807: * DBMS_LDAP_UTL.RESET_HANDLE - When caller tries to reset
808: * the existing handle
809: * properties.
810: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
811: *
812: *
813: * USAGE
814: * Subscriber Handle need not be set in Group Handle Properties
817: *
818: * EXAMPLES
819: *
820: * SEE
821: * DBMS_LDAP_UTL.get_group_properties().
822: *
823: ******************************************************************************
824: */
825: FUNCTION set_group_handle_properties ( group_hd IN HANDLE,
849: * RETURN PLS_INTEGER;
850: *
851: * REQUIRES
852: * This function requires a valid ldap session handle which
853: * has to be obtained from DBMS_LDAP.init() function.
854: *
855: * PARAMETERS
856: * (SESSION ) ld - A valid ldap session handle.
857: * (HANDLE ) group_handle - The group handle
860: * the group.
861: * (PLS_INTEGER ) ptype - Type of properties to be
862: * returned.
863: * Valid values:
864: * - DBMS_LDAP_UTL.ENTRY_PROPERITES
865: * (PROPERTY_SET_COLLECTION ) ret_pset_coll - The group details
866: * containing the requested
867: * attributes by the caller.
868: *
867: * attributes by the caller.
868: *
869: * RETURNS
870: *
871: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
872: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
873: * DBMS_LDAP_UTL.NO_SUCH_GROUP - Group doesn't exist.
874: * DBMS_LDAP_UTL.MULTIPLE_GROUP_ENTRIES - Multiple number of group
875: * DN entries exist in the
868: *
869: * RETURNS
870: *
871: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
872: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
873: * DBMS_LDAP_UTL.NO_SUCH_GROUP - Group doesn't exist.
874: * DBMS_LDAP_UTL.MULTIPLE_GROUP_ENTRIES - Multiple number of group
875: * DN entries exist in the
876: * directory for the given
869: * RETURNS
870: *
871: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
872: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
873: * DBMS_LDAP_UTL.NO_SUCH_GROUP - Group doesn't exist.
874: * DBMS_LDAP_UTL.MULTIPLE_GROUP_ENTRIES - Multiple number of group
875: * DN entries exist in the
876: * directory for the given
877: * group.
870: *
871: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
872: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
873: * DBMS_LDAP_UTL.NO_SUCH_GROUP - Group doesn't exist.
874: * DBMS_LDAP_UTL.MULTIPLE_GROUP_ENTRIES - Multiple number of group
875: * DN entries exist in the
876: * directory for the given
877: * group.
878: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
874: * DBMS_LDAP_UTL.MULTIPLE_GROUP_ENTRIES - Multiple number of group
875: * DN entries exist in the
876: * directory for the given
877: * group.
878: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
879: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
880: * DBMS_LDAP error codes - Returns proper LDAP error codes
881: * for unconditional failures
882: * while carrying out
875: * DN entries exist in the
876: * directory for the given
877: * group.
878: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
879: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
880: * DBMS_LDAP error codes - Returns proper LDAP error codes
881: * for unconditional failures
882: * while carrying out
883: * LDAP operations by the ldap
876: * directory for the given
877: * group.
878: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
879: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
880: * DBMS_LDAP error codes - Returns proper LDAP error codes
881: * for unconditional failures
882: * while carrying out
883: * LDAP operations by the ldap
884: * server.
885: *
886: *
887: * USAGE
888: * This function requires a valid ldap session handle which
889: * has to be obtained from DBMS_LDAP.init() function.
890: * This function requires a valid subscriber handle to be set
891: * in the group handle properties if the group type is of:
892: * - DBMS_LDAP_UTL.TYPE_NICKNAME.
893: * This function doesn't identify a NULL subscriber handle
888: * This function requires a valid ldap session handle which
889: * has to be obtained from DBMS_LDAP.init() function.
890: * This function requires a valid subscriber handle to be set
891: * in the group handle properties if the group type is of:
892: * - DBMS_LDAP_UTL.TYPE_NICKNAME.
893: * This function doesn't identify a NULL subscriber handle
894: * as a default subscriber.
895: * Default subscriber can be obtained from :
896: * - DBMS_LDAP_UTL.create_subscriber_handle()
892: * - DBMS_LDAP_UTL.TYPE_NICKNAME.
893: * This function doesn't identify a NULL subscriber handle
894: * as a default subscriber.
895: * Default subscriber can be obtained from :
896: * - DBMS_LDAP_UTL.create_subscriber_handle()
897: * where a NULL subscriber_id is passed as an argument.
898: * If the group type is any of the following:
899: * - DBMS_LDAP_UTL.TYPE_GUID.
900: * - DBMS_LDAP_UTL.TYPE_DN.
895: * Default subscriber can be obtained from :
896: * - DBMS_LDAP_UTL.create_subscriber_handle()
897: * where a NULL subscriber_id is passed as an argument.
898: * If the group type is any of the following:
899: * - DBMS_LDAP_UTL.TYPE_GUID.
900: * - DBMS_LDAP_UTL.TYPE_DN.
901: * then the subscriber handle need not be set in the group
902: * handle properties, even if set it would be ignored.
903: *
896: * - DBMS_LDAP_UTL.create_subscriber_handle()
897: * where a NULL subscriber_id is passed as an argument.
898: * If the group type is any of the following:
899: * - DBMS_LDAP_UTL.TYPE_GUID.
900: * - DBMS_LDAP_UTL.TYPE_DN.
901: * then the subscriber handle need not be set in the group
902: * handle properties, even if set it would be ignored.
903: *
904: * EXAMPLES
903: *
904: * EXAMPLES
905: *
906: * SEE
907: * DBMS_LDAP.init(), DBMS_LDAP_UTL.create_group_handle().
908: *
909: ******************************************************************************
910: */
911: FUNCTION get_group_properties( ld IN SESSION,
935: * RETURN PLS_INTEGER;
936: *
937: * REQUIRES
938: * This function requires a valid ldap session handle which
939: * has to be obtained from DBMS_LDAP.init() function.
940: *
941: * PARAMETERS
942: * (SESSION ) ld - A valid ldap session handle.
943: * (HANDLE ) group_handle - The group handle
944: * (VARCHAR2 ) dn - The group DN
945: *
946: * RETURNS
947: *
948: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
949: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
950: * DBMS_LDAP_UTL.NO_SUCH_GROUP - Group doesn't exist.
951: * DBMS_LDAP_UTL.MULTIPLE_GROUP_ENTRIES - Multiple number of group
952: * DN entries exist in the
945: *
946: * RETURNS
947: *
948: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
949: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
950: * DBMS_LDAP_UTL.NO_SUCH_GROUP - Group doesn't exist.
951: * DBMS_LDAP_UTL.MULTIPLE_GROUP_ENTRIES - Multiple number of group
952: * DN entries exist in the
953: * directory for the given
946: * RETURNS
947: *
948: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
949: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
950: * DBMS_LDAP_UTL.NO_SUCH_GROUP - Group doesn't exist.
951: * DBMS_LDAP_UTL.MULTIPLE_GROUP_ENTRIES - Multiple number of group
952: * DN entries exist in the
953: * directory for the given
954: * group.
947: *
948: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
949: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
950: * DBMS_LDAP_UTL.NO_SUCH_GROUP - Group doesn't exist.
951: * DBMS_LDAP_UTL.MULTIPLE_GROUP_ENTRIES - Multiple number of group
952: * DN entries exist in the
953: * directory for the given
954: * group.
955: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
951: * DBMS_LDAP_UTL.MULTIPLE_GROUP_ENTRIES - Multiple number of group
952: * DN entries exist in the
953: * directory for the given
954: * group.
955: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
956: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
957: * DBMS_LDAP error codes - Returns proper LDAP error codes
958: * for unconditional failures
959: * while carrying out
952: * DN entries exist in the
953: * directory for the given
954: * group.
955: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
956: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
957: * DBMS_LDAP error codes - Returns proper LDAP error codes
958: * for unconditional failures
959: * while carrying out
960: * LDAP operations by the ldap
953: * directory for the given
954: * group.
955: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
956: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
957: * DBMS_LDAP error codes - Returns proper LDAP error codes
958: * for unconditional failures
959: * while carrying out
960: * LDAP operations by the ldap
961: * server.
962: *
963: *
964: * USAGE
965: * This function can only be called after a valid
966: * ldap session is obtained from a call to DBMS_LDAP.init().
967: *
968: * EXAMPLES
969: *
970: * SEE
967: *
968: * EXAMPLES
969: *
970: * SEE
971: * DBMS_LDAP.init().
972: *
973: ******************************************************************************
974: */
975: FUNCTION get_group_dn( ld IN SESSION,
1006: * (SESSION ) ld - A valid ldap session handle.
1007: * (HANDLE ) user - User handle.
1008: * (PLS_INTEGER ) auth_type - Type of authentication,
1009: * Valid values are:
1010: * - DBMS_LDAP_UTL.AUTH_SIMPLE
1011: * (VARCHAR2 ) credentials - The user credentials,
1012: * Valid values :
1013: * for DBMS_LDAP_UTL.AUTH_SIMPLE - password
1014: * (RAW ) binary_credentials - The binary credentials,
1009: * Valid values are:
1010: * - DBMS_LDAP_UTL.AUTH_SIMPLE
1011: * (VARCHAR2 ) credentials - The user credentials,
1012: * Valid values :
1013: * for DBMS_LDAP_UTL.AUTH_SIMPLE - password
1014: * (RAW ) binary_credentials - The binary credentials,
1015: * Valid values :
1016: * for DBMS_LDAP_UTL.AUTH_SIMPLE - NULL
1017: *
1012: * Valid values :
1013: * for DBMS_LDAP_UTL.AUTH_SIMPLE - password
1014: * (RAW ) binary_credentials - The binary credentials,
1015: * Valid values :
1016: * for DBMS_LDAP_UTL.AUTH_SIMPLE - NULL
1017: *
1018: * RETURNS
1019: *
1020: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1016: * for DBMS_LDAP_UTL.AUTH_SIMPLE - NULL
1017: *
1018: * RETURNS
1019: *
1020: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1021: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1022: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1023: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1024: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1017: *
1018: * RETURNS
1019: *
1020: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1021: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1022: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1023: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1024: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1025: * entries exist in the
1018: * RETURNS
1019: *
1020: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1021: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1022: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1023: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1024: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1025: * entries exist in the
1026: * directory for the given user.
1019: *
1020: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1021: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1022: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1023: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1024: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1025: * entries exist in the
1026: * directory for the given user.
1027: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1020: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1021: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1022: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1023: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1024: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1025: * entries exist in the
1026: * directory for the given user.
1027: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1028: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1023: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1024: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1025: * entries exist in the
1026: * directory for the given user.
1027: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1028: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1029: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1030: * DN entries exist in the
1031: * directory for the given
1024: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1025: * entries exist in the
1026: * directory for the given user.
1027: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1028: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1029: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1030: * DN entries exist in the
1031: * directory for the given
1032: * subscriber.
1025: * entries exist in the
1026: * directory for the given user.
1027: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1028: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1029: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1030: * DN entries exist in the
1031: * directory for the given
1032: * subscriber.
1033: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1029: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1030: * DN entries exist in the
1031: * directory for the given
1032: * subscriber.
1033: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1034: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1035: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1036: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1037: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1030: * DN entries exist in the
1031: * directory for the given
1032: * subscriber.
1033: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1034: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1035: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1036: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1037: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1038: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1031: * directory for the given
1032: * subscriber.
1033: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1034: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1035: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1036: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1037: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1038: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1039: * LDAP error codes - Returns proper DBMS_LDAP error
1032: * subscriber.
1033: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1034: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1035: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1036: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1037: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1038: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1039: * LDAP error codes - Returns proper DBMS_LDAP error
1040: * codes for unconditional
1033: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1034: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1035: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1036: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1037: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1038: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1039: * LDAP error codes - Returns proper DBMS_LDAP error
1040: * codes for unconditional
1041: * failures while carrying out
1034: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1035: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1036: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1037: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1038: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1039: * LDAP error codes - Returns proper DBMS_LDAP error
1040: * codes for unconditional
1041: * failures while carrying out
1042: * LDAP operations by the ldap
1035: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1036: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1037: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1038: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1039: * LDAP error codes - Returns proper DBMS_LDAP error
1040: * codes for unconditional
1041: * failures while carrying out
1042: * LDAP operations by the ldap
1043: * server.
1043: * server.
1044: *
1045: * USAGE
1046: * This function can only be called after a valid
1047: * ldap session is obtained from a call to DBMS_LDAP.init().
1048: *
1049: * EXAMPLES
1050: *
1051: * SEE
1048: *
1049: * EXAMPLES
1050: *
1051: * SEE
1052: * DBMS_LDAP.init(), DBMS_LDAP_UTL.create_user_handle().
1053: *
1054: ****************************************************************************
1055: */
1056: FUNCTION authenticate_user( ld IN SESSION,
1091: * (SESSION ) ld - A valid ldap session handle.
1092: * (HANDLE ) user - User handle.
1093: * (PLS_INTEGER ) auth_type - Type of authentication,
1094: * Valid values are:
1095: * - DBMS_LDAP_UTL.AUTH_SIMPLE
1096: * (STRING_COLLECTION) attrs - List of required attributes
1097: * of user.
1098: * (VARCHAR2 ) credentials - The user credentials,
1099: * Valid values :
1096: * (STRING_COLLECTION) attrs - List of required attributes
1097: * of user.
1098: * (VARCHAR2 ) credentials - The user credentials,
1099: * Valid values :
1100: * for DBMS_LDAP_UTL.AUTH_SIMPLE - password
1101: * (RAW ) binary_credentials - The binary credentials,
1102: * Valid values :
1103: * for DBMS_LDAP_UTL.AUTH_SIMPLE - NULL
1104: * (PROPERTY_SET_COLLECTION ) ret_pset_coll - The user details
1099: * Valid values :
1100: * for DBMS_LDAP_UTL.AUTH_SIMPLE - password
1101: * (RAW ) binary_credentials - The binary credentials,
1102: * Valid values :
1103: * for DBMS_LDAP_UTL.AUTH_SIMPLE - NULL
1104: * (PROPERTY_SET_COLLECTION ) ret_pset_coll - The user details
1105: * containing the attributes
1106: * requested by the caller.
1107: *
1106: * requested by the caller.
1107: *
1108: * RETURNS
1109: *
1110: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1111: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1112: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1113: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1114: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1107: *
1108: * RETURNS
1109: *
1110: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1111: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1112: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1113: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1114: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1115: * entries exist in the
1108: * RETURNS
1109: *
1110: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1111: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1112: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1113: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1114: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1115: * entries exist in the
1116: * directory for the given user.
1109: *
1110: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1111: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1112: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1113: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1114: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1115: * entries exist in the
1116: * directory for the given user.
1117: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1110: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1111: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1112: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1113: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1114: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1115: * entries exist in the
1116: * directory for the given user.
1117: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1118: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1113: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1114: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1115: * entries exist in the
1116: * directory for the given user.
1117: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1118: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1119: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1120: * DN entries exist in the
1121: * directory for the given
1114: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1115: * entries exist in the
1116: * directory for the given user.
1117: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1118: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1119: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1120: * DN entries exist in the
1121: * directory for the given
1122: * subscriber.
1115: * entries exist in the
1116: * directory for the given user.
1117: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1118: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1119: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1120: * DN entries exist in the
1121: * directory for the given
1122: * subscriber.
1123: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1119: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1120: * DN entries exist in the
1121: * directory for the given
1122: * subscriber.
1123: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1124: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1125: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1126: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1127: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1120: * DN entries exist in the
1121: * directory for the given
1122: * subscriber.
1123: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1124: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1125: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1126: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1127: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1128: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1121: * directory for the given
1122: * subscriber.
1123: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1124: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1125: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1126: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1127: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1128: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1129: * LDAP error codes - Returns proper DBMS_LDAP error
1122: * subscriber.
1123: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1124: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1125: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1126: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1127: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1128: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1129: * LDAP error codes - Returns proper DBMS_LDAP error
1130: * codes for unconditional
1123: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1124: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1125: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1126: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1127: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1128: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1129: * LDAP error codes - Returns proper DBMS_LDAP error
1130: * codes for unconditional
1131: * failures while carrying out
1124: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1125: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1126: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1127: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1128: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1129: * LDAP error codes - Returns proper DBMS_LDAP error
1130: * codes for unconditional
1131: * failures while carrying out
1132: * LDAP operations by the ldap
1125: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1126: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1127: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1128: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1129: * LDAP error codes - Returns proper DBMS_LDAP error
1130: * codes for unconditional
1131: * failures while carrying out
1132: * LDAP operations by the ldap
1133: * server.
1133: * server.
1134: *
1135: * USAGE
1136: * This function can only be called after a valid
1137: * ldap session is obtained from a call to DBMS_LDAP.init().
1138: *
1139: * EXAMPLES
1140: *
1141: * SEE
1138: *
1139: * EXAMPLES
1140: *
1141: * SEE
1142: * DBMS_LDAP.init(), DBMS_LDAP_UTL.create_user_handle().
1143: *
1144: ****************************************************************************
1145: */
1146: FUNCTION get_user_props_and_auth( ld IN SESSION,
1181: * (SESSION ) ld - A valid ldap session handle.
1182: * (HANDLE ) user - User handle.
1183: * (PLS_INTEGER ) auth_type - Type of authentication,
1184: * Valid values are:
1185: * - DBMS_LDAP_UTL.AUTH_EXTENDED
1186: * (VARCHAR2 ) password_attr - The password attribute
1187: * for comparision.
1188: * (VARCHAR2) password - User Credentials.
1189: *
1188: * (VARCHAR2) password - User Credentials.
1189: *
1190: * RETURNS
1191: *
1192: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1193: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1194: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1195: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1196: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1189: *
1190: * RETURNS
1191: *
1192: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1193: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1194: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1195: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1196: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1197: * entries exist in the
1190: * RETURNS
1191: *
1192: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1193: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1194: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1195: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1196: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1197: * entries exist in the
1198: * directory for the given user.
1191: *
1192: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1193: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1194: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1195: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1196: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1197: * entries exist in the
1198: * directory for the given user.
1199: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1192: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1193: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1194: * DBMS_LDAP_UTL.GENERAL_ERROR - Authentication failed.
1195: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1196: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1197: * entries exist in the
1198: * directory for the given user.
1199: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1200: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1195: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1196: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1197: * entries exist in the
1198: * directory for the given user.
1199: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1200: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1201: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1202: * DN entries exist in the
1203: * directory for the given
1196: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user DN
1197: * entries exist in the
1198: * directory for the given user.
1199: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1200: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1201: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1202: * DN entries exist in the
1203: * directory for the given
1204: * subscriber.
1197: * entries exist in the
1198: * directory for the given user.
1199: * DBMS_LDAP_UTL.INVALID_SUBSCRIBER_ORCL_CTX - Invalid Subscriber Oracle Context.
1200: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1201: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1202: * DN entries exist in the
1203: * directory for the given
1204: * subscriber.
1205: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1201: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1202: * DN entries exist in the
1203: * directory for the given
1204: * subscriber.
1205: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1206: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1207: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1208: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1209: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1202: * DN entries exist in the
1203: * directory for the given
1204: * subscriber.
1205: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1206: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1207: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1208: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1209: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1210: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1203: * directory for the given
1204: * subscriber.
1205: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1206: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1207: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1208: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1209: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1210: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1211: * LDAP error codes - Returns proper DBMS_LDAP error
1204: * subscriber.
1205: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1206: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1207: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1208: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1209: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1210: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1211: * LDAP error codes - Returns proper DBMS_LDAP error
1212: * codes for unconditional
1205: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1206: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1207: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1208: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1209: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1210: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1211: * LDAP error codes - Returns proper DBMS_LDAP error
1212: * codes for unconditional
1213: * failures while carrying out
1206: * DBMS_LDAP_UTL.ACCT_TOTALLY_LOCKED_EXCP - User account is locked.
1207: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1208: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1209: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1210: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1211: * LDAP error codes - Returns proper DBMS_LDAP error
1212: * codes for unconditional
1213: * failures while carrying out
1214: * LDAP operations by the ldap
1207: * DBMS_LDAP_UTL.AUTH_PASSWD_CHANGE_WARN - Password should be changed.
1208: * DBMS_LDAP_UTL.AUTH_FAILURE_EXCP - Authentication failed.
1209: * DBMS_LDAP_UTL.PWD_EXPIRED_EXCP - User password has expired.
1210: * DBMS_LDAP_UTL.PWD_GRACELOGIN_WARN - Grace login for User.
1211: * LDAP error codes - Returns proper DBMS_LDAP error
1212: * codes for unconditional
1213: * failures while carrying out
1214: * LDAP operations by the ldap
1215: * server.
1215: * server.
1216: *
1217: * USAGE
1218: * This function can only be called after a valid
1219: * ldap session is obtained from a call to DBMS_LDAP.init().
1220: *
1221: * EXAMPLES
1222: *
1223: * SEE
1220: *
1221: * EXAMPLES
1222: *
1223: * SEE
1224: * DBMS_LDAP.init(), DBMS_LDAP_UTL.create_user_handle().
1225: *
1226: ****************************************************************************
1227: */
1228: FUNCTION authenticate_user_ext( ld IN SESSION,
1255: * RETURN PLS_INTEGER;
1256: *
1257: * REQUIRES
1258: * This function requires a valid ldap session handle which
1259: * has to be obtained from DBMS_LDAP.init() function.
1260: *
1261: * PARAMETERS
1262: * (SESSION ) ld - LDAP session handle.
1263: * (HANDLE ) user_handle - User handle.
1263: * (HANDLE ) user_handle - User handle.
1264: * (PLS_INTEGER ) nested - Type of membership the
1265: * user holds in groups
1266: * valid values are :
1267: * DBMS_LDAP_UTL.NESTED_MEMBERSHIP
1268: * DBMS_LDAP_UTL.DIRECT_MEMBERSHIP
1269: * (STRING_COLLECTION ) attr_list - List of attributes to be
1270: * returned.
1271: * (PROPERTY_SET_COLLECTION ) ret_groups - Pointer to pointer to a
1264: * (PLS_INTEGER ) nested - Type of membership the
1265: * user holds in groups
1266: * valid values are :
1267: * DBMS_LDAP_UTL.NESTED_MEMBERSHIP
1268: * DBMS_LDAP_UTL.DIRECT_MEMBERSHIP
1269: * (STRING_COLLECTION ) attr_list - List of attributes to be
1270: * returned.
1271: * (PROPERTY_SET_COLLECTION ) ret_groups - Pointer to pointer to a
1272: * array of group entries.
1272: * array of group entries.
1273: *
1274: * RETURNS
1275: *
1276: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1277: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1278: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1279: *
1280: *
1273: *
1274: * RETURNS
1275: *
1276: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1277: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1278: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1279: *
1280: *
1281: * USAGE
1274: * RETURNS
1275: *
1276: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1277: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1278: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1279: *
1280: *
1281: * USAGE
1282: * This function can only be called after a valid
1279: *
1280: *
1281: * USAGE
1282: * This function can only be called after a valid
1283: * ldap session is obtained from a call to DBMS_LDAP.init().
1284: *
1285: * EXAMPLES
1286: *
1287: * SEE
1284: *
1285: * EXAMPLES
1286: *
1287: * SEE
1288: * DBMS_LDAP.init().
1289: *
1290: ******************************************************************************
1291: */
1292: FUNCTION get_group_membership ( ld IN SESSION,
1325: *
1326: * EXAMPLES
1327: *
1328: * SEE
1329: * DBMS_LDAP_UTL.create_user_handle(), DBMS_LDAP_UTL.create_subscriber_handle(), DBMS_LDAP_UTL.create_group_handle().
1330: *
1331: ******************************************************************************
1332: */
1333: PROCEDURE free_handle ( handle IN OUT HANDLE);
1353: * RETURN PLS_INTEGER;
1354: *
1355: * REQUIRES
1356: * This function requires a valid ldap session handle which
1357: * has to be obtained from DBMS_LDAP.init() function.
1358: *
1359: * PARAMETERS
1360: * (SESSION ) ld - LDAP session handle.
1361: * (HANDLE ) user_handle - User handle.
1362: * (HANDLE ) group_handle - Group Handle.
1363: * (PLS_INTEGER ) nested - Type of membership the
1364: * user holds in groups
1365: * valid values are :
1366: * DBMS_LDAP_UTL.NESTED_MEMBERSHIP
1367: * DBMS_LDAP_UTL.DIRECT_MEMBERSHIP
1368: *
1369: * RETURNS
1370: *
1363: * (PLS_INTEGER ) nested - Type of membership the
1364: * user holds in groups
1365: * valid values are :
1366: * DBMS_LDAP_UTL.NESTED_MEMBERSHIP
1367: * DBMS_LDAP_UTL.DIRECT_MEMBERSHIP
1368: *
1369: * RETURNS
1370: *
1371: * DBMS_LDAP_UTL.SUCCESS - If user is a member.
1367: * DBMS_LDAP_UTL.DIRECT_MEMBERSHIP
1368: *
1369: * RETURNS
1370: *
1371: * DBMS_LDAP_UTL.SUCCESS - If user is a member.
1372: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1373: * DBMS_LDAP_UTL.NO_GROUP_MEMBERSHIP - If user is not a member.
1374: *
1375: *
1368: *
1369: * RETURNS
1370: *
1371: * DBMS_LDAP_UTL.SUCCESS - If user is a member.
1372: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1373: * DBMS_LDAP_UTL.NO_GROUP_MEMBERSHIP - If user is not a member.
1374: *
1375: *
1376: * USAGE
1369: * RETURNS
1370: *
1371: * DBMS_LDAP_UTL.SUCCESS - If user is a member.
1372: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1373: * DBMS_LDAP_UTL.NO_GROUP_MEMBERSHIP - If user is not a member.
1374: *
1375: *
1376: * USAGE
1377: * This function can only be called after a valid
1374: *
1375: *
1376: * USAGE
1377: * This function can only be called after a valid
1378: * ldap session is obtained from a call to DBMS_LDAP_UTL.init().
1379: *
1380: * EXAMPLES
1381: *
1382: * SEE
1379: *
1380: * EXAMPLES
1381: *
1382: * SEE
1383: * DBMS_LDAP_UTL.get_group_membership().
1384: *
1385: ******************************************************************************
1386: */
1387: FUNCTION check_group_membership( ld IN SESSION,
1413: * PARAMETERS
1414: * (PROPERTY_SET ) pset - PropertySet in the PropertySet collection
1415: * returned from any of
1416: the following functions:
1417: * - DBMS_LDAP_UTL.get_group_membership()
1418: * - DBMS_LDAP_UTL.get_subscriber_properties()
1419: * - DBMS_LDAP_UTL.get_user_properties()
1420: * - DBMS_LDAP_UTL.get_group_properties()
1421: * (STRING_COLLECTION) property_names - List of Property Names associated
1414: * (PROPERTY_SET ) pset - PropertySet in the PropertySet collection
1415: * returned from any of
1416: the following functions:
1417: * - DBMS_LDAP_UTL.get_group_membership()
1418: * - DBMS_LDAP_UTL.get_subscriber_properties()
1419: * - DBMS_LDAP_UTL.get_user_properties()
1420: * - DBMS_LDAP_UTL.get_group_properties()
1421: * (STRING_COLLECTION) property_names - List of Property Names associated
1422: * with PropertySet.
1415: * returned from any of
1416: the following functions:
1417: * - DBMS_LDAP_UTL.get_group_membership()
1418: * - DBMS_LDAP_UTL.get_subscriber_properties()
1419: * - DBMS_LDAP_UTL.get_user_properties()
1420: * - DBMS_LDAP_UTL.get_group_properties()
1421: * (STRING_COLLECTION) property_names - List of Property Names associated
1422: * with PropertySet.
1423: *
1416: the following functions:
1417: * - DBMS_LDAP_UTL.get_group_membership()
1418: * - DBMS_LDAP_UTL.get_subscriber_properties()
1419: * - DBMS_LDAP_UTL.get_user_properties()
1420: * - DBMS_LDAP_UTL.get_group_properties()
1421: * (STRING_COLLECTION) property_names - List of Property Names associated
1422: * with PropertySet.
1423: *
1424: * RETURNS
1422: * with PropertySet.
1423: *
1424: * RETURNS
1425: *
1426: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1427: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1428: * DBMS_LDAP_UTL.GENERAL_ERROR - On Error.
1429: *
1430: * USAGE
1423: *
1424: * RETURNS
1425: *
1426: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1427: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1428: * DBMS_LDAP_UTL.GENERAL_ERROR - On Error.
1429: *
1430: * USAGE
1431: * N/A
1424: * RETURNS
1425: *
1426: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1427: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1428: * DBMS_LDAP_UTL.GENERAL_ERROR - On Error.
1429: *
1430: * USAGE
1431: * N/A
1432: *
1432: *
1433: * EXAMPLES
1434: *
1435: * SEE
1436: * DBMS_LDAP_UTL.get_property_values().
1437: *
1438: ******************************************************************************
1439: */
1440: FUNCTION get_property_names( pset IN PROPERTY_SET,
1466: * PARAMETERS
1467: * (VARCHAR2 ) property_name - Property name.
1468: * (PROPERTY_SET ) pset - PropertySet in PropertySet Collection obtained from
1469: * any of the following function returns:
1470: * - DBMS_LDAP_UTL.get_group_membership()
1471: * - DBMS_LDAP_UTL.get_subscriber_properties()
1472: * - DBMS_LDAP_UTL.get_user_properties()
1473: * - DBMS_LDAP_UTL.get_group_properties()
1474: * (STRING_COLLECTION ) property_values - List of property values(strings).
1467: * (VARCHAR2 ) property_name - Property name.
1468: * (PROPERTY_SET ) pset - PropertySet in PropertySet Collection obtained from
1469: * any of the following function returns:
1470: * - DBMS_LDAP_UTL.get_group_membership()
1471: * - DBMS_LDAP_UTL.get_subscriber_properties()
1472: * - DBMS_LDAP_UTL.get_user_properties()
1473: * - DBMS_LDAP_UTL.get_group_properties()
1474: * (STRING_COLLECTION ) property_values - List of property values(strings).
1475: *
1468: * (PROPERTY_SET ) pset - PropertySet in PropertySet Collection obtained from
1469: * any of the following function returns:
1470: * - DBMS_LDAP_UTL.get_group_membership()
1471: * - DBMS_LDAP_UTL.get_subscriber_properties()
1472: * - DBMS_LDAP_UTL.get_user_properties()
1473: * - DBMS_LDAP_UTL.get_group_properties()
1474: * (STRING_COLLECTION ) property_values - List of property values(strings).
1475: *
1476: * RETURNS
1469: * any of the following function returns:
1470: * - DBMS_LDAP_UTL.get_group_membership()
1471: * - DBMS_LDAP_UTL.get_subscriber_properties()
1472: * - DBMS_LDAP_UTL.get_user_properties()
1473: * - DBMS_LDAP_UTL.get_group_properties()
1474: * (STRING_COLLECTION ) property_values - List of property values(strings).
1475: *
1476: * RETURNS
1477: *
1474: * (STRING_COLLECTION ) property_values - List of property values(strings).
1475: *
1476: * RETURNS
1477: *
1478: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1479: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1480: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1481: *
1482: *
1475: *
1476: * RETURNS
1477: *
1478: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1479: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1480: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1481: *
1482: *
1483: * USAGE
1476: * RETURNS
1477: *
1478: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1479: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1480: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1481: *
1482: *
1483: * USAGE
1484: * N/A
1485: *
1486: * EXAMPLES
1487: *
1488: * SEE
1489: * DBMS_LDAP_UTL.get_property_values_len().
1490: *
1491: ******************************************************************************
1492: */
1493: FUNCTION get_property_values(pset IN PROPERTY_SET,
1520: * PARAMETERS
1521: * (VARCHAR2 ) property_name - Property name.
1522: * (PROPERTY_SET ) pset - PropertySet in PropertySet Collection obtained from
1523: * any of the following function returns:
1524: * - DBMS_LDAP_UTL.get_group_membership()
1525: * - DBMS_LDAP_UTL.get_subscriber_properties()
1526: * - DBMS_LDAP_UTL.get_user_properties()
1527: * - DBMS_LDAP_UTL.get_group_properties()
1528: * (BINVAL_COLLECTION ) property_values - List of binary property values.
1521: * (VARCHAR2 ) property_name - Property name.
1522: * (PROPERTY_SET ) pset - PropertySet in PropertySet Collection obtained from
1523: * any of the following function returns:
1524: * - DBMS_LDAP_UTL.get_group_membership()
1525: * - DBMS_LDAP_UTL.get_subscriber_properties()
1526: * - DBMS_LDAP_UTL.get_user_properties()
1527: * - DBMS_LDAP_UTL.get_group_properties()
1528: * (BINVAL_COLLECTION ) property_values - List of binary property values.
1529: *
1522: * (PROPERTY_SET ) pset - PropertySet in PropertySet Collection obtained from
1523: * any of the following function returns:
1524: * - DBMS_LDAP_UTL.get_group_membership()
1525: * - DBMS_LDAP_UTL.get_subscriber_properties()
1526: * - DBMS_LDAP_UTL.get_user_properties()
1527: * - DBMS_LDAP_UTL.get_group_properties()
1528: * (BINVAL_COLLECTION ) property_values - List of binary property values.
1529: *
1530: * RETURNS
1523: * any of the following function returns:
1524: * - DBMS_LDAP_UTL.get_group_membership()
1525: * - DBMS_LDAP_UTL.get_subscriber_properties()
1526: * - DBMS_LDAP_UTL.get_user_properties()
1527: * - DBMS_LDAP_UTL.get_group_properties()
1528: * (BINVAL_COLLECTION ) property_values - List of binary property values.
1529: *
1530: * RETURNS
1531: *
1528: * (BINVAL_COLLECTION ) property_values - List of binary property values.
1529: *
1530: * RETURNS
1531: *
1532: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1533: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1534: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1535: *
1536: *
1529: *
1530: * RETURNS
1531: *
1532: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1533: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1534: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1535: *
1536: *
1537: * USAGE
1530: * RETURNS
1531: *
1532: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1533: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1534: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1535: *
1536: *
1537: * USAGE
1538: * N/A
1539: *
1540: * EXAMPLES
1541: *
1542: * SEE
1543: * DBMS_LDAP_UTL.get_property_values().
1544: *
1545: ******************************************************************************
1546: */
1547: FUNCTION get_property_values_len(pset IN PROPERTY_SET,
1574: * PARAMETERS
1575: * (VARCHAR2 ) property_name - Property name.
1576: * (PROPERTY_SET ) pset - PropertySet in PropertySet Collection obtained from
1577: * any of the following function returns:
1578: * - DBMS_LDAP_UTL.get_group_membership()
1579: * - DBMS_LDAP_UTL.get_subscriber_properties()
1580: * - DBMS_LDAP_UTL.get_user_properties()
1581: * - DBMS_LDAP_UTL.get_group_properties()
1582: * (BLOB_COLLECTION ) property_values - List of binary property values.
1575: * (VARCHAR2 ) property_name - Property name.
1576: * (PROPERTY_SET ) pset - PropertySet in PropertySet Collection obtained from
1577: * any of the following function returns:
1578: * - DBMS_LDAP_UTL.get_group_membership()
1579: * - DBMS_LDAP_UTL.get_subscriber_properties()
1580: * - DBMS_LDAP_UTL.get_user_properties()
1581: * - DBMS_LDAP_UTL.get_group_properties()
1582: * (BLOB_COLLECTION ) property_values - List of binary property values.
1583: *
1576: * (PROPERTY_SET ) pset - PropertySet in PropertySet Collection obtained from
1577: * any of the following function returns:
1578: * - DBMS_LDAP_UTL.get_group_membership()
1579: * - DBMS_LDAP_UTL.get_subscriber_properties()
1580: * - DBMS_LDAP_UTL.get_user_properties()
1581: * - DBMS_LDAP_UTL.get_group_properties()
1582: * (BLOB_COLLECTION ) property_values - List of binary property values.
1583: *
1584: * RETURNS
1577: * any of the following function returns:
1578: * - DBMS_LDAP_UTL.get_group_membership()
1579: * - DBMS_LDAP_UTL.get_subscriber_properties()
1580: * - DBMS_LDAP_UTL.get_user_properties()
1581: * - DBMS_LDAP_UTL.get_group_properties()
1582: * (BLOB_COLLECTION ) property_values - List of binary property values.
1583: *
1584: * RETURNS
1585: *
1582: * (BLOB_COLLECTION ) property_values - List of binary property values.
1583: *
1584: * RETURNS
1585: *
1586: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1587: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1588: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1589: *
1590: *
1583: *
1584: * RETURNS
1585: *
1586: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1587: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1588: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1589: *
1590: *
1591: * USAGE
1584: * RETURNS
1585: *
1586: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1587: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1588: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1589: *
1590: *
1591: * USAGE
1592: * N/A
1593: *
1594: * EXAMPLES
1595: *
1596: * SEE
1597: * DBMS_LDAP_UTL.get_property_values().
1598: *
1599: ******************************************************************************
1600: */
1601: FUNCTION get_property_values_blob(pset IN PROPERTY_SET,
1626: * get_property_values_len
1627: *
1628: * RETURNS
1629: *
1630: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1631: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1632: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1633: *
1634: *
1627: *
1628: * RETURNS
1629: *
1630: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1631: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1632: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1633: *
1634: *
1635: * USAGE
1628: * RETURNS
1629: *
1630: * DBMS_LDAP_UTL.SUCCESS - On successful completion.
1631: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
1632: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
1633: *
1634: *
1635: * USAGE
1636: * N/A
1637: *
1638: * EXAMPLES
1639: *
1640: * SEE
1641: * DBMS_LDAP_UTL.get_property_values_len().
1642: *
1643: ******************************************************************************
1644: */
1645: PROCEDURE property_value_free_blob(vals IN OUT BLOB_COLLECTION);
1673: * (HANDLE ) subscriber_handle - The subscriber handle.
1674:
1675: * RETURNS
1676: *
1677: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1678: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1679: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1680: * DN entries exist in the
1681: * directory for the given
1674:
1675: * RETURNS
1676: *
1677: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1678: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1679: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1680: * DN entries exist in the
1681: * directory for the given
1682: * subscriber.
1675: * RETURNS
1676: *
1677: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1678: * DBMS_LDAP_UTL.NO_SUCH_SUBSCRIBER - Subscriber doesn't exist.
1679: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1680: * DN entries exist in the
1681: * directory for the given
1682: * subscriber.
1683: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1679: * DBMS_LDAP_UTL.MULTIPLE_SUBSCRIBER_ENTRIES - Multiple number of subscriber
1680: * DN entries exist in the
1681: * directory for the given
1682: * subscriber.
1683: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1684: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
1685: * DN entries exist in the
1686: * directory for the given
1687: * user.
1680: * DN entries exist in the
1681: * directory for the given
1682: * subscriber.
1683: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1684: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
1685: * DN entries exist in the
1686: * directory for the given
1687: * user.
1688: * DBMS_LDAP_UTL.SUBSCRIBER_NOT_FOUND - Unable to locate subscriber
1684: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
1685: * DN entries exist in the
1686: * directory for the given
1687: * user.
1688: * DBMS_LDAP_UTL.SUBSCRIBER_NOT_FOUND - Unable to locate subscriber
1689: * for the given user.
1690: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1691: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1692: * LDAP error codes - Returns proper LDAP error codes
1686: * directory for the given
1687: * user.
1688: * DBMS_LDAP_UTL.SUBSCRIBER_NOT_FOUND - Unable to locate subscriber
1689: * for the given user.
1690: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1691: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1692: * LDAP error codes - Returns proper LDAP error codes
1693: * for unconditional failures
1694: * while carrying out
1687: * user.
1688: * DBMS_LDAP_UTL.SUBSCRIBER_NOT_FOUND - Unable to locate subscriber
1689: * for the given user.
1690: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1691: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1692: * LDAP error codes - Returns proper LDAP error codes
1693: * for unconditional failures
1694: * while carrying out
1695: * LDAP operations by the ldap
1702: *
1703: * EXAMPLES
1704: *
1705: * SEE
1706: * DBMS_LDAP.init(), DBMS_LDAP_UTL.create_user_handle().
1707: *
1708: ******************************************************************************
1709: */
1710: FUNCTION locate_subscriber_for_user ( ld IN SESSION,
1756: * - DELETE_PROPERTYSET
1757: *
1758: * RETURNS
1759: *
1760: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1761: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1762: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
1763: * DN entries exist in the
1764: * directory for the given
1757: *
1758: * RETURNS
1759: *
1760: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1761: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1762: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
1763: * DN entries exist in the
1764: * directory for the given
1765: * user.
1758: * RETURNS
1759: *
1760: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1761: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
1762: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
1763: * DN entries exist in the
1764: * directory for the given
1765: * user.
1766: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1762: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
1763: * DN entries exist in the
1764: * directory for the given
1765: * user.
1766: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1767: * DBMS_LDAP_UTL.PWD_MIN_LENGTH_ERROR - Password length is less
1768: * than minimum required
1769: * length.
1770: * DBMS_LDAP_UTL.PWD_NUMERIC_ERROR - Password must contain
1763: * DN entries exist in the
1764: * directory for the given
1765: * user.
1766: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1767: * DBMS_LDAP_UTL.PWD_MIN_LENGTH_ERROR - Password length is less
1768: * than minimum required
1769: * length.
1770: * DBMS_LDAP_UTL.PWD_NUMERIC_ERROR - Password must contain
1771: * numeric characters.
1766: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
1767: * DBMS_LDAP_UTL.PWD_MIN_LENGTH_ERROR - Password length is less
1768: * than minimum required
1769: * length.
1770: * DBMS_LDAP_UTL.PWD_NUMERIC_ERROR - Password must contain
1771: * numeric characters.
1772: * DBMS_LDAP_UTL.PWD_NULL_ERROR - Password cannot be NULL.
1773: * DBMS_LDAP_UTL.PWD_INHISTORY_ERROR - Password cannot not be
1774: * the same as the one
1768: * than minimum required
1769: * length.
1770: * DBMS_LDAP_UTL.PWD_NUMERIC_ERROR - Password must contain
1771: * numeric characters.
1772: * DBMS_LDAP_UTL.PWD_NULL_ERROR - Password cannot be NULL.
1773: * DBMS_LDAP_UTL.PWD_INHISTORY_ERROR - Password cannot not be
1774: * the same as the one
1775: * that is being replaced.
1776: * DBMS_LDAP_UTL.PWD_ILLEGALVALUE_ERROR - Password contains
1769: * length.
1770: * DBMS_LDAP_UTL.PWD_NUMERIC_ERROR - Password must contain
1771: * numeric characters.
1772: * DBMS_LDAP_UTL.PWD_NULL_ERROR - Password cannot be NULL.
1773: * DBMS_LDAP_UTL.PWD_INHISTORY_ERROR - Password cannot not be
1774: * the same as the one
1775: * that is being replaced.
1776: * DBMS_LDAP_UTL.PWD_ILLEGALVALUE_ERROR - Password contains
1777: * illegal characters.
1772: * DBMS_LDAP_UTL.PWD_NULL_ERROR - Password cannot be NULL.
1773: * DBMS_LDAP_UTL.PWD_INHISTORY_ERROR - Password cannot not be
1774: * the same as the one
1775: * that is being replaced.
1776: * DBMS_LDAP_UTL.PWD_ILLEGALVALUE_ERROR - Password contains
1777: * illegal characters.
1778: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1779: * LDAP error codes - Returns proper LDAP error codes
1780: * for unconditional failures
1774: * the same as the one
1775: * that is being replaced.
1776: * DBMS_LDAP_UTL.PWD_ILLEGALVALUE_ERROR - Password contains
1777: * illegal characters.
1778: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1779: * LDAP error codes - Returns proper LDAP error codes
1780: * for unconditional failures
1781: * while carrying out
1782: * LDAP operations by the ldap
1790: *
1791: * EXAMPLES
1792: *
1793: * SEE
1794: * DBMS_LDAP.init(), DBMS_LDAP_UTL.get_user_properties().
1795: *
1796: ******************************************************************************
1797: */
1798: FUNCTION set_user_properties ( ld IN SESSION,
1838: * Modify operations to be
1839: * performed on PropertySet.
1840: * RETURNS
1841: *
1842: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1843: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1844: *
1845: *
1846: * USAGE
1839: * performed on PropertySet.
1840: * RETURNS
1841: *
1842: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1843: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1844: *
1845: *
1846: * USAGE
1847: * N/A
1848: *
1849: * EXAMPLES
1850: *
1851: * SEE
1852: * DBMS_LDAP_UTL.populate_mod_propertyset().
1853: *
1854: ******************************************************************************
1855: */
1856: FUNCTION create_mod_propertyset ( pset_type IN PLS_INTEGER,
1895: * Property.
1896: *
1897: * RETURNS
1898: *
1899: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1900: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1901: *
1902: *
1903: * USAGE
1896: *
1897: * RETURNS
1898: *
1899: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1900: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1901: *
1902: *
1903: * USAGE
1904: * N/A
1906: *
1907: * EXAMPLES
1908: *
1909: * SEE
1910: * DBMS_LDAP_UTL.create_mod_propertyset().
1911: *
1912: ******************************************************************************
1913: */
1914: FUNCTION populate_mod_propertyset ( mod_pset IN MOD_PROPERTY_SET,
1940: * (PROPERTY_SET) mod_pset - Mod-PropertySet data structure.
1941: *
1942: * RETURNS
1943: *
1944: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1945: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1946: *
1947: *
1948: * USAGE
1941: *
1942: * RETURNS
1943: *
1944: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
1945: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
1946: *
1947: *
1948: * USAGE
1949: * N/A
1950: *
1951: * EXAMPLES
1952: *
1953: * SEE
1954: * DBMS_LDAP_UTL.create_mod_propertyset().
1955: *
1956: ******************************************************************************
1957: */
1958: PROCEDURE free_mod_propertyset ( mod_pset IN OUT MOD_PROPERTY_SET);
1991: * the user.
1992: * (PLS_INTEGER ) ptype - Type of properties to be
1993: * returned.
1994: * Valid values:
1995: * - DBMS_LDAP_UTL.EXTPROPTYPE_RAD
1996: * (VARCHAR2) filter - Ldap filter to further
1997: * refine the user properties
1998: * returned by function.
1999: * (PROPERTY_SET_COLLECTION ) ret_pset_collection - The user details
2001: * attributes by the caller.
2002: *
2003: * RETURNS
2004: *
2005: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2006: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2007: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
2008: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
2009: * DN entries exist in the
2002: *
2003: * RETURNS
2004: *
2005: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2006: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2007: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
2008: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
2009: * DN entries exist in the
2010: * directory for the given
2003: * RETURNS
2004: *
2005: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2006: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2007: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
2008: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
2009: * DN entries exist in the
2010: * directory for the given
2011: * user.
2004: *
2005: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2006: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2007: * DBMS_LDAP_UTL.NO_SUCH_USER - User doesn't exist.
2008: * DBMS_LDAP_UTL.MULTIPLE_USER_ENTRIES - Multiple number of user
2009: * DN entries exist in the
2010: * directory for the given
2011: * user.
2012: * USER_PROPERTY_NOT_FOUND - User Extended Property
2010: * directory for the given
2011: * user.
2012: * USER_PROPERTY_NOT_FOUND - User Extended Property
2013: * doesn't exist.
2014: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
2015: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2016: * DBMS_LDAP error codes - Returns proper LDAP error codes
2017: * for unconditional failures
2018: * while carrying out
2011: * user.
2012: * USER_PROPERTY_NOT_FOUND - User Extended Property
2013: * doesn't exist.
2014: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
2015: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2016: * DBMS_LDAP error codes - Returns proper LDAP error codes
2017: * for unconditional failures
2018: * while carrying out
2019: * LDAP operations by the ldap
2012: * USER_PROPERTY_NOT_FOUND - User Extended Property
2013: * doesn't exist.
2014: * DBMS_LDAP_UTL.INVALID_ROOT_ORCL_CTX - Invalid Root Oracle Context.
2015: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2016: * DBMS_LDAP error codes - Returns proper LDAP error codes
2017: * for unconditional failures
2018: * while carrying out
2019: * LDAP operations by the ldap
2020: * server.
2020: * server.
2021: *
2022: * USAGE
2023: * This function can only be called after a valid
2024: * ldap session is obtained from a call to DBMS_LDAP.init().
2025: *
2026: * EXAMPLES
2027: *
2028: * SEE
2025: *
2026: * EXAMPLES
2027: *
2028: * SEE
2029: * DBMS_LDAP.init(), DBMS_LDAP_UTL.get_user_properties().
2030: *
2031: ******************************************************************************
2032: */
2033: FUNCTION get_user_extended_properties ( ld IN SESSION,
2073: * (VARCHAR2 ) norm_dn - Normalized DN.
2074: *
2075: * RETURNS
2076: *
2077: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2078: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2079: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
2080: *
2081: * USAGE
2074: *
2075: * RETURNS
2076: *
2077: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2078: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2079: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
2080: *
2081: * USAGE
2082: * N/A
2075: * RETURNS
2076: *
2077: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2078: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2079: * DBMS_LDAP_UTL.GENERAL_ERROR - On failure.
2080: *
2081: * USAGE
2082: * N/A
2083: *
2119: * service.
2120: * (PLS_INTEGER ) service_type - The type of service id that
2121: * is passed.
2122: * Valid values for this argument are:
2123: * - DBMS_LDAP_UTL.TYPE_DN
2124: * (VARCHAR2 ) service_id - The service id representing
2125: * the service entry.
2126: *
2127: * RETURNS
2125: * the service entry.
2126: *
2127: * RETURNS
2128: *
2129: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2130: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2131: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2132: *
2133: *
2126: *
2127: * RETURNS
2128: *
2129: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2130: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2131: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2132: *
2133: *
2134: * USAGE
2127: * RETURNS
2128: *
2129: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2130: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2131: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2132: *
2133: *
2134: * USAGE
2135: * N/A
2136: *
2137: * EXAMPLES
2138: *
2139: * SEE
2140: * DBMS_LDAP_UTL.get_subscribed_users().
2141: *
2142: ******************************************************************************
2143: */
2144: FUNCTION create_service_handle ( service_handle OUT HANDLE,
2176: * (STRING_COLLECTION ) users - List of users subscribed to a service.
2177: *
2178: * RETURNS
2179: *
2180: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2181: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2182: * DBMS_LDAP_UTL.NO_SUCH_SERVICE - Service doesn't exist.
2183: * DBMS_LDAP_UTL.NO_USER_SUBSCRIPTIONS - No users have been
2184: * subscribed for this
2177: *
2178: * RETURNS
2179: *
2180: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2181: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2182: * DBMS_LDAP_UTL.NO_SUCH_SERVICE - Service doesn't exist.
2183: * DBMS_LDAP_UTL.NO_USER_SUBSCRIPTIONS - No users have been
2184: * subscribed for this
2185: * service.
2178: * RETURNS
2179: *
2180: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2181: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2182: * DBMS_LDAP_UTL.NO_SUCH_SERVICE - Service doesn't exist.
2183: * DBMS_LDAP_UTL.NO_USER_SUBSCRIPTIONS - No users have been
2184: * subscribed for this
2185: * service.
2186: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2179: *
2180: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2181: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2182: * DBMS_LDAP_UTL.NO_SUCH_SERVICE - Service doesn't exist.
2183: * DBMS_LDAP_UTL.NO_USER_SUBSCRIPTIONS - No users have been
2184: * subscribed for this
2185: * service.
2186: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2187: *
2182: * DBMS_LDAP_UTL.NO_SUCH_SERVICE - Service doesn't exist.
2183: * DBMS_LDAP_UTL.NO_USER_SUBSCRIPTIONS - No users have been
2184: * subscribed for this
2185: * service.
2186: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2187: *
2188: *
2189: * USAGE
2190: * N/A
2191: *
2192: * EXAMPLES
2193: *
2194: * SEE
2195: * DBMS_LDAP_UTL.check_user_subscription(), DBMS_LDAP_UTL.subscribe_user(), DBMS_LDAP_UTL.unsubscribe_user().
2196: *
2197: ******************************************************************************
2198: */
2199: FUNCTION get_subscribed_users ( ld IN SESSION,
2231: * (STRING_COLLECTION ) services - List of services to which a user is subscribed.
2232: *
2233: * RETURNS
2234: *
2235: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2236: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2237: * DBMS_LDAP_UTL.NO_SUBSCRIPTIONS_TO_SERVICES - User hasen't been
2238: * subscribed to any
2239: * services.
2232: *
2233: * RETURNS
2234: *
2235: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2236: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2237: * DBMS_LDAP_UTL.NO_SUBSCRIPTIONS_TO_SERVICES - User hasen't been
2238: * subscribed to any
2239: * services.
2240: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2233: * RETURNS
2234: *
2235: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2236: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2237: * DBMS_LDAP_UTL.NO_SUBSCRIPTIONS_TO_SERVICES - User hasen't been
2238: * subscribed to any
2239: * services.
2240: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2241: *
2236: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2237: * DBMS_LDAP_UTL.NO_SUBSCRIPTIONS_TO_SERVICES - User hasen't been
2238: * subscribed to any
2239: * services.
2240: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2241: *
2242: *
2243: * USAGE
2244: * N/A
2245: *
2246: * EXAMPLES
2247: *
2248: * SEE
2249: * DBMS_LDAP_UTL.get_available_services().
2250: *
2251: ******************************************************************************
2252: */
2253: FUNCTION get_subscribed_services ( ld IN SESSION,
2284: * (STRING_COLLECTION ) services - List of services under a subscriber.
2285: *
2286: * RETURNS
2287: *
2288: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2289: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2290: * DBMS_LDAP_UTL.NO_SERVICES_INSTALLED - No services are
2291: * available for this
2292: * Subscriber.
2285: *
2286: * RETURNS
2287: *
2288: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2289: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2290: * DBMS_LDAP_UTL.NO_SERVICES_INSTALLED - No services are
2291: * available for this
2292: * Subscriber.
2293: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2286: * RETURNS
2287: *
2288: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2289: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2290: * DBMS_LDAP_UTL.NO_SERVICES_INSTALLED - No services are
2291: * available for this
2292: * Subscriber.
2293: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2294: *
2289: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2290: * DBMS_LDAP_UTL.NO_SERVICES_INSTALLED - No services are
2291: * available for this
2292: * Subscriber.
2293: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2294: *
2295: *
2296: * USAGE
2297: * N/A
2298: *
2299: * EXAMPLES
2300: *
2301: * SEE
2302: * DBMS_LDAP_UTL.get_subscribed_services().
2303: *
2304: ******************************************************************************
2305: */
2306: FUNCTION get_available_services ( ld IN SESSION,
2339: * service.
2340: *
2341: * RETURNS
2342: *
2343: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2344: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2345: * DBMS_LDAP_UTL.USER_NOT_SUBSCRIBED - User is not subscribed
2346: * to the Service.
2347: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2340: *
2341: * RETURNS
2342: *
2343: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2344: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2345: * DBMS_LDAP_UTL.USER_NOT_SUBSCRIBED - User is not subscribed
2346: * to the Service.
2347: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2348: *
2341: * RETURNS
2342: *
2343: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2344: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2345: * DBMS_LDAP_UTL.USER_NOT_SUBSCRIBED - User is not subscribed
2346: * to the Service.
2347: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2348: *
2349: *
2343: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2344: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2345: * DBMS_LDAP_UTL.USER_NOT_SUBSCRIBED - User is not subscribed
2346: * to the Service.
2347: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2348: *
2349: *
2350: * USAGE
2351: * N/A
2352: *
2353: * EXAMPLES
2354: *
2355: * SEE
2356: * DBMS_LDAP_UTL.subscribe_user(), DBMS_LDAP_UTL.unsubscribe_user().
2357: *
2358: ******************************************************************************
2359: */
2360: FUNCTION check_user_subscription ( ld IN SESSION,
2393: * service.
2394: *
2395: * RETURNS
2396: *
2397: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2398: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2399: * DBMS_LDAP_UTL.INVALID_SERVICE_SCHEMA - Unable to subscribe
2400: * the user due to
2401: * invalid service schema
2394: *
2395: * RETURNS
2396: *
2397: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2398: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2399: * DBMS_LDAP_UTL.INVALID_SERVICE_SCHEMA - Unable to subscribe
2400: * the user due to
2401: * invalid service schema
2402: * in Subscriber Oracle
2395: * RETURNS
2396: *
2397: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2398: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2399: * DBMS_LDAP_UTL.INVALID_SERVICE_SCHEMA - Unable to subscribe
2400: * the user due to
2401: * invalid service schema
2402: * in Subscriber Oracle
2403: * Context.
2400: * the user due to
2401: * invalid service schema
2402: * in Subscriber Oracle
2403: * Context.
2404: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2405: *
2406: *
2407: * USAGE
2408: * N/A
2409: *
2410: * EXAMPLES
2411: *
2412: * SEE
2413: * DBMS_LDAP_UTL.unsubscribe_user(), DBMS_LDAP_UTL.check_user_subscription().
2414: *
2415: ******************************************************************************
2416: */
2417: FUNCTION subscribe_user ( ld IN SESSION,
2450: * service.
2451: *
2452: * RETURNS
2453: *
2454: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2455: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2456: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2457: *
2458: *
2451: *
2452: * RETURNS
2453: *
2454: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2455: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2456: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2457: *
2458: *
2459: * USAGE
2452: * RETURNS
2453: *
2454: * DBMS_LDAP_UTL.SUCCESS - On a successful completion.
2455: * DBMS_LDAP_UTL.PARAM_ERROR - Invalid input parameters.
2456: * DBMS_LDAP_UTL.GENERAL_ERROR - Other Error
2457: *
2458: *
2459: * USAGE
2460: * N/A
2461: *
2462: * EXAMPLES
2463: *
2464: * SEE
2465: * DBMS_LDAP_UTL.subscribe_user().
2466: *
2467: ******************************************************************************
2468: */
2469: FUNCTION unsubscribe_user ( ld IN SESSION,
2472: RETURN PLS_INTEGER;
2473:
2474: -- Error Code Constants
2475:
2476: -- Except for DBMS_LDAP_UTL.SUCCESS all error codes are negative,
2477: -- (this is to distinguish them from DBMS_LDAP error codes)
2478:
2479: -- Successful completion
2480: SUCCESS CONSTANT NUMBER := 0;
2473:
2474: -- Error Code Constants
2475:
2476: -- Except for DBMS_LDAP_UTL.SUCCESS all error codes are negative,
2477: -- (this is to distinguish them from DBMS_LDAP error codes)
2478:
2479: -- Successful completion
2480: SUCCESS CONSTANT NUMBER := 0;
2481:
2611: APP_HANDLE CONSTANT NUMBER := 4;
2612: ORCLCTX_HANDLE CONSTANT NUMBER := 5;
2613: SERVICE_HANDLE CONSTANT NUMBER := 6;
2614:
2615: END DBMS_LDAP_UTL;