com.microsoft.aad.adal

Class AuthenticationResult

java.lang.Object

com.microsoft.aad.adal.AuthenticationResult

All Implemented Interfaces:

java.io.Serializable

public class AuthenticationResult
extends java.lang.Object
implements java.io.Serializable

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthenticationResult.AuthenticationStatus Status for authentication.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	createAuthorizationHeader() Uses access token to create header for web requests.
java.lang.String	getAccessToken() Access token to send to the service in Authorization Header.
java.lang.String	getAccessTokenType() Token type.
java.lang.String	getAuthority() The token returned is cached with this authority as key.
java.lang.String	getClientId()
ClientInfo	getClientInfo() Gets the ClientInfo.
TelemetryUtils.CliTelemInfo	getCliTelemInfo()
java.lang.String	getErrorCode() Gets error code.
java.lang.String	getErrorDescription() Gets error description.
java.lang.String	getErrorLogInfo() Gets error log info.
java.lang.Long	getExpiresIn()
java.util.Date	getExpiresOn() Epoch time for expiresOn.
java.util.HashMap<java.lang.String,java.lang.String>	getHttpResponseBody() Get Http response message.
java.util.HashMap<java.lang.String,java.util.List<java.lang.String>>	getHttpResponseHeaders() Get Http response headers.
java.lang.String	getIdToken() Get raw idtoken.
boolean	getIsMultiResourceRefreshToken() Multi-resource refresh tokens can be used to request token for another resource.
java.lang.String	getRefreshToken() Refresh token to get new tokens.
java.lang.String	getResource() Gets the resource of this AuthenticationResult.
java.lang.Long	getResponseReceived()
int	getServiceStatusCode() Get service status code.
AuthenticationResult.AuthenticationStatus	getStatus() Gets status.
java.lang.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.
void	setAuthority(java.lang.String authority)
void	setClientId(java.lang.String clientId)
void	setExpiresIn(java.lang.Long expiresIn)
void	setResponseReceived(java.lang.Long responseReceived)

Methods inherited from class java.lang.Object

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

Field Detail

mAccessToken

protected java.lang.String mAccessToken

mRefreshToken

protected java.lang.String mRefreshToken

mExpiresOn

protected java.util.Date mExpiresOn

mErrorCode

protected java.lang.String mErrorCode

mErrorDescription

protected java.lang.String mErrorDescription

mErrorCodes

protected java.lang.String mErrorCodes

mIsMultiResourceRefreshToken

protected boolean mIsMultiResourceRefreshToken

mUserInfo

protected UserInfo mUserInfo

mTenantId

protected java.lang.String mTenantId

mIdToken

protected java.lang.String mIdToken

mStatus

protected AuthenticationResult.AuthenticationStatus mStatus

mInitialRequest

protected boolean mInitialRequest

mFamilyClientId

protected java.lang.String mFamilyClientId

mIsExtendedLifeTimeToken

protected boolean mIsExtendedLifeTimeToken

mExtendedExpiresOn

protected java.util.Date mExtendedExpiresOn

mAuthority

protected java.lang.String mAuthority

mCliTelemInfo

protected TelemetryUtils.CliTelemInfo mCliTelemInfo

mHttpResponseBody

protected java.util.HashMap<java.lang.String,java.lang.String> mHttpResponseBody

mServiceStatusCode

protected int mServiceStatusCode

mHttpResponseHeaders

protected java.util.HashMap<java.lang.String,java.util.List<java.lang.String>> mHttpResponseHeaders

Method Detail

createAuthorizationHeader

public java.lang.String createAuthorizationHeader()

Uses access token to create header for web requests.

Returns:

AuthorizationHeader

getAccessToken

public java.lang.String getAccessToken()

Access token to send to the service in Authorization Header.

Returns:

Access token

getRefreshToken

public java.lang.String getRefreshToken()

Refresh token to get new tokens.

Returns:

Refresh token

getAccessTokenType

public java.lang.String getAccessTokenType()

Token type.

Returns:

access token type

getExpiresOn

public java.util.Date getExpiresOn()

Epoch time for expiresOn.

Returns:

expiresOn Date

getExpiresIn

public java.lang.Long getExpiresIn()

setExpiresIn

public void setExpiresIn(java.lang.Long expiresIn)

getResponseReceived

public java.lang.Long getResponseReceived()

setResponseReceived

public void setResponseReceived(java.lang.Long responseReceived)

getIsMultiResourceRefreshToken

public boolean getIsMultiResourceRefreshToken()

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

Returns:

multi resource refresh token status

getUserInfo

public UserInfo getUserInfo()

UserInfo returned from IdToken.

Returns:

UserInfo

getTenantId

public java.lang.String getTenantId()

Gets tenantId.

Returns:

TenantId

getStatus

public AuthenticationResult.AuthenticationStatus getStatus()

Gets status.

Returns:

AuthenticationResult.AuthenticationStatus

getErrorCode

public java.lang.String getErrorCode()

Gets error code.

Returns:

Error code

getErrorDescription

public java.lang.String getErrorDescription()

Gets error description.

Returns:

error description

getErrorLogInfo

public java.lang.String getErrorLogInfo()

Gets error log info.

Returns:

log info

isExpired

public boolean isExpired()

Checks expiration time.

Returns:

true if expired

getAuthority

public final java.lang.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

getIdToken

public java.lang.String getIdToken()

Get raw idtoken.

Returns:

IdToken

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(java.lang.String authority)

getCliTelemInfo

public final TelemetryUtils.CliTelemInfo getCliTelemInfo()

getHttpResponseBody

public java.util.HashMap<java.lang.String,java.lang.String> getHttpResponseBody()

Get Http response message.

Returns:

HttpResponseBody

getHttpResponseHeaders

public java.util.HashMap<java.lang.String,java.util.List<java.lang.String>> getHttpResponseHeaders()

Get Http response headers.

Returns:

HttpResponseHeaders

getServiceStatusCode

public int getServiceStatusCode()

Get service status code.

Returns:

ServiceStatusCode

getClientId

public java.lang.String getClientId()

setClientId

public void setClientId(java.lang.String clientId)

getClientInfo

public ClientInfo getClientInfo()

Gets the ClientInfo.

Returns:

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

getResource

public java.lang.String getResource()

Gets the resource of this AuthenticationResult.

Returns:

The resource to get.