Skip navigation links

oracle.idm.user
Interface UserFactory

public interface UserFactory

This interface represents an factory that is responsible for creating, deleting and searching IDM Users.

Method Summary

User	createBaseUser(ModPropertySet pset) Create The Base User.
User	createBaseUser(java.lang.String dn, ModPropertySet pset) Create The Base User with the given DN
IdmUser	createUser(ModPropertySet pset) Create a new user in IDM Repository.
IdmUser	createUser(ModPropertySet pset, boolean onlyBase) Create a new user in IDM Repository.
IdmUser	createUser(java.lang.String dn, ModPropertySet pset) Create a new user in IDM Repository with the given DN.
IdmUser	createUser(java.lang.String dn, ModPropertySet pset, boolean onlyBase) Create a new user in IDM Repository with the given DN..
void	deleteUser(IdmUser idmUser) Delete User.
void	deleteUser(java.lang.String orclGuid) Delete User identified by the given GUID.
void	deleteUser(java.lang.String orclGuid, java.lang.String dn) Delete User.
void	deleteUserByDN(java.lang.String dn) Delete User identified by the given DN.
OIDContext	getOIDContext() Get the existing OIDContext associated with this Factory object.
Configuration	getProvisioningConfiguration() Get the provisioining configuration object from this user factory Configuration object contains various Provisioning related meta-data.
IdmUser	getUser(java.lang.String guid) Locates the user with given GUID.
IdmUser	getUser(java.lang.String guid, int idtype) Locates user with given any idtype .
IdmUser	getUserByDN(java.lang.String dn) Locate user with given DN.
UserFactoryControl	getUserFactoryControl() Get the User factory Control.
void	modifyUser(IdmUser idmUser, ModPropertySet mpset) Modify IDM User.
void	modifyUser(java.lang.String orclGuid, ModPropertySet mpset) Modify IDM User identified by the given GUID.
void	modifyUserByDN(java.lang.String dn, ModPropertySet mpset) Modify IDM User identified by the given DN.
java.util.List	searchUsers(int filterIdType, java.lang.String filter, java.lang.String userSearchBase) Search and retrieve the IdmUser.
void	setOIDContext(OIDContext oCtx) Set the OID context for this factory object.
void	setProvisioningConfiguration(Configuration config) Set the provisioining configuration object for this user factory.
void	setUserFactoryControl(UserFactoryControl uctl) Set the User factory Control.

Method Detail

searchUsers

java.util.List searchUsers(int filterIdType,
                           java.lang.String filter,
                           java.lang.String userSearchBase)
                           throws UtilException

Search and retrieve the IdmUser.

Parameters:

filterIdType - specifies the type of filter used. It must either be Util.IDTYPE_SIMPLE or Util.IDTYPE_FILTER,

 Util.IDTYPE_SIMPLE - The filter will be created using the nick name 
 attribute. For ex.

    If you want to search for all the users whose nick name begins 
    with "John", the filter should be set to "John*". 

 Util.IDTYPE_FILTER - A proper LDAP filter is expected. For ex

  "(&(cn=John*)(sn=John*))". 

 

filter - filter identified based on filterIdType.

userSearchBase - a user search base. If null, then all the user search bases for the this realm will be used

Returns:

a List IdmUser objects

Throws:

UtilException

getUser

IdmUser getUser(java.lang.String guid)
                throws UtilException

Locates the user with given GUID.

Parameters:

guid - GUID

Returns:

IdmUser object

Throws:

UtilException - if the operation fails

getUserByDN

IdmUser getUserByDN(java.lang.String dn)
                    throws UtilException

Locate user with given DN.

Parameters:

dn - DN of the user.

Returns:

IdmUser object

Throws:

UtilException - if the operation fails

getUser

IdmUser getUser(java.lang.String guid,
                int idtype)
                throws UtilException

Locates user with given any idtype .

Parameters:

guid - User Guid

idtype - IDTYPE

Returns:

IdmUser object

Throws:

UtilException - if the operation fails

createUser

IdmUser createUser(ModPropertySet pset)
                   throws UtilException

Create a new user in IDM Repository. This api creates both the base user and app user footprint based on the UserFactoryControl settings if any. DN will be constructed based on user naming attribute set for that realm

Parameters:

pset - a ModPropertySet defining the user attributes

Returns:

IdmUser object

Throws:

UtilException - if the operation fails

createUser

IdmUser createUser(java.lang.String dn,
                   ModPropertySet pset)
                   throws UtilException

