Package oracle.security.am.engines.idm
Class IdentityManagementEngine
java.lang.Object
oracle.security.am.engines.idm.IdentityManagementEngine
- All Implemented Interfaces:
oracle.security.am.common.utilities.server.OAMEngine
public class IdentityManagementEngine
extends Object
implements oracle.security.am.common.utilities.server.OAMEngine
The
IdentityManagementEngine class.- Since:
- NGAMv1.0
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from interface oracle.security.am.common.utilities.server.OAMEngine
STATUS_FAIL, STATUS_NOT_SUPPORTED, STATUS_SUCCESS -
Method Summary
Modifier and TypeMethodDescriptionbooleanevaluatePasswordPolicy<wbr>(Map<String,<wbr>String> userAttributes, Map<IdentityManagementEngine.Context,<wbr>Object> evalContext)Evaluate password policy.intGets the down grade auth level.intintGets the forgot password url.getIdentityPartnerId<wbr>(String serverIdentifier)static IdentityManagementEngineGets the single instance of IdentityManagementEngine.Gets the login try count attribute.intString[]Gets the password policy attributes.Gets the track user registration url.oracle.security.am.engines.common.identity.provider.UserIdentityProvidergetUserIdentityProvider<wbr>(String idstoreIdentifier)Gets the user registration url.voidhandleConfigChangeNotification<wbr>(oracle.security.am.common.utilities.constant.NotificationID notification)Handle config change notification.intInitializes the engine.booleanChecks if is identity service enabled.booleanChecks if is registration service enabled.booleanChecks the health of the engine.intreload()Resets the engine.intshutdown()Finalize will do the necessary tasks before the engine goes down.
-
Method Details
-
getInstance
Gets the single instance of IdentityManagementEngine.- Returns:
- single instance of IdentityManagementEngine
-
isIdentityServiceEnabled
public boolean isIdentityServiceEnabled()Checks if is identity service enabled.- Returns:
- true, if is identity service enabled
-
isRegistrationServiceEnabled
public boolean isRegistrationServiceEnabled()Checks if is registration service enabled.- Returns:
- true, if is registration service enabled
-
evaluatePasswordPolicy
public IdentityServiceProviderResponse evaluatePasswordPolicy<wbr>(Map<String,<wbr>String> userAttributes, Map<IdentityManagementEngine.Context,<wbr>Object> evalContext)Evaluate password policy.- Parameters:
userAttributes- the user attributes- Returns:
- the identity service provider response
-
getAnonymousAuthLevel
public int getAnonymousAuthLevel()Gets the down grade auth level.- Returns:
- the down grade auth level
-
getDowngradeAuthLevel
public int getDowngradeAuthLevel() -
getUserRegistrationURL
Gets the user registration url.- Returns:
- the user registration url
-
getForgotPasswordURL
Gets the forgot password url.- Returns:
- the forgot password url
-
getPasswordPolicyAttributes
Gets the password policy attributes.- Returns:
- the password policy attributes
-
getLoginTryCountAttribute
Gets the login try count attribute.- Returns:
- the login try count attribute
-
getLockoutTimeAttribute
-
getLockoutTimeValue
-
getLockedOnAttribute
-
getLockedOnValue
-
getNumberOfAttemptsToLockout
public int getNumberOfAttemptsToLockout() -
getTrackUserRegistrationURL
Gets the track user registration url.- Returns:
- the track user registration url
-
handleConfigChangeNotification
public void handleConfigChangeNotification<wbr>(oracle.security.am.common.utilities.constant.NotificationID notification)Handle config change notification.- Parameters:
notification- the notification
-
initilize
public int initilize()Description copied from interface:oracle.security.am.common.utilities.server.OAMEngineInitializes the engine. This will be called during the server startup. VALID status values are 0 - executed successfully 1 - failed -1 - Not supported- Specified by:
initilizein interfaceoracle.security.am.common.utilities.server.OAMEngine- Returns:
-
isRunning
public boolean isRunning()Description copied from interface:oracle.security.am.common.utilities.server.OAMEngineChecks the health of the engine. If the engine is experiencing some issues engine can send a false value for this call and controller can decide on the next course of action.- Specified by:
isRunningin interfaceoracle.security.am.common.utilities.server.OAMEngine- Returns:
- boolean value denoting the server status. True denotes the server is in good health
-
reload
public int reload()Description copied from interface:oracle.security.am.common.utilities.server.OAMEngineResets the engine. If the engine is experiencing any issues Controller can call the reset method to re-initialize the engine. This will be done if the isRunning call fails. VALID status values are 0 - executed successfully 1 - failed -1 - Not supported- Specified by:
reloadin interfaceoracle.security.am.common.utilities.server.OAMEngine
-
shutdown
public int shutdown()Description copied from interface:oracle.security.am.common.utilities.server.OAMEngineFinalize will do the necessary tasks before the engine goes down. The taks can vary based on the engines. This will be called during the server startup. If the engines does not support this operation a false status should be communicated VALID status values are 0 - executed successfully 1 - failed -1 - Not supported- Specified by:
shutdownin interfaceoracle.security.am.common.utilities.server.OAMEngine- Returns:
-
getUserIdentityProvider
public oracle.security.am.engines.common.identity.provider.UserIdentityProvider getUserIdentityProvider<wbr>(String idstoreIdentifier) throws IdentityProviderException- Throws:
IdentityProviderException
-
getDefaultGlobalRetryLimit
public int getDefaultGlobalRetryLimit() -
getIdentityPartnerId
-
getIdentityManagementServer
-
getRegistrationManagementServer
-
checkAccountLockedOnFailure
public boolean checkAccountLockedOnFailure()
-