org.aerogear.mobile.auth.credentials

Class OIDCCredentials

java.lang.Object

org.aerogear.mobile.auth.credentials.OIDCCredentials

public class OIDCCredentials
extends java.lang.Object

Credentials for OIDC based authentication

Constructor Summary

Constructors

Constructor and Description
OIDCCredentials()
OIDCCredentials(java.lang.String serialisedCredential) OpenID Connect credentials containing the identity, refresh and access tokens provided on a successful authentication with OpenID Connect.

Method Summary

Modifier and Type	Method and Description
boolean	checkValidAuth() Check whether the user is authorized and not expired.
static OIDCCredentials	deserialize(java.lang.String serializedCredential) Return a new credential from the output of serialize()
boolean	equals(java.lang.Object o)
java.lang.String	getAccessToken()
java.lang.String	getIdentityToken()
boolean	getNeedsRenewal() Check whether new access token is needed.
java.lang.String	getRefreshToken()
int	hashCode()
boolean	isAuthorized() Check if the user is authenticated/authorized.
boolean	isExpired() Returns whether this token is expired or not.
boolean	renew() Renew the token.
java.lang.String	serialize() Returns stringified JSON for the OIDCCredential.
void	setNeedsRenewal() Force request of new access token.
boolean	verifyClaims(org.jose4j.jwk.JsonWebKeySet jwks, KeycloakConfiguration keycloakConfig) Verify the token and its claims against the given Keycloak configuration

Methods inherited from class java.lang.Object

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

Constructor Detail

OIDCCredentials

public OIDCCredentials(java.lang.String serialisedCredential)

OpenID Connect credentials containing the identity, refresh and access tokens provided on a successful authentication with OpenID Connect.

Parameters:

serialisedCredential - JSON string representation of the authState field produced by deserialize(String).

Throws:

java.lang.IllegalArgumentException - if deserializing fails

OIDCCredentials

public OIDCCredentials()

Method Detail

getAccessToken

public java.lang.String getAccessToken()

getIdentityToken

public java.lang.String getIdentityToken()

getRefreshToken

public java.lang.String getRefreshToken()

verifyClaims

public boolean verifyClaims(org.jose4j.jwk.JsonWebKeySet jwks,
                            KeycloakConfiguration keycloakConfig)

Verify the token and its claims against the given Keycloak configuration

Parameters:

jwks - json web keys to verify

keycloakConfig - keycloak config containing certificate information for the jwks instance.

Returns:

true if the jwks value is valid, false otherwise

isExpired

public boolean isExpired()

Returns whether this token is expired or not.

Returns:

true if expired.

getNeedsRenewal

public boolean getNeedsRenewal()

Check whether new access token is needed.

Returns:

true if access token is needed

setNeedsRenewal

public void setNeedsRenewal()

Force request of new access token.

isAuthorized

public boolean isAuthorized()

Check if the user is authenticated/authorized.

Returns:

true if the user is authenticated/authorized.

serialize

public java.lang.String serialize()

Returns stringified JSON for the OIDCCredential.

Returns:

Stringified JSON OIDCCredential

Throws:

java.lang.IllegalStateException - if the auth state can not be serialized

deserialize

public static OIDCCredentials deserialize(java.lang.String serializedCredential)

Return a new credential from the output of serialize()

Parameters:

serializedCredential - serialized credential from serialize()

Returns:

new credential

Throws:

java.lang.IllegalArgumentException - if the serailized credentials can not be deserialized

checkValidAuth

public boolean checkValidAuth()

Check whether the user is authorized and not expired.

Returns:

true if user is authorized and token is not expired.

renew

public boolean renew()
              throws AuthenticationException

Renew the token.

Returns:

not Implemented

Throws:

java.lang.UnsupportedOperationException - this operation is not implemented

AuthenticationException - this operation is not implemented

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object