Package org.nuxeo.ecm.platform.oauth2.tokens

Interface OAuth2TokenService

All Known Implementing Classes:

OAuth2TokenServiceImpl

public interface OAuth2TokenService

Manages oAuth2 tokens. A token can be:

• Provided by Nuxeo, it's the oAuth2 server provider.
• Consumed by Nuxeo, it's a client of another server provider.

Since:

11.1

Method Summary

Modifier and Type	Method	Description
String	garbageCollectExpiredTokens()	Garbage collects expired tokens.
List<NuxeoOAuth2Token>	getTokens(String nxuser)	Gets the OAuth2 tokens for the given user.
List<NuxeoOAuth2Token>	getTokens(String nxuser, NuxeoOAuth2TokenType type)	Gets the OAuth2 tokens from a given user name and a type.
List<NuxeoOAuth2Token>	getTokens(NuxeoPrincipal principal)	Gets the oAuth2 tokens as the given principal.
List<NuxeoOAuth2Token>	getTokens(NuxeoOAuth2TokenType type, NuxeoPrincipal principal)	Gets the oAuth2 tokens for a given type as the given principal.
List<NuxeoOAuth2Token>	search(String query, NuxeoPrincipal principal)	Finds the oAuth2 tokens that match the given query as the given principal.

Method Details

getTokens

List<NuxeoOAuth2Token> getTokens(NuxeoPrincipal principal)

Gets the oAuth2 tokens as the given principal.

Returns:

the oAuth2 tokens

Throws:

NuxeoException - with 403 status code if the given principal doesn't have access to the oAuth2 tokens

getTokens

List<NuxeoOAuth2Token> getTokens(String nxuser)

Gets the OAuth2 tokens for the given user.

Parameters:

nxuser - the nuxeo user

Returns:

the oAuth2 tokens that match the given user

Throws:

NullPointerException - if nxuser is null

getTokens

List<NuxeoOAuth2Token> getTokens(NuxeoOAuth2TokenType type,
 NuxeoPrincipal principal)

Gets the oAuth2 tokens for a given type as the given principal.

Parameters:

type - the token type NuxeoOAuth2TokenType

Returns:

the oAuth2 tokens that match the type

Throws:

NullPointerException - if type is null

NuxeoException - with 403 status code if the given principal doesn't have access to the oAuth2 tokens

getTokens

List<NuxeoOAuth2Token> getTokens(String nxuser,
 NuxeoOAuth2TokenType type)

Gets the OAuth2 tokens from a given user name and a type.

Parameters:

nxuser - the nuxeo user

type - the token type NuxeoOAuth2TokenType

Returns:

the oAuth2 tokens

Throws:

NullPointerException - if nxuser or type is null

search

List<NuxeoOAuth2Token> search(String query,
 NuxeoPrincipal principal)

Finds the oAuth2 tokens that match the given query as the given principal. To be retrieved a token should match the query anywhere in the string value of the fields NuxeoOAuth2Token.KEY_NUXEO_LOGIN, NuxeoOAuth2Token.KEY_SERVICE_NAME

Parameters:

query - the query to match

Returns:

the oAuth2 tokens that match the query

Throws:

NuxeoException - with 403 status code if the given principal doesn't have access to the oAuth2 tokens

garbageCollectExpiredTokens

String garbageCollectExpiredTokens()

Garbage collects expired tokens.

Returns:

the commandId

Since:

2025.1