fish.payara.security.oauth2.api

Class OAuthIdentityStore

java.lang.Object

fish.payara.security.oauth2.api.OAuthIdentityStore

All Implemented Interfaces:

javax.security.enterprise.identitystore.IdentityStore

public class OAuthIdentityStore
extends Object
implements javax.security.enterprise.identitystore.IdentityStore

This is a basic identity store that will always validate as a valid result. This class does not add the user to any security groups.

This identity store validates a RememberMeCredential and presumes that the the token passes to the credential upon creation is a valid one and does no further validation. If further validation is required then it may be useful to send a JAX-RS request to the OAuth provider.

If an fish.payara.security.oauth2.annotation.OAuth2AuthenticationDefinition is declared and their are no other IdentityStore definitions implemented then this will be used as a fall-back. If other IdentityStore definitions are available but none validate RememberMeCredential then CredentialValidationResult.NOT_VALIDATED_RESULT will be returned to the authentication mechanism.

Since:

4.1.2.182

Author:

jonathan coustick

Nested Class Summary

Nested classes/interfaces inherited from interface javax.security.enterprise.identitystore.IdentityStore

javax.security.enterprise.identitystore.IdentityStore.ValidationType

Field Summary

Fields inherited from interface javax.security.enterprise.identitystore.IdentityStore

DEFAULT_VALIDATION_TYPES

Constructor Summary

Constructors

Constructor and Description
OAuthIdentityStore()

Method Summary

Modifier and Type	Method and Description
int	priority()
javax.security.enterprise.identitystore.CredentialValidationResult	validate(javax.security.enterprise.credential.RememberMeCredential credential) Returns a valid CredentialValidationResult.
Set<javax.security.enterprise.identitystore.IdentityStore.ValidationType>	validationTypes()

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.security.enterprise.identitystore.IdentityStore

getCallerGroups, validate

Constructor Detail

OAuthIdentityStore

public OAuthIdentityStore()

Method Detail

validate

public javax.security.enterprise.identitystore.CredentialValidationResult validate(javax.security.enterprise.credential.RememberMeCredential credential)

Returns a valid CredentialValidationResult.

If further validation is required this method should be overridden in a sub-class or alternative IdentityStore. Calling RememberMeCredential.getToken() on the credential passed in will get the authorisation token which can be used to get more information about the user from the OAuth provider by sending a GET request to an endpoint i.e. https://oauthprovider/user&token=exampletoken.

Parameters:

credential -

Returns:

priority

public int priority()

Specified by:

priority in interface javax.security.enterprise.identitystore.IdentityStore

validationTypes

public Set<javax.security.enterprise.identitystore.IdentityStore.ValidationType> validationTypes()

Specified by:

validationTypes in interface javax.security.enterprise.identitystore.IdentityStore