Skip navigation links

oracle.iam.configservice.api
Interface LDAPUDFSync

public interface LDAPUDFSync

Nested Class Summary

static class

LDAPUDFSync.MDSENTITY

Method Summary

void	addUDFwithLDAP(Constants.Entity entity, java.lang.String udfName, java.lang.String ldapAttrName, boolean skipOVDValidation) Modifies the LDAP entity, RECON entity, RECON profile in MDS and creates a new column in RECON Horizontal DB table to effect UDF creation in LDAP Sync environment.
void	addUDFwithLDAP(Constants.Entity entity, java.lang.String udfName, java.lang.String ldapAttrName, boolean skipOVDValidation, LDAPUDFSync.MDSENTITY mdsentity) Modifies the LDAP entity, RECON entity, RECON profile in MDS and creates a new column in RECON Horizontal DB table to effect UDF creation in LDAP Sync environment.
void	deleteUDFwithLDAP(Constants.Entity entity, java.lang.String udfName) Deletes the given UDF from LDAP entity, RECON entity and RECON profile in MDS, also deletes the corresponding column from RECON Horizontal Table.
void	deleteUDFwithLDAP(Constants.Entity entity, java.lang.String udfName, LDAPUDFSync.MDSENTITY mdsentity) Deletes the given UDF from LDAP entity, RECON entity and RECON profile in MDS, also deletes the corresponding column from RECON Horizontal Table.

Method Detail

addUDFwithLDAP

void addUDFwithLDAP(Constants.Entity entity,
                    java.lang.String udfName,
                    java.lang.String ldapAttrName,
                    boolean skipOVDValidation)
                    throws AccessDeniedException,
                           NoSuchEntityException,
                           AttributeValidationFailedException,
                           ConfigManagerException,
                           AttributeAlreadyExistsException,
                           NoSuchAttributeException

Modifies the LDAP entity, RECON entity, RECON profile in MDS and creates a new column in RECON Horizontal DB table to effect UDF creation in LDAP Sync environment. Before invoking this service, please ensure that: 1. OIM UDF is already created and 2. LDAP attribute is added in the backed LDAP schema as well as OVD schema. 3. LDAP attribute is added to entity objectclass both in backed LDAP schema as well as OVD schema.

Parameters:

entity - Entity type (User/Role) for which UDF will be added

udfName - Name of the UDF in OIM entity.

ldapAttrName - Name of the LDAP/RECON attribute name to which the OIM UDF will be mapped to.

skipOVDValidation - If true the LDAP attribute is not validated in OVD schema

Throws:

AccessDeniedException - Logged-in user doesn't have permission to ADD UDF.

NoSuchEntityException - The entity type passed as input is not supported.

AttributeValidationFailedException - The pre-requisite mantioned above are not met.

ConfigManagerException - Some unexpected error occurs while performing the operation.

AttributeAlreadyExistsException - The attribute is already present in Entity/Profile XML.

NoSuchAttributeException - The UDF is not properly created in OIM, either in DB or MDS.

addUDFwithLDAP

void addUDFwithLDAP(Constants.Entity entity,
                    java.lang.String udfName,
                    java.lang.String ldapAttrName,
                    boolean skipOVDValidation,
                    LDAPUDFSync.MDSENTITY mdsentity)
                    throws AccessDeniedException,
                           NoSuchEntityException,
                           AttributeValidationFailedException,
                           ConfigManagerException,
                           AttributeAlreadyExistsException,
                           NoSuchAttributeException

Modifies the LDAP entity, RECON entity, RECON profile in MDS and creates a new column in RECON Horizontal DB table to effect UDF creation in LDAP Sync environment. Before invoking this service, please ensure that: 1. OIM UDF is already created and 2. LDAP attribute is added in the backed LDAP schema as well as OVD schema. 3. LDAP attribute is added to entity objectclass both in backed LDAP schema as well as OVD schema.

Parameters:

entity - Entity type (User/Role) for which UDF will be added

udfName - Name of the UDF in OIM entity.

ldapAttrName - Name of the LDAP/RECON attribute name to which the OIM UDF will be mapped to.

skipOVDValidation - If true the LDAP attribute is not validated in OVD schema

mdsentity - which MDS entity to modify ( RECON / LDAP / ALL)

Throws:

AccessDeniedException - Logged-in user doesn't have permission to ADD UDF.

NoSuchEntityException - The entity type passed as input is not supported.

AttributeValidationFailedException - The pre-requisite mantioned above are not met.

ConfigManagerException - Some unexpected error occurs while performing the operation.

AttributeAlreadyExistsException - The attribute is already present in Entity/Profile XML.

NoSuchAttributeException - The UDF is not properly created in OIM, either in DB or MDS.

deleteUDFwithLDAP

void deleteUDFwithLDAP(Constants.Entity entity,
                       java.lang.String udfName)
                       throws NoSuchEntityException,
                              NoSuchAttributeException,
                              ConfigManagerException,
                              AccessDeniedException

Deletes the given UDF from LDAP entity, RECON entity and RECON profile in MDS, also deletes the corresponding column from RECON Horizontal Table. Please note the OIM UDF is not touched (not deleted) by this utility.

Parameters:

entity - Entity type (User/Role) from which UDF is to be deleted. Currently supported entity types are USER / ROLE.

udfName - : Name of the UDF in OIM

Throws:

AccessDeniedException - Logged-in user doesn't have permission to delete UDF.

NoSuchEntityException - The entity type passed as input is not supported.

NoSuchAttributeException - The UDF is not properly created in LDAP/RECON, either in DB or MDS.

ConfigManagerException - Some unexpected error occurs while performing the operation.

deleteUDFwithLDAP

void deleteUDFwithLDAP(Constants.Entity entity,
                       java.lang.String udfName,
                       LDAPUDFSync.MDSENTITY mdsentity)
                       throws NoSuchEntityException,
                              NoSuchAttributeException,
                              ConfigManagerException,
                              AccessDeniedException

Deletes the given UDF from LDAP entity, RECON entity and RECON profile in MDS, also deletes the corresponding column from RECON Horizontal Table. Please note the OIM UDF is not touched (not deleted) by this utility.

Parameters:

entity - Entity type (User/Role) from which UDF is to be deleted. Currently supported entity types are USER / ROLE.

udfName - : Name of the UDF in OIM

mdsentity - which MDS entity to modify ( RECON / LDAP / ALL)

Throws:

AccessDeniedException - Logged-in user doesn't have permission to delete UDF.

NoSuchEntityException - The entity type passed as input is not supported.

NoSuchAttributeException - The UDF is not properly created in LDAP/RECON, either in DB or MDS.

ConfigManagerException - Some unexpected error occurs while performing the operation.

Skip navigation links