Modifier and Type | Method and Description |
---|---|
boolean |
AMSDKRepo.authenticate(Callback[] credentials) |
Modifier and Type | Method and Description |
---|---|
AuthLoginException |
AuthContext.getLoginException()
Returns login exception, if any, during the authentication process.
|
Modifier and Type | Method and Description |
---|---|
void |
AuthContext.abort()
Terminates an ongoing
login call that has not yet completed. |
protected static void |
AuthContext.checkForException(Document document) |
protected String |
AuthContext.getAuthenticationHandle(Document document) |
void |
AuthContext.login()
Starts the login process for the given
AuthContext object. |
void |
AuthContext.login(AuthContext.IndexType type,
String indexName)
Starts the login process for the given
AuthContext object
identified by the index type and index name. |
SSOToken |
AuthContext.login(AuthContext.IndexType type,
String indexName,
Callback[] userInfo)
Starts the login process for the given
AuthContext object
identified by the index type and index name and also completes
the login process by submitting the given User credentials
in the form of Callbacks. |
void |
AuthContext.login(AuthContext.IndexType type,
String indexName,
String locale)
Starts the login process for the given
AuthContext object
identified by the index type and index name. |
void |
AuthContext.login(AuthContext.IndexType indexType,
String indexName,
String[] params)
Starts the login process for the given
AuthContext object
identified by the index type and index name with default parameters. |
void |
AuthContext.login(AuthContext.IndexType indexType,
String indexName,
String[] params,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
void |
AuthContext.login(AuthContext.IndexType indexType,
String indexName,
String[] params,
Map envMap)
Starts the login process for the given
AuthContext object
identified by the index type and index name with certain parameters
and environment map. |
void |
AuthContext.login(AuthContext.IndexType indexType,
String indexName,
String[] params,
Map envMap,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
void |
AuthContext.login(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Starts the login process for the given
AuthContext object. |
void |
AuthContext.logout()
Logs out the user and also invalidates the single sign on token
associated with this
AuthContext . |
void |
AuthContext.logoutUsingTokenID()
Logs out the user and also invalidates the single sign on token
associated with this
AuthContext . |
protected Document |
AuthContext.processRequest(String xmlRequest) |
Constructor and Description |
---|
AuthContext(SSOToken ssoToken)
Constructs an instance of
AuthContext for a given
organization name, or sub organization name contained in the
single sign on token. |
AuthContext(SSOToken ssoToken,
boolean forceAuth)
Constructs an instance of
AuthContext for a given
organization name, or sub organization name contained in the
single sign on token. |
AuthContext(String orgName)
Constructs an instance of
AuthContext for a given
organization name or sub organization name. |
AuthContext(String orgName,
String nickName)
Constructs an instance of
AuthContext for a given
organization name, or sub organization name and a nick name
for the certificate to be used in SSL handshake if client authentication
is turn on in the server side. |
AuthContext(String orgName,
String nickName,
URL url)
Constructs an instance of
AuthContext for a given
organization name, or sub organization name, a nick name
for the certificate to be used in SSL handshake if client authentication
is enabled on the server side and the OpenAM URL. |
AuthContext(String orgName,
URL url)
Constructs an instance of
AuthContext for a given
organization name, or sub organization name and the OpenAM server
URL. |
Modifier and Type | Method and Description |
---|---|
boolean |
AD.initializeLDAP() |
Modifier and Type | Method and Description |
---|---|
int |
Anonymous.process(Callback[] callbacks,
int state) |
Modifier and Type | Method and Description |
---|---|
int |
Application.process(Callback[] callbacks,
int state)
Implementation of
AMLoginModule abstract method. |
Modifier and Type | Method and Description |
---|---|
int |
Cert.process(Callback[] callbacks,
int state)
Process Certificate based auth request
|
Modifier and Type | Method and Description |
---|---|
int |
DataStore.process(Callback[] callbacks,
int state) |
Modifier and Type | Method and Description |
---|---|
int |
Federation.process(Callback[] callbacks,
int state)
Process the authentication request.
|
Modifier and Type | Method and Description |
---|---|
int |
HOTP.process(Callback[] callbacks,
int state) |
void |
DefaultSMSGatewayImpl.sendEmail(String from,
String to,
String subject,
String message,
String code,
Map options)
Sends an email message to the mail with the code
|
void |
SMSGateway.sendEmail(String from,
String to,
String subject,
String message,
String code,
Map options)
Sends an email message to the mail with the code
|
void |
HOTPService.sendHOTP()
Sends a otp code to the users telephone number and/or email address, based on the authentication module's
configuration settings.
|
void |
DefaultSMSGatewayImpl.sendSMSMessage(String from,
String to,
String subject,
String message,
String code,
Map options)
Sends a SMS message to the phone with the code
|
void |
SMSGateway.sendSMSMessage(String from,
String to,
String subject,
String message,
String code,
Map options)
Sends a SMS message to the phone with the code
|
Modifier and Type | Method and Description |
---|---|
int |
JDBC.process(Callback[] callbacks,
int state)
Processes the authentication request.
|
String |
MD5Transform.transform(String input)
This simply returns the MD5 format of the password.
|
String |
ClearTextTransform.transform(String input)
This simply returns the clear text format of the password.
|
String |
JDBCPasswordSyntaxTransform.transform(String input)
This is the only method to implement if you don't store your password in
cleartext.
|
Modifier and Type | Method and Description |
---|---|
boolean |
LDAP.initializeLDAP()
TODO-JAVADOC
|
int |
LDAP.process(Callback[] callbacks,
int state) |
Modifier and Type | Method and Description |
---|---|
int |
Membership.process(Callback[] callbacks,
int state)
Takes an array of submitted
Callback ,
process them and decide the order of next state to go. |
Modifier and Type | Method and Description |
---|---|
protected String |
MSISDNValidation.getUserId(String msisdnNumber)
Returns user ID which has
sunIdentityMSISDNNumber matching
the msisdn |
int |
MSISDN.process(Callback[] callbacks,
int state)
Validates the authentication credentials.
|
Constructor and Description |
---|
MSISDNValidation(Map options,
Debug debug,
ResourceBundle bundle,
Locale locale)
Creates
MSISNValidation and set up the configuration to
search LDAP for msisdn number. |
Modifier and Type | Method and Description |
---|---|
int |
NT.process(Callback[] callbacks,
int state)
TODO-JAVADOC
|
Modifier and Type | Method and Description |
---|---|
int |
RADIUS.process(Callback[] callbacks,
int state)
Takes an array of submitted
Callback , process them and decide the order of next state to go. |
protected void |
RADIUS.readAttributesFromResponsePacket(Packet response)
Extension point to handle additional response attributes
|
Modifier and Type | Method and Description |
---|---|
int |
SAE.process(Callback[] callbacks,
int state)
Validates the authentication credentials.
|
Modifier and Type | Method and Description |
---|---|
int |
SecurID.process(Callback[] callbacks,
int state) |
Modifier and Type | Method and Description |
---|---|
int |
WindowsDesktopSSO.process(Callback[] callbacks,
int state)
Processes the authentication request.
|
Modifier and Type | Method and Description |
---|---|
int |
WSSAuthModule.process(Callback[] callbacks,
int state) |
Modifier and Type | Field and Description |
---|---|
protected AuthLoginException |
AuthContextLocal.loginException
AuthLoginException
|
Modifier and Type | Method and Description |
---|---|
AuthLoginException |
AuthContextLocal.getLoginException()
Returns login exception, if any, during
the authentication process.
|
Modifier and Type | Method and Description |
---|---|
void |
AuthContextLocal.setLoginException(AuthLoginException exception)
Sets the login exception that represents errors during the
authentication process.
|
Modifier and Type | Method and Description |
---|---|
void |
AuthContextLocal.abort()
Terminates an ongoing
login call that has not yet completed. |
void |
AuthContextLocal.login()
Starts the login process for the given
AuthContextLocal
object. |
void |
AuthContextLocal.login(AuthContext.IndexType type,
String indexName)
Start the login process for the
AuthContextLocal object
identified by the index type and index name. |
void |
AuthContextLocal.login(AuthContext.IndexType type,
String indexName,
Map envMap,
String locale)
Starts the login process for the given
AuthContextLocal
object identified by the index type and index name. |
protected void |
AuthContextLocal.login(AuthContext.IndexType type,
String indexName,
Principal principal,
char[] password,
Subject subject)
Performs the Login for the given AuthContext
|
protected void |
AuthContextLocal.login(AuthContext.IndexType type,
String indexName,
Principal principal,
char[] password,
Subject subject,
Map envMap,
String locale)
Performs the Login for the given AuthContext
|
void |
AuthContextLocal.login(AuthContext.IndexType type,
String indexName,
String locale)
Starts the login process for the given
AuthContextLocal
object identified by the index type and index name. |
void |
AuthContextLocal.login(Principal principal,
char[] password)
Starts the login process for the given
AuthContextLocal s
object for the given Principal and the user's password. |
void |
AuthContextLocal.login(Subject subject)
Starts the login process for the given
AuthContextLocal
object for the given Subject . |
void |
AuthContextLocal.logout()
Logs out the user and also invalidates the
SSOToken
associated with this AuthContextLocal . |
Modifier and Type | Method and Description |
---|---|
void |
AMLoginContext.abort()
Terminates an ongoing login process.
|
void |
AMLoginContext.executeLogin(Subject subject,
AuthContext.IndexType loginIndexType,
String loginIndexName,
String locale,
String redirectUrl)
Starts login process, the map passed to this method is the parameters
required to start the login process.
|
void |
AMLoginContext.logout()
Logs out.
|
Modifier and Type | Class and Description |
---|---|
class |
AuthErrorCodeException
This exception associates a
LoginException with an error code from AMAuthErrorCode ,
which can later be used by AMLoginContext to handle the exception. |
class |
InvalidPasswordException
Exception that is thrown when the user-entered password token causes the
authentication module to be authenticated to fail.
|
class |
LoginTimeOutException
Exception that is thrown when the user-entered tokens
cause the authentication module to be authenticated to fail.
|
class |
MessageLoginException
Exception that is thrown when enter a Login Module error state which
does not contain a error template.
|
class |
UserNamePasswordValidationException
This class is for handling Exception that is thrown when the user name
password validation plugin is failed or any invalid characters detected in
user name.
|
Modifier and Type | Method and Description |
---|---|
boolean |
AMLoginModule.abort()
Aborts the authentication process.
|
void |
AMLoginModule.clearInfoText(int state)
Clears the info text for a given callback state
|
boolean |
AMLoginModule.commit()
Commit the authentication process (phase 2).
|
protected void |
AMLoginModule.forceCallbacksInit() |
Callback[] |
AMLoginModule.getCallback(int index)
Returns a Callback array for a specific state.
|
Callback[] |
AMLoginModule.getCallback(int index,
boolean fetchOrig)
Return a Callback array for a specific state.
|
String |
AMLoginModule.getLocale()
Returns the locale for this authentication session.
|
protected LoginState |
AMLoginModule.getLoginState(String methodName)
Returns the authentication
LoginState |
Set |
AMLoginModule.getNewUserIDs(Map attributes,
int num)
Returns a set of user IDs generated from the class defined
in the Core Authentication Service.
|
Map |
AMLoginModule.getOrgProfile(String orgDN)
Returns the organization attributes for specified organization.
|
Map |
AMLoginModule.getOrgServiceTemplate(String orgDN,
String serviceName)
Returns service template attributes defined for the specified
organization.
|
Map |
AMLoginModule.getServiceConfig(String name)
Returns service configuration attributes.
|
SSOToken |
AMLoginModule.getSSOSession()
Returns an administration SSOToken for use the OpenAM APIs.
|
protected Set<String> |
AMLoginModule.getUserAliasList()
Provides the "Alias Search Attribute Name" list from the Authentication
Service for the realm.
|
AMUser |
AMLoginModule.getUserProfile(String userDN)
Deprecated.
This method has been deprecated. Please use the
IdRepo API's to get the AMIdentity object for the user. More
information on how to use the Identity Repository APIs is
available in the "Customizing Identity Data Storage" chapter
of the OpenAM Developer's Guide.
|
String |
AMLoginModule.getUserSessionProperty(String name)
Returns the property from the user session.
|
boolean |
AMLoginModule.login()
Implements login() method in JAAS LoginModule class.
|
boolean |
AMLoginModule.logout()
Logs out a Subject.
|
void |
AMLoginModule.replaceCallback(int state,
int index,
Callback callback)
Replace Callback object for a specific state.
|
void |
AMLoginModule.replaceHeader(int state,
String header)
Replace page header for a specific state.
|
void |
AMLoginModule.resetCallback(int state,
int index)
Reset a Callback instance to the original Callback for the specified
state and the specified index.
|
void |
AMLoginModule.setLoginFailureURL(String url)
Sets the the login failure URL for the user.
|
void |
AMLoginModule.setLoginSuccessURL(String url)
Sets the the login successful URL for the user.
|
void |
AMLoginModule.setModuleErrorTemplate(String templateName)
Sets the error template for the module
|
void |
AMLoginModule.setOrg(String orgDN)
Sets the user organization.
|
void |
AMLoginModule.setUserSessionProperty(String name,
String value)
Sets a property in the user session.
|
void |
AMLoginModule.substituteHeader(int state,
String header)
Use this method to replace the header text from the XML file with new
text.
|
void |
AMLoginModule.substituteInfoText(int state,
int callback,
String infoText)
Allows you to set the info text for a specific callback.
|
Modifier and Type | Method and Description |
---|---|
boolean |
AMIdentityRepository.authenticate(Callback[] credentials)
Non-javadoc, non-public methods Returns
true if the data
store has successfully authenticated the identity with the provided
credentials. |
boolean |
IdRepo.authenticate(Callback[] credentials)
Returns
true if the data store successfully authenticates
the identity with the provided credentials. |
boolean |
AMIdentityRepository.authenticate(IdType idType,
Callback[] credentials)
Non-javadoc, non-public methods Returns
true if the data
store has successfully authenticated the identity with the provided
credentials. |
boolean |
IdServices.authenticate(String orgName,
Callback[] credentials)
Returns
true if the data store has successfully
authenticated the identity with the specific type and provided credentials. |
boolean |
IdServices.authenticate(String orgName,
Callback[] credentials,
IdType idType)
Returns
true if the data store has successfully
authenticated the identity with the specific type and provided credentials. |
Modifier and Type | Method and Description |
---|---|
boolean |
DatabaseRepo.authenticate(Callback[] credentials)
Returns
true if the data store successfully authenticates
the identity with the provided credentials. |
Modifier and Type | Method and Description |
---|---|
boolean |
FilesRepo.authenticate(Callback[] credentials) |
Modifier and Type | Method and Description |
---|---|
boolean |
SpecialRepo.authenticate(Callback[] credentials) |
boolean |
AgentsRepo.authenticate(Callback[] credentials) |
Modifier and Type | Method and Description |
---|---|
boolean |
IdServicesImpl.authenticate(String orgName,
Callback[] credentials) |
boolean |
IdServicesImpl.authenticate(String orgName,
Callback[] credentials,
IdType idType) |
Modifier and Type | Method and Description |
---|---|
int |
Adaptive.process(Callback[] callbacks,
int state) |
Modifier and Type | Method and Description |
---|---|
void |
AMLoginModuleBinder.setUserSessionProperty(String name,
String value)
Sets a property in the user session.
|
void |
AuthLoginModule.setUserSessionProperty(String name,
String value)
Sets a property in the user session.
|
Modifier and Type | Method and Description |
---|---|
Map<String,Set<String>> |
JsonAttributeMapper.getAttributes(Map<String,String> attributeMapConfiguration,
String jsonText)
Maps from values found in the source to a map of keys in the result, according to a provided map of keys in the
source to keys in the result.
|
Map<String,Set<String>> |
AttributeMapper.getAttributes(Map<String,String> attributeMapConfiguration,
T source)
Maps from values found in the source to a map of keys in the result, according to a provided map of keys in the
source to keys in the result.
|
AMIdentity |
DefaultAccountProvider.provisionUser(AMIdentityRepository idrepo,
Map<String,Set<String>> attributes)
Provisions a user with the specified attributes.
|
AMIdentity |
AccountProvider.provisionUser(AMIdentityRepository idrepo,
Map<String,Set<String>> attributes)
Provisions a user with the specified attributes.
|
Modifier and Type | Method and Description |
---|---|
int |
AuthenticatorOATH.process(Callback[] callbacks,
int state)
Processes the OTP input by the user.
|
Modifier and Type | Method and Description |
---|---|
int |
OATH.process(Callback[] callbacks,
int state)
Deprecated.
Processes the OTP input by the user.
|
Modifier and Type | Method and Description |
---|---|
byte[] |
DefaultSharedSecretProvider.getSharedSecret(String secretKeyValue)
Processes the shared secret value retrieved for the user.
|
byte[] |
SharedSecretProvider.getSharedSecret(String secretKey)
Takes the non-empty shared secret that is retrieved for a user and implements any processing needed for to
return the byte array of the string value.
|
Modifier and Type | Method and Description |
---|---|
String |
OAuthConf.getAuthServiceUrl(String originalUrl,
String state) |
String |
OAuthConf.getGatewayImplClass() |
Map<String,String> |
OAuthConf.getTokenServiceGETParameters(String code,
String authServiceURL) |
Map<String,String> |
OAuthConf.getTokenServicePOSTparameters(String code,
String authServiceURL) |
String |
OAuth.provisionAccountNow(AccountProvider accountProvider,
String realm,
String profileSvcResponse,
String userPassword,
org.forgerock.json.jose.jwt.JwtClaimsSet jwtClaims) |
void |
OAuth.saveAttributes(Map<String,Set<String>> attributes) |
protected void |
OAuth.updateAccount(AccountProvider accountProvider,
String realm,
Map<String,Set<String>> userNames,
String profileSvcResponse,
String userPassword,
org.forgerock.json.jose.jwt.JwtClaimsSet jwtClaims) |
void |
OAuthConf.validateConfiguration() |
void |
OAuth.validateInput(String tag,
String inputField,
String rule,
int maxLength,
boolean allowNull) |
Modifier and Type | Method and Description |
---|---|
String |
DefaultServiceUrlProvider.getServiceUri(OAuthConf config,
String originalUrl,
String state) |
String |
ServiceUrlProvider.getServiceUri(OAuthConf config,
String originalUrl,
String state) |
String |
ESIAServiceUrlProvider.getServiceUri(OAuthConf config,
String originalUrl,
String state) |
Map<String,String> |
DefaultServiceUrlProvider.getTokenServiceGETparameters(OAuthConf oAuthConf,
String code,
String authServiceURL) |
Map<String,String> |
ServiceUrlProvider.getTokenServiceGETparameters(OAuthConf oAuthConf,
String code,
String authServiceURL) |
Map<String,String> |
ESIAServiceUrlProvider.getTokenServiceGETparameters(OAuthConf config,
String code,
String authServiceURL) |
Map<String,String> |
DefaultServiceUrlProvider.getTokenServicePOSTparameters(OAuthConf config,
String code,
String authServiceURL) |
Map<String,String> |
ServiceUrlProvider.getTokenServicePOSTparameters(OAuthConf config,
String code,
String authServiceURL) |
Map<String,String> |
ESIAServiceUrlProvider.getTokenServicePOSTparameters(OAuthConf config,
String code,
String authServiceURL) |
Modifier and Type | Method and Description |
---|---|
org.forgerock.json.jose.jwt.JwtClaimsSet |
JwtHandler.getJwtClaims(String jwtValue)
Get the set of claims contained within the specified token.
|
static boolean |
JwtHandler.isFromValidAuthorizedParty(Set<String> acceptedAuthorizedParties,
org.forgerock.json.jose.jwt.JwtClaimsSet jwtClaims)
Check whether or not the token is from one of the accepted authorized parties specified.
|
static boolean |
JwtHandler.isIntendedForAudience(String audienceName,
org.forgerock.json.jose.jwt.JwtClaimsSet jwtClaims)
Check whether or not the token is designated for the specified audience.
|
static boolean |
JwtHandler.jwtHasAuthorizedPartyClaim(org.forgerock.json.jose.jwt.JwtClaimsSet jwtClaims)
Check if the token has an authorized party ("azp") entry.
|
org.forgerock.json.jose.jwt.JwtClaimsSet |
JwtHandler.validateJwt(String jwtValue)
Validate the integrity of the JWT OIDC token, according to the spec
(http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
Modifier and Type | Method and Description |
---|---|
protected PushDeviceSettings |
AbstractPushModule.getDevice(String username,
String realm)
Retrieves a Push Device for a user in a realm.
|
void |
UserPushDeviceProfileManager.saveDeviceProfile(String user,
String realm,
PushDeviceSettings deviceSettings)
Saves the Push device settings to the user's profile, overwriting any existing device profile.
|
Modifier and Type | Method and Description |
---|---|
boolean |
JAASModuleDetector.isPureJAASModulePresent(String configName,
Configuration configuration)
Returns whether the auth module is or the auth chain contains pure JAAS module(s).
|
Modifier and Type | Method and Description |
---|---|
LoginProcess |
LoginAuthenticator.getLoginProcess(LoginConfiguration loginConfiguration)
Gets the Login Process object using the given Login Configuration.
|
void |
AuthenticationContext.login()
Starts the login process for the given AuthContextLocal object.
|
void |
AuthenticationContext.login(AuthContext.IndexType indexType,
String indexValue)
Starts the login process for the given AuthContextLocal object.
|
void |
AuthenticationContext.login(AuthContext.IndexType indexType,
String indexValue,
Map<String,Set<String>> envMap,
String locale)
Starts the login process for the given AuthContextLocal object.
|
LoginProcess |
CompletedLoginProcess.next(Callback[] callbacks)
Moves the login process to the next step, which means either submitting the callbacks or if the AuthIndexType
is LEVEL or COMPOSITE then instead of submitting the callbacks, the callbacks are assumed to be the
authentication module choice login step and the resulting choice will be used to continue the login process.
|
LoginProcess |
LoginProcess.next(Callback[] callbacks)
Moves the login process to the next step, which means either submitting the callbacks or if the AuthIndexType
is LEVEL or COMPOSITE then instead of submitting the callbacks, the callbacks are assumed to be the
authentication module choice login step and the resulting choice will be used to continue the login process.
|
Modifier and Type | Method and Description |
---|---|
void |
AuthContextLocalWrapper.login()
Starts the login process for the given AuthContextLocal object.
|
void |
AuthContextLocalWrapper.login(AuthContext.IndexType indexType,
String indexValue)
Starts the login process for the given AuthContextLocal object.
|
void |
AuthContextLocalWrapper.login(AuthContext.IndexType indexType,
String indexValue,
Map<String,Set<String>> envMap,
String locale)
Starts the login process for the given AuthContextLocal object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
IdServicesDecorator.authenticate(String orgName,
Callback[] credentials)
Returns
true if the data store has successfully
authenticated the identity with the specific type and provided credentials. |
boolean |
IdServicesDecorator.authenticate(String orgName,
Callback[] credentials,
IdType idType) |
Modifier and Type | Method and Description |
---|---|
boolean |
DJLDAPv3Repo.authenticate(Callback[] credentials)
Tries to bind as the user with the credentials passed in via callbacks.
|
Modifier and Type | Method and Description |
---|---|
AuthContext |
OpenAMAuthFactory.getAuthContext(String realm)
Return on OpenAM auth context for the requested realm.
|
Modifier and Type | Method and Description |
---|---|
int |
Ntlm.process(Callback[] callbacks,
int state) |
Modifier and Type | Method and Description |
---|---|
protected Set<com.webauthn4j.authenticator.Authenticator> |
WebAuthnAuthentication.loadAuthenticators(AMIdentity identity) |
int |
WebAuthnRegistration.requestCredentials() |
int |
WebAuthnAuthentication.requestCredentials() |
protected void |
WebAuthnRegistration.save(com.webauthn4j.authenticator.Authenticator authenticator) |
Modifier and Type | Method and Description |
---|---|
boolean |
Repo.authenticate(Callback[] credentials) |
Copyright © 2010–2025 Open Identity Platform Community. All rights reserved.