Create a new user in IDM Repository with the given DN. This api creates both the base user and app user footprint based on the UserFactoryControl settings if any.

Parameters:

dn - DN to be used for creating the user

pset - a ModPropertySet defining the user attributes

Returns:

IdmUser object

Throws:

UtilException - if the operation fails

createUser

IdmUser createUser(ModPropertySet pset,
                   boolean onlyBase)
                   throws UtilException

Create a new user in IDM Repository.

Parameters:

pset - a ModPropertySet defining the user attributes

onlyBase - true - create only the Base User and do not create any app user footprint. false - create base user and app user data

Returns:

IdmUser object

Throws:

UtilException - if the operation fails

createUser

IdmUser createUser(java.lang.String dn,
                   ModPropertySet pset,
                   boolean onlyBase)
                   throws UtilException

Create a new user in IDM Repository with the given DN..

Parameters:

dn - DN to be used for creating the user

pset - a ModPropertySet defining the user attributes

onlyBase - true - create only the Base User and do not create any app user footprint. false - create base user and app user data

Returns:

IdmUser object

Throws:

UtilException - if the operation fails

setProvisioningConfiguration

void setProvisioningConfiguration(Configuration config)

Set the provisioining configuration object for this user factory. Configuration object contains various Provisioning related meta-data.

Parameters:

config - Provisioning configuration object.

getProvisioningConfiguration

Configuration getProvisioningConfiguration()

Get the provisioining configuration object from this user factory Configuration object contains various Provisioning related meta-data.

Returns:

config Provisioning configuration object.

setUserFactoryControl

void setUserFactoryControl(UserFactoryControl uctl)

Set the User factory Control. UserFactoryControl determines the behavior of this User Factory Object.

Parameters:

uctl - a User factory control that determines the behavior of the user factory

getUserFactoryControl

UserFactoryControl getUserFactoryControl()

Get the User factory Control.

Returns:

the User factory control associated with this user factory.

createBaseUser

User createBaseUser(ModPropertySet pset)
                    throws UtilException

Create The Base User.

Parameters:

pset - a ModPropertySet defining the user attributes

Throws:

UtilException - if the operation fails

createBaseUser

User createBaseUser(java.lang.String dn,
                    ModPropertySet pset)
                    throws UtilException

Create The Base User with the given DN

Parameters:

dn - DN to be used for creating the user

pset - a ModPropertySet defining the user attributes

Throws:

UtilException - if the operation fails

modifyUser

void modifyUser(java.lang.String orclGuid,
                ModPropertySet mpset)
                throws UtilException

Modify IDM User identified by the given GUID.

Parameters:

orclGuid - User GUID

mpset - ModPropertySet defining changes to the user attributes.

Throws:

UtilException - if the operation fails

modifyUserByDN

void modifyUserByDN(java.lang.String dn,
                    ModPropertySet mpset)
                    throws UtilException

Modify IDM User identified by the given DN.

Parameters:

dn - User DN

mpset - ModPropertySet defining changes to the user attributes.

Throws:

UtilException - if the operation fails

modifyUser

void modifyUser(IdmUser idmUser,
                ModPropertySet mpset)
                throws UtilException

Modify IDM User.

Parameters:

idmUser - A Non Null IDMUser reference

mpset - ModPropertySet defining changes to the user attributes.

Throws:

UtilException - if the operation fails

deleteUser

void deleteUser(java.lang.String orclGuid)
                throws UtilException

Delete User identified by the given GUID.

Parameters:

orclGuid - User GUID.

Throws:

UtilException - if the operation fails.

deleteUserByDN

void deleteUserByDN(java.lang.String dn)
                    throws UtilException

Delete User identified by the given DN.

Parameters:

dn - User DN.

Throws:

UtilException - if the operation fails.

deleteUser

void deleteUser(java.lang.String orclGuid,
                java.lang.String dn)
                throws UtilException

Delete User.

Parameters:

orclGuid - User GUID.

dn - User DN.

Throws:

UtilException - if the operation fails.

deleteUser

void deleteUser(IdmUser idmUser)
                throws UtilException

Delete User.

Parameters:

idmUser - A Non Null IDMUser reference

Throws:

UtilException

getOIDContext

OIDContext getOIDContext()

Get the existing OIDContext associated with this Factory object.

Returns:

OIDContext object

setOIDContext

void setOIDContext(OIDContext oCtx)

Set the OID context for this factory object.

Parameters:

oCtx - a reference to a valid OIDContext object.

Skip navigation links