org.opencode4workspace.authentication

Class AuthenticationResult

java.lang.Object

org.opencode4workspace.authentication.AuthenticationResult

public class AuthenticationResult
extends Object

Since:

0.5.0 Object containing details from authentication output

Author:

Christian Guedemann

Constructor Summary

Constructors

Constructor and Description
AuthenticationResult(String jwtToken, int expires, String displayName, String userId, String jtiId, String refreshToken, String scopeAsString, Date created) Constructs AuthenticationResult from parameters.

Method Summary

Modifier and Type	Method and Description
static AuthenticationResult	buildFromToken(AppToken appToken) Builds an AuthenticationResult object from the AppToken object constructed from JSON returned by the authentication process
Date	getCreated() Gets date when the authentication result was created
String	getDisplayName() Gets the display name for the user, not currently in authentication result for applications
Date	getExpireDate() Gets the time the token will expire
int	getExpires() Gets the length of time before the token will expire
String	getJtId() Gets JTI id returned in authentication result
String	getJwtToken() Gets the JWT token returned in authentication result
String	getScopeAsString() Get the scope for a user / application
String	getUserId() Gets user or application ID returned in authentication result
String	getUserRefreshToken() Gets refresh token for a user.
boolean	isValid() Test JDT token expiry time against current time and return whether or not it's still valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationResult

public AuthenticationResult(String jwtToken,
                            int expires,
                            String displayName,
                            String userId,
                            String jtiId,
                            String refreshToken,
                            String scopeAsString,
                            Date created)

Constructs AuthenticationResult from parameters. Typically called from buildFromToken(AppToken)

Parameters:

jwtToken - String JWT token for future requests

expires - int, length of time until expiry

displayName - String, display name for user or blank for applications

userId - String, user id

jtiId - String, JTI id

refreshToken - String user's refresh token

scopeAsString - String return value for scopes for the user's access

created - Date the UserToken was initially created

Since:

0.5.0

Method Detail

getJwtToken

public String getJwtToken()

Gets the JWT token returned in authentication result

Returns:

String, JWT token required for future requests

Since:

0.5.0

getExpires

public int getExpires()

Gets the length of time before the token will expire

Returns:

int, time until expiry

Since:

0.5.0

getExpireDate

public Date getExpireDate()

Gets the time the token will expire

Returns:

Date, expiry date

Since:

0.5.0

getCreated

public Date getCreated()

Gets date when the authentication result was created

Returns:

Date authentication result was created

Since:

0.5.0

getDisplayName

public String getDisplayName()

Gets the display name for the user, not currently in authentication result for applications

Returns:

String user's display name

Since:

0.5.0

getUserId

public String getUserId()

Gets user or application ID returned in authentication result

Returns:

String user id

Since:

0.5.0

getJtId

public String getJtId()

Gets JTI id returned in authentication result

Returns:

String, JTI id

Since:

0.5.0

getUserRefreshToken

public String getUserRefreshToken()

Gets refresh token for a user. There is no refresh token for a PersonToken

Returns:

String, refresh token or blank for AppToken

Since:

0.8.0

getScopeAsString

public String getScopeAsString()

Get the scope for a user / application

Returns:

String scope as String

Since:

0.8.0

isValid

public boolean isValid()

Test JDT token expiry time against current time and return whether or not it's still valid. If not, we need to authenticate again

Returns:

boolean, whether or not valid

Since:

0.5.0

buildFromToken

public static AuthenticationResult buildFromToken(AppToken appToken)

Builds an AuthenticationResult object from the AppToken object constructed from JSON returned by the authentication process

Parameters:

appToken - AppToken object constructed from JSON returned by authentication process

Returns:

new AuthenticationResult object with contents extracted from AppToken

Since:

0.5.0