Package | Description |
---|---|
com.sun.identity.authentication |
Provides interfaces and classes for writing a Remote Java client application
to authenticate to OpenAM.
|
com.sun.identity.authentication.modules.hotp |
Implementation of the Authentication Framework HOTP module and associated classes.
|
com.sun.identity.authentication.server |
This package contains the classes that represent server side
functionality such as the implementation of request for
authenticating, user credential callbacks.
|
com.sun.identity.authentication.spi |
Provides interfaces and classes for writing a supplemental authentication
module to plug into OpenAM.
|
com.sun.identity.idm |
Provides classes for accessing the Identity Repository interfaces.
|
org.forgerock.openam.authentication.modules.common.mapping |
This package contains the mapping interfaces and default implementations that are common for use by all
authentication modules.
|
org.forgerock.openam.authentication.modules.oath.plugins |
Classes in this package provide plugin functionality for the oath module.
|
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. |
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. |
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,
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(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 . |
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 |
---|---|
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 |
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 |
---|---|
AuthLoginException |
AuthContextLocal.getLoginException()
Returns login exception, if any, 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(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 | Class and Description |
---|---|
class |
InvalidPasswordException
Exception that is thrown when the user-entered password token causes the
authentication module to be authenticated to fail.
|
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 |
---|---|
void |
AMLoginModule.clearInfoText(int state)
Clears the info text for a given callback state
|
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.
|
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.
|
String |
AMLoginModule.getUserSessionProperty(String name)
Returns the property from the user session.
|
void |
AMLoginModule.replaceCallback(int state,
int index,
Callback callback)
Replace Callback object 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.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 |
IdRepo.authenticate(Callback[] credentials)
Returns
true if the data store successfully authenticates
the identity with the provided credentials. |
Modifier and Type | Method and Description |
---|---|
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 |
AccountProvider.provisionUser(AMIdentityRepository idrepo,
Map<String,Set<String>> attributes)
Provisions a user with the specified attributes.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Copyright © 2010-2018, ForgeRock All Rights Reserved.