com.adobe.idp.um.spi.authentication
Class AuthResponseImpl

java.lang.Object
  com.adobe.idp.um.spi.authentication.AuthResponseImpl

All Implemented Interfaces:

AuthResponse, java.io.Serializable

public class AuthResponseImpl
extends java.lang.Object
implements AuthResponse, java.io.Serializable

The AuthResponseImpl class provides a mechanism for an authentication provider to communicate authentication results to User Management.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.adobe.idp.um.spi.authentication.AuthResponse

ASSERTION_LIFE, AUTH_ERROR, AUTH_FAILED, AUTH_SUCCESS, AUTH_UNRESOLVED, CONTINUE

Constructor Summary

AuthResponseImpl()

Method Summary

java.util.Map	getAuthProviderSpecificTokens() Retrieves the tokens passed by the authentication provider.
java.lang.String	getAuthStatus() Retrieves the authentication results for this object.
java.lang.String	getAuthType() Retrieves the authentication type for this object.
java.lang.String	getDomain() Retrieves the domain for this AuthResponse object.
java.lang.String	getErrorMessage() Retrieves the error message for this object.
java.util.List	getExceptions() Retrieves the exceptions for this object.
java.lang.String	getIssuerCN() Retrieves the issuer's canonical name.
java.lang.String	getKerberosIntermediateTkt() This method is related to Kerberos authentication and is not useful to implementations of AuthProvider.
java.lang.String	getUsername() Retrieves the login identification for this object.
boolean	isEncryptionRequired() Determines whether the tokens need to be encypted.
void	setAuthProviderSpecificTokens(java.util.Map tokenList) Sets the tokens passed by the authentication provider.
void	setAuthStatus(java.lang.String status) Sets the results of the authentication.
void	setAuthType(java.lang.String authType) Sets the type of authentication used.
void	setDomain(java.lang.String domain) Sets the domain associated with the authentication provider that performed the authentication.
void	setEncryptionRequired(boolean encryptionRequired) Sets whether the additional information returned by the authentication provider, in the form of string tokens, need to be encrypted before they become a part of the SAML assertion.
void	setErrorMessage(java.lang.String message) Sets an error message for this object.
void	setExceptions(java.util.List exceps) Specifies exceptions that occurred during authentication.
void	setIssuerCN(java.lang.String issuerCN) Sets the issuer's canonical name.
void	setKerberosIntermediateTkt(java.lang.String tkt) This method is related to Kerberos authentication and should not be used.
void	setUsername(java.lang.String user) Sets the login identification used for authentication.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthResponseImpl

public AuthResponseImpl()

Method Detail

getAuthStatus

public java.lang.String getAuthStatus()

Retrieves the authentication results for this object.

Specified by:

getAuthStatus in interface AuthResponse

Returns:

A java.lang.String that contains the authentication result.

See Also:

AuthResponse.AUTH_SUCCESS, AuthResponse.AUTH_FAILED

setAuthStatus

public void setAuthStatus(java.lang.String status)

Sets the results of the authentication.

Specified by:

setAuthStatus in interface AuthResponse

Parameters:

result - A java.lang.String that contains the authentication results. Valid values for this parameter are "success" and "failed".

See Also:

AuthResponse.AUTH_SUCCESS, AuthResponse.AUTH_FAILED

getErrorMessage

public java.lang.String getErrorMessage()

Retrieves the error message for this object.

Specified by:

getErrorMessage in interface AuthResponse

Returns:

A java.lang.String that contains the error message.

setErrorMessage

public void setErrorMessage(java.lang.String message)

Sets an error message for this object. This message should indicate an error other than exceptions that occur during authentication. User Management logs the provided error message.

Specified by:

setErrorMessage in interface AuthResponse

Parameters:

message - A java.lang.String that contains the error message. The maximum length of the message is 250 characters; errors can occur if greater lengths are used.

See Also:

#setExceptions()

getAuthType

public java.lang.String getAuthType()

Retrieves the authentication type for this object.

Specified by:

getAuthType in interface AuthResponse

Returns:

A java.lang.String that contains the authentication type.

setAuthType

public void setAuthType(java.lang.String authType)

Sets the type of authentication used. The authentication type should be the type that was provided to the AuthProvider.authenticate() method.

Specified by:

setAuthType in interface AuthResponse

Parameters:

authType - A java.lang.String that contains the authentication type.

getUsername

public java.lang.String getUsername()

Retrieves the login identification for this object.

Specified by:

getUsername in interface AuthResponse

Returns:

A java.lang.String that contains the user name.

setUsername

public void setUsername(java.lang.String user)

Sets the login identification used for authentication. The user name should be the name that was provided to the AuthProvider.authenticate() method.

Specified by:

setUsername in interface AuthResponse

Parameters:

userName - A java.lang.String that contains the user name. The maximum length of the String you can use is 250 characters or errors can occur.

getDomain

public java.lang.String getDomain()

Retrieves the domain for this AuthResponse object.

Specified by:

getDomain in interface AuthResponse

Returns:

A String that contains the domain.

setDomain

public void setDomain(java.lang.String domain)

Sets the domain associated with the authentication provider that performed the authentication.

Specified by:

setDomain in interface AuthResponse

Parameters:

domain - A String that contains the domain. The maximum length of the string is 50 characters; errors can occur if greater lengths are used.

See Also:

AuthConfigBO.getDomainName()

getKerberosIntermediateTkt

public java.lang.String getKerberosIntermediateTkt()

This method is related to Kerberos authentication and is not useful to implementations of AuthProvider.

Specified by:

getKerberosIntermediateTkt in interface AuthResponse

Returns:

A java.lang.String containing the Kerberos intermediate ticket.

setKerberosIntermediateTkt

public void setKerberosIntermediateTkt(java.lang.String tkt)

This method is related to Kerberos authentication and should not be used.

Specified by:

setKerberosIntermediateTkt in interface AuthResponse

Parameters:

tkt - A java.lang.String containing the Kerberos intermediate ticket.

setExceptions

public void setExceptions(java.util.List exceps)

Specifies exceptions that occurred during authentication. User Management logs the provided exceptions.

Specified by:

setExceptions in interface AuthResponse

Parameters:

exceptions - A java.util.List object that contains the exceptions.

getExceptions

public java.util.List getExceptions()

Retrieves the exceptions for this object.

Specified by:

getExceptions in interface AuthResponse

Returns:

A java.util.List object that contains the exceptions.

getIssuerCN

public java.lang.String getIssuerCN()

Retrieves the issuer's canonical name.

Specified by:

getIssuerCN in interface AuthResponse

Returns:

A java.lang.String containing the issuer's canonical name.

setIssuerCN

public void setIssuerCN(java.lang.String issuerCN)

Sets the issuer's canonical name.

Specified by:

setIssuerCN in interface AuthResponse

Parameters:

issuerCN - A java.lang.String containing the issuer's canonical name.

setAuthProviderSpecificTokens

public void setAuthProviderSpecificTokens(java.util.Map tokenList)

Sets the tokens passed by the authentication provider. The authentication provider may require that you return additional information that is needed as part of the assertion. The additional information is a list of string tokens in the AuthResponse.

Specified by:

setAuthProviderSpecificTokens in interface AuthResponse

Parameters:

tokenList - A java.util.List containing the list of string tokens.

getAuthProviderSpecificTokens

public java.util.Map getAuthProviderSpecificTokens()

Retrieves the tokens passed by the authentication provider. The authentication provider may require that you return additional information that is needed as part of the assertion. The additional information is a list of string tokens in the AuthResponse.

Specified by:

getAuthProviderSpecificTokens in interface AuthResponse

Returns:

tokenList A java.util.List containing the list of string tokens.

isEncryptionRequired

public boolean isEncryptionRequired()

Determines whether the tokens need to be encypted.

Specified by:

isEncryptionRequired in interface AuthResponse

Returns:

true if the tokens need to be encrypted, false otherwise.

setEncryptionRequired

public void setEncryptionRequired(boolean encryptionRequired)

Sets whether the additional information returned by the authentication provider, in the form of string tokens, need to be encrypted before they become a part of the SAML assertion.

Specified by:

setEncryptionRequired in interface AuthResponse

Parameters:

encryptionRequired - true if the tokens need to be encrypted, false otherwise.