com.mulesoft.modules.oauth2.provider.internal

Class OAuth2ProviderOperations

java.lang.Object

com.mulesoft.modules.oauth2.provider.internal.OAuth2ProviderOperations

public class OAuth2ProviderOperations
extends Object

Constructor Summary

Constructors

Constructor and Description
OAuth2ProviderOperations()

Method Summary

Modifier and Type	Method and Description
void	createClient(OAuth2ProviderConfiguration oAuth2ProviderConfiguration, String clientId, ClientType clientType, String clientSecret, String clientName, String description, String principal, Set<String> redirectUris, Set<Constants.RequestGrantType> authorizedGrantTypes, Set<String> scopes, boolean failIfPresent) Creates a new client and saves it in the configured client store.
void	deleteClient(OAuth2ProviderConfiguration oAuth2ProviderConfiguration, String clientId) Deletes a client from the store.
void	revokeToken(OAuth2ProviderConfiguration oAuth2ProviderConfiguration, String token) Revokes an access token or refresh token, invalidating the related refresh token or access token as well.
org.mule.runtime.extension.api.runtime.operation.Result<String,Void>	validateToken(OAuth2ProviderConfiguration oAuth2ProviderConfiguration, org.mule.runtime.extension.api.security.AuthenticationHandler authenticationHandler, String accessTokenToValidate, Set<String> scopesToValidate, Set<String> resourceOwnerRoles) Checks that a valid access token is provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2ProviderOperations

public OAuth2ProviderOperations()

Method Detail

validateToken

@Throws(value=ValidateTokenErrorProvider.class)
 @MediaType(value="application/json")
public org.mule.runtime.extension.api.runtime.operation.Result<String,Void> validateToken(@Config
                                                                                                                                                                                OAuth2ProviderConfiguration oAuth2ProviderConfiguration,
                                                                                                                                                                                org.mule.runtime.extension.api.security.AuthenticationHandler authenticationHandler,
                                                                                                                                                                                @Expression(value=REQUIRED) @Optional(defaultValue="#[(attributes.headers[\'authorization\'] splitBy \' \')[1]]") @Alias(value="accessToken")
                                                                                                                                                                                String accessTokenToValidate,
                                                                                                                                                                                @Expression(value=REQUIRED) @Optional @NullSafe @Alias(value="scopes")
                                                                                                                                                                                Set<String> scopesToValidate,
                                                                                                                                                                                @Expression(value=REQUIRED) @Optional @NullSafe
                                                                                                                                                                                Set<String> resourceOwnerRoles)
                                                                                                                                                                         throws UnauthorizedTokenException

Checks that a valid access token is provided.

Parameters:

oAuth2ProviderConfiguration - The provider configuration

accessTokenToValidate - The token to evaluate or the expression to resolve in order to get the token value

scopesToValidate - The scopes to enforce when validating the token

resourceOwnerRoles - The resource owner roles to enforce when validating the token

Throws:

UnauthorizedTokenException - if the token is not valid

createClient

@Throws(value=CreateClientErrorProvider.class)
public void createClient(@Config
                                                                        OAuth2ProviderConfiguration oAuth2ProviderConfiguration,
                                                                        @Expression(value=SUPPORTED)
                                                                        String clientId,
                                                                        @Expression(value=SUPPORTED) @Optional(defaultValue="PUBLIC") @Alias(value="type")
                                                                        ClientType clientType,
                                                                        @Expression(value=SUPPORTED) @Optional @Alias(value="secret")
                                                                        String clientSecret,
                                                                        @Expression(value=SUPPORTED) @Optional
                                                                        String clientName,
                                                                        @Expression(value=SUPPORTED) @Optional
                                                                        String description,
                                                                        @Expression(value=SUPPORTED) @Optional
                                                                        String principal,
                                                                        @Expression(value=REQUIRED) @Optional @NullSafe
                                                                        Set<String> redirectUris,
                                                                        @Expression(value=REQUIRED) @Optional @NullSafe
                                                                        Set<Constants.RequestGrantType> authorizedGrantTypes,
                                                                        @Expression(value=REQUIRED) @Optional @NullSafe
                                                                        Set<String> scopes,
                                                                        @Expression(value=NOT_SUPPORTED) @Optional(defaultValue="false")
                                                                        boolean failIfPresent)
                                                                 throws ClientAlreadyExistsException,
                                                                        OAuth2ConfigurationException

Creates a new client and saves it in the configured client store.

Parameters:

clientId - the Client Id

clientSecret - the Client secret

clientType - Clients can be PUBLIC or CONFIDENTIAL. If Confidential the secret is required. By default Clients are PUBLIC

clientName - a friendly name for the Client

description - a brief description of the Client

principal - An optional principal to use when the ID can't be used with the security provider

redirectUris - a list with the Client's valid redirect uris

authorizedGrantTypes - the Client's supported grant types

scopes - the Client's supported scopes

failIfPresent - boolean to indicate if the operation should fail when the client id is already used. Otherwise it should override the infotmation for the registered client

Throws:

ClientAlreadyExistsException

OAuth2ConfigurationException

deleteClient

@Throws(value=DeleteClientErrorProvider.class)
public void deleteClient(@Config
                                                                        OAuth2ProviderConfiguration oAuth2ProviderConfiguration,
                                                                        @Expression(value=SUPPORTED)
                                                                        String clientId)
                                                                 throws NoSuchClientException

Deletes a client from the store.

Parameters:

clientId - the Client Id

Throws:

NoSuchClientException - If the client does not exist

revokeToken

@Throws(value=RevokeTokenErrorProvider.class)
public void revokeToken(@Config
                                                                      OAuth2ProviderConfiguration oAuth2ProviderConfiguration,
                                                                      @Expression(value=SUPPORTED)
                                                                      String token)
                                                               throws InvalidTokenException

Revokes an access token or refresh token, invalidating the related refresh token or access token as well. If client credentials need to be validated the validateClient credential should be used before.

Parameters:

oAuth2ProviderConfiguration - this provider configuration

token - the token to revoke, it can be an access token or a refresh token

Throws:

InvalidTokenException - if the token is not valid