AuthenticationResult Class

Package:

com.microsoft.aad.adal

• java.lang.Object
• • Serializable
  • • com.microsoft.aad.adal.AuthenticationResult

public class AuthenticationResult

Result class to keep code, token and other info Serializable properties Mark temp properties as Transient if you dont want to keep them in serialization.

Field Summary

Modifier and Type	Field and Description
String	mAccessToken
String	mAuthority
CliTelemInfo	mCliTelemInfo
String	mErrorCode
String	mErrorCodes
String	mErrorDescription
Date	mExpiresOn
Date	mExtendedExpiresOn
String	mFamilyClientId
HashMap<String, String>	mHttpResponseBody
HashMap<String, List<String>>	mHttpResponseHeaders
String	mIdToken
boolean	mInitialRequest
boolean	mIsExtendedLifeTimeToken
boolean	mIsMultiResourceRefreshToken
String	mRefreshToken
int	mServiceStatusCode
AuthenticationResult.AuthenticationStatus	mStatus
String	mTenantId
UserInfo	mUserInfo

Method Summary

Modifier and Type	Method and Description
String	createAuthorizationHeader() Uses access token to create header for web requests.
String	getAccessToken() Access token to send to the service in Authorization Header.
String	getAccessTokenType() Token type.
final String	getAuthority() The token returned is cached with this authority as key. We expect the subsequent requests to AcquireToken will use this authority as the authority parameter else AcquireTokenSilent will fail
String	getClientId()
ClientInfo	getClientInfo() Gets the ClientInfo.
final CliTelemInfo	getCliTelemInfo()
String	getErrorCode() Gets error code.
String	getErrorDescription() Gets error description.
String	getErrorLogInfo() Gets error log info.
Long	getExpiresIn()
Date	getExpiresOn() Epoch time for expiresOn.
HashMap<String, String>	getHttpResponseBody() Get Http response message.
HashMap<String, List<String>>	getHttpResponseHeaders() Get Http response headers.
String	getIdToken() Get raw idtoken.
boolean	getIsMultiResourceRefreshToken() Multi-resource refresh tokens can be used to request token for another resource.
String	getRefreshToken() Refresh token to get new tokens.
String	getResource() Gets the resource of this AuthenticationResult.
Long	getResponseReceived()
int	getServiceStatusCode() Get service status code.
AuthenticationResult.AuthenticationStatus	getStatus() Gets status.
String	getTenantId() Gets tenantId.
UserInfo	getUserInfo() UserInfo returned from IdToken.
boolean	isExpired() Checks expiration time.
boolean	isExtendedLifeTimeToken() Gets if the returned token is valid in terms of extended lifetime.
final void	setAuthority(final String authority)
void	setClientId(final String clientId)
void	setExpiresIn(final Long expiresIn)
void	setResponseReceived(final Long responseReceived)

Field Details

mAccessToken

protected String mAccessToken

mAuthority

protected String mAuthority

mCliTelemInfo

protected CliTelemInfo mCliTelemInfo

mErrorCode

protected String mErrorCode

mErrorCodes

protected String mErrorCodes

mErrorDescription

protected String mErrorDescription

mExpiresOn

protected Date mExpiresOn

mExtendedExpiresOn

protected Date mExtendedExpiresOn

mFamilyClientId

protected String mFamilyClientId

mHttpResponseBody

protected HashMap mHttpResponseBody= null

mHttpResponseHeaders

protected HashMap> mHttpResponseHeaders= null

mIdToken

protected String mIdToken

mInitialRequest

protected boolean mInitialRequest

mIsExtendedLifeTimeToken

protected boolean mIsExtendedLifeTimeToken= false

mIsMultiResourceRefreshToken

protected boolean mIsMultiResourceRefreshToken

mRefreshToken

protected String mRefreshToken

mServiceStatusCode

protected int mServiceStatusCode= -1

mStatus

protected AuthenticationStatus mStatus= AuthenticationStatus.Failed

mTenantId

protected String mTenantId

mUserInfo

protected UserInfo mUserInfo

Method Details

createAuthorizationHeader

public String createAuthorizationHeader()

Uses access token to create header for web requests.

Returns:

AuthorizationHeader

getAccessToken

public String getAccessToken()

Access token to send to the service in Authorization Header.

Returns:

Access token

getAccessTokenType

public String getAccessTokenType()

Token type.

Returns:

access token type

getAuthority

public final String getAuthority()

The token returned is cached with this authority as key. We expect the subsequent requests to AcquireToken will use this authority as the authority parameter else AcquireTokenSilent will fail

Returns:

Authority

getClientId

public String getClientId()

getClientInfo

public ClientInfo getClientInfo()

Gets the ClientInfo.

Returns:

The ClientInfo to get or null (if the broker was used to acquire tokens).

getCliTelemInfo

public final CliTelemInfo getCliTelemInfo()

getErrorCode

public String getErrorCode()

Gets error code.

Returns:

Error code

getErrorDescription

public String getErrorDescription()

Gets error description.

Returns:

error description

getErrorLogInfo

public String getErrorLogInfo()

Gets error log info.

Returns:

log info

getExpiresIn

public Long getExpiresIn()

getExpiresOn

public Date getExpiresOn()

Epoch time for expiresOn.

Returns:

expiresOn Date

getHttpResponseBody

public HashMap getHttpResponseBody()

Get Http response message.

Returns:

HttpResponseBody

getHttpResponseHeaders

public HashMap> getHttpResponseHeaders()

Get Http response headers.

Returns:

HttpResponseHeaders

getIdToken

public String getIdToken()

Get raw idtoken.

Returns:

IdToken

getIsMultiResourceRefreshToken

public boolean getIsMultiResourceRefreshToken()

Multi-resource refresh tokens can be used to request token for another resource.

Returns:

multi resource refresh token status

getRefreshToken

public String getRefreshToken()

Refresh token to get new tokens.

Returns:

Refresh token

getResource

public String getResource()

Gets the resource of this AuthenticationResult.

Returns:

The resource to get.

getResponseReceived

public Long getResponseReceived()

getServiceStatusCode

public int getServiceStatusCode()

Get service status code.

Returns:

ServiceStatusCode

getStatus

public AuthenticationStatus getStatus()

Gets status.

Returns:

AuthenticationResult.AuthenticationStatus

getTenantId

public String getTenantId()

Gets tenantId.

Returns:

TenantId

getUserInfo

public UserInfo getUserInfo()

UserInfo returned from IdToken.

Returns:

UserInfo

isExpired

public boolean isExpired()

Checks expiration time.

Returns:

true if expired

isExtendedLifeTimeToken

public boolean isExtendedLifeTimeToken()

Gets if the returned token is valid in terms of extended lifetime.

Returns:

True if the returned token is valid in terms of extended lifetime

setAuthority

public final void setAuthority(final String authority)

Parameters:

authority

setClientId

public void setClientId(final String clientId)

Parameters:

clientId

setExpiresIn

public void setExpiresIn(final Long expiresIn)

Parameters:

expiresIn

setResponseReceived

public void setResponseReceived(final Long responseReceived)

Parameters:

responseReceived