Package com.adobe.idp.um.spi.authentication
Interfacepublic interface AuthResponse

The AuthResponse interface defines a mechanism for an authentication provider to communicate authentication results to User Management. If the authentication provider successfully authenticates the user information, it should communicate the success to User Management along with the authenticated user name, the user domain, and the authentication type performed.

If the authentication provider cannot authenticate the user information, it should communicate the failure to User Management along with error information. User Management may log the error information.

See also

AuthProvider

Public Methods
 MethodDefined by
  
List getAuthProviderSpecificTokens()
Retrieves the tokens passed by the authentication provider.
AuthResponse
  
String getAuthStatus()
Retrieves the authentication results for this object.
AuthResponse
  
String getAuthType()
Retrieves the authentication type for this object.
AuthResponse
  
String getDomain()
Retrieves the domain for this AuthResponse object.
AuthResponse
  
String getErrorMessage()
Retrieves the error message for this object.
AuthResponse
  
List getExceptions()
Retrieves the exceptions for this object.
AuthResponse
  
String getIssuerCN()
Retrieves the issuer's canonical name.
AuthResponse
  
String getKerberosIntermediateTkt()
This method is related to Kerberos authentication and is not useful to implementations of com.adobe.idp.um.spi.authentication.AuthProvider AuthProvider.
AuthResponse
  
String getUsername()
Retrieves the login identification for this object.
AuthResponse
  
boolean isEncryptionRequired()
Determines whether the tokens need to be encypted.
AuthResponse
  
void setAuthProviderSpecificTokens(List tokenList)
Sets the tokens passed by the authentication provider.
AuthResponse
  
void setAuthStatus(String result)
Sets the results of the authentication.
AuthResponse
  
void setAuthType(String authType)
Sets the type of authentication used.
AuthResponse
  
void setDomain(String domain)
Sets the domain associated with the authentication provider that performed the authentication.
AuthResponse
  
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.
AuthResponse
  
void setErrorMessage(String message)
Sets an error message for this object.
AuthResponse
  
void setExceptions(List exceptions)
Specifies exceptions that occurred during authentication.
AuthResponse
  
void setIssuerCN(String issuerCN)
Sets the issuer's canonical name.
AuthResponse
  
void setKerberosIntermediateTkt(String tkt)
This method is related to Kerberos authentication and should not be used.
AuthResponse
  
void setUsername(String userName)
Sets the login identification used for authentication.
AuthResponse
Public Constants
 ConstantDefined by
  AUTH_FAILED
[static] The constant that represents a failed authentication.
AuthResponse
  AUTH_SUCCESS
[static] The constant that represents a successful authentication.
AuthResponse
  CONTINUE
[static] A constant used for Kerberos authentication.
AuthResponse
Method Detail
getAuthProviderSpecificTokens()
public List 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.

Returns
tokenList A java.util.List containing the list of string tokens.
getAuthStatus() 
public String getAuthStatus()

Retrieves the authentication results for this object.

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

See also

AUTH_SUCCESS
AUTH_FAILED
getAuthType() 
public String getAuthType()

Retrieves the authentication type for this object.

Returns
A java.lang.String that contains the authentication type.
getDomain() 
public String getDomain()

Retrieves the domain for this AuthResponse object.

Returns
A String that contains the domain.
getErrorMessage() 
public String getErrorMessage()

Retrieves the error message for this object.

Returns
A java.lang.String that contains the error message.
getExceptions() 
public List getExceptions()

Retrieves the exceptions for this object.

Returns
A java.util.List object that contains the exceptions.
getIssuerCN() 
public String getIssuerCN()

Retrieves the issuer's canonical name.

Returns
A java.lang.String containing the issuer's canonical name.
getKerberosIntermediateTkt() 
public String getKerberosIntermediateTkt()

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

Returns
A java.lang.String containing the Kerberos intermediate ticket.
getUsername() 
public String getUsername()

Retrieves the login identification for this object.

Returns
A java.lang.String that contains the user name.
isEncryptionRequired() 
public boolean isEncryptionRequired()

Determines whether the tokens need to be encypted.

Returns
true if the tokens need to be encrypted, false otherwise.
setAuthProviderSpecificTokens() 
public void setAuthProviderSpecificTokens(List 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.

Parameters

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

setAuthStatus() 
public void setAuthStatus(String result)

Sets the results of the authentication.

Parameters

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

See also

AUTH_SUCCESS
AUTH_FAILED
setAuthType() 
public void setAuthType(String authType)

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

Parameters

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

setDomain() 
public void setDomain(String domain)

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

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()
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.

Parameters

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

setErrorMessage() 
public void setErrorMessage(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.

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()
setExceptions() 
public void setExceptions(List exceptions)

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

Parameters

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

setIssuerCN() 
public void setIssuerCN(String issuerCN)

Sets the issuer's canonical name.

Parameters

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

setKerberosIntermediateTkt() 
public void setKerberosIntermediateTkt(String tkt)

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

Parameters

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

setUsername() 
public void setUsername(String userName)

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

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.

Constant Detail
AUTH_FAILEDConstant
public static final AUTH_FAILED

The constant that represents a failed authentication.

AUTH_SUCCESSConstant 
public static final AUTH_SUCCESS

The constant that represents a successful authentication.

CONTINUEConstant 
public static final CONTINUE

A constant used for Kerberos authentication. Your service provider should not use this constant.




© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Sep 27 2007, 8:38 AM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/idp/um/spi/authentication/AuthResponse.html