|
Oracle Internet Directory API Reference 10g(10.1.2) B14083-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 searchBase) 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 |
public java.util.List searchUsers(int filterIdType, java.lang.String filter, java.lang.String searchBase) throws UtilException
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.searchBase
- a user search base. If null, then all the user search bases for the this realm will be usedUtilException
public IdmUser getUser(java.lang.String guid) throws UtilException
guid
- GUIDUtilException
- if the operation failspublic IdmUser getUserByDN(java.lang.String dn) throws UtilException
dn
- DN of the user.UtilException
- if the operation failspublic IdmUser getUser(java.lang.String guid, int idtype) throws UtilException
guid
- guid of the useridtype
- Util.IDTYPE_DN or Util.IDTYPE_GUIDUtilException
- if the operation failspublic IdmUser createUser(ModPropertySet pset) throws UtilException
UserFactoryControl
settings if any. DN will be constructed based on user naming attribute set for that realmpset
- a ModPropertySet defining the user attributesUtilException
- if the operation failspublic IdmUser createUser(java.lang.String dn, ModPropertySet pset) throws UtilException
UserFactoryControl
settings if any.dn
- DN to be used for creating the userpset
- a ModPropertySet defining the user attributesUtilException
- if the operation failspublic IdmUser createUser(ModPropertySet pset, boolean onlyBase) throws UtilException
pset
- a ModPropertySet defining the user attributesonlyBase
- true - create only the Base User and do not create any app user footprint. false - create base user and app user dataUtilException
- if the operation failspublic IdmUser createUser(java.lang.String dn, ModPropertySet pset, boolean onlyBase) throws UtilException
dn
- DN to be used for creating the userpset
- a ModPropertySet defining the user attributesonlyBase
- true - create only the Base User and do not create any app user footprint. false - create base user and app user dataUtilException
- if the operation failspublic void setProvisioningConfiguration(Configuration config)
Configuration
object contains various Provisioning related meta-data.config
- Provisioning configuration object.public Configuration getProvisioningConfiguration()
Configuration
object contains various Provisioning related meta-data.public void setUserFactoryControl(UserFactoryControl uctl)
uctl
- a User factory control that determines the behavior of the user factorypublic UserFactoryControl getUserFactoryControl()
public User createBaseUser(ModPropertySet pset) throws UtilException
pset
- a ModPropertySet defining the user attributesUtilException
- if the operation failspublic User createBaseUser(java.lang.String dn, ModPropertySet pset) throws UtilException
dn
- DN to be used for creating the userpset
- a ModPropertySet defining the user attributesUtilException
- if the operation failspublic void modifyUser(java.lang.String orclGuid, ModPropertySet mpset) throws UtilException
orclGuid
- User GUIDmpset
- a ModPropertySet defining changes to the user attributes.UtilException
- if the operation failspublic void modifyUserByDN(java.lang.String dn, ModPropertySet mpset) throws UtilException
dn
- User DNmpset
- a ModPropertySet defining changes to the user attributes.UtilException
- if the operation failspublic void modifyUser(IdmUser idmUser, ModPropertySet mpset) throws UtilException
idmUser
- A Non Null IDMUser referencempset
- a ModPropertySet defining changes to the user attributes.UtilException
- if the operation failspublic void deleteUser(java.lang.String orclGuid) throws UtilException
orclGuid
- User GUID.UtilException
- if the operation fails.public void deleteUserByDN(java.lang.String dn) throws UtilException
dn
- User DN.UtilException
- if the operation fails.public void deleteUser(java.lang.String orclGuid, java.lang.String dn) throws UtilException
orclGuid
- User GUID.dn
- User DN.UtilException
- if the operation fails.public void deleteUser(IdmUser idmUser) throws UtilException
idmUser
- A Non Null IDMUser referenceUtilException
public OIDContext getOIDContext()
public void setOIDContext(OIDContext oCtx)
oCtx
- a reference to a valid OIDContext object.
|
Oracle Internet Directory API Reference 10g(10.1.2) B14083-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |