Package org.nuxeo.ecm.platform.oauth2.clients

Class OAuth2ClientServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.oauth2.clients.OAuth2ClientServiceImpl

All Implemented Interfaces:

OAuth2ClientService, Adaptable, Component, Extensible, TimestampedService

public class OAuth2ClientServiceImpl
extends DefaultComponent
implements OAuth2ClientService

OAuth2 Client service

Since:

9.2

Field Summary

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Fields inherited from interface org.nuxeo.ecm.platform.oauth2.clients.OAuth2ClientService

OAUTH2CLIENT_DIRECTORY_NAME, OAUTH2CLIENT_SCHEMA

Constructor Summary

Constructors

Constructor	Description
OAuth2ClientServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	checkPermission(NuxeoPrincipal principal)
protected void	checkUnicity(String clientId)	Checks if a client with the clientId is unique.
OAuth2Client	create(OAuth2Client oAuth2Client, NuxeoPrincipal principal)	Registers a new oAuth2 client as the given principal.
void	delete(String clientId, NuxeoPrincipal principal)	Deletes an oAuth2 client as the given principal.
protected <T> T	execute(Function<Session,T> function)
protected <T> T	execute(Function<Session,T> function, NuxeoPrincipal principal)
OAuth2Client	getClient(String clientId)	Gets the oAuth2 client with the given client id.
protected DocumentModel	getClientModel(String clientId)
List<OAuth2Client>	getClients()	Gets all the oAuth2 clients.
protected DocumentModel	getDocument(String clientId)	Gets the document model from a given clientId
boolean	hasClient(String clientId)	Checks if an oAuth2 client with the given client id exists.
boolean	isValidClient(String clientId, String clientSecret)	Checks if the oAuth2 client with the given client id is valid regarding the given client secret.
protected List<DocumentModel>	queryClients()
OAuth2Client	update(String clientId, OAuth2Client oAuth2Client, NuxeoPrincipal principal)	Updates an exiting oAuth2 client as the given principal.
protected void	validate(OAuth2Client oAuth2Client)	Validates the OAuth2Client.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerContribution, registerExtension, setLastModified, setModifiedNow, setName, start, stop, unregister, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

applicationStarted, getApplicationStartedOrder

Constructor Detail

OAuth2ClientServiceImpl

public OAuth2ClientServiceImpl()

Method Detail

hasClient

public boolean hasClient(String clientId)

Description copied from interface: OAuth2ClientService

Checks if an oAuth2 client with the given client id exists.

Done as a privileged user.

Specified by:

hasClient in interface OAuth2ClientService

Parameters:

clientId - the client id of the oAuth2 client whose existence to check

Returns:

true if an oAuth2 client with the given client id exists, false otherwise

isValidClient

public boolean isValidClient(String clientId,
                             String clientSecret)

Description copied from interface: OAuth2ClientService

Checks if the oAuth2 client with the given client id is valid regarding the given client secret.

Done as a privileged user.

Specified by:

isValidClient in interface OAuth2ClientService

Parameters:

clientId - the client id of the oAuth2 client to validate

clientSecret - the client secret used for validation

Returns:

true if the oAuth2 client with the given client id is valid regarding the given client secret, false otherwise

getClient

public OAuth2Client getClient(String clientId)

Description copied from interface: OAuth2ClientService

Gets the oAuth2 client with the given client id.

Done as a privileged user.

Specified by:

getClient in interface OAuth2ClientService

Parameters:

clientId - the client id of the oAuth2 client to get

Returns:

the oAuth2 client with the given client id if it exists, null otherwise

getClients

public List<OAuth2Client> getClients()

Description copied from interface: OAuth2ClientService

Gets all the oAuth2 clients.

Done as a privileged user.

Specified by:

getClients in interface OAuth2ClientService

Returns:

the oAuth2 clients

create

public OAuth2Client create(OAuth2Client oAuth2Client,
                           NuxeoPrincipal principal)

Description copied from interface: OAuth2ClientService

Registers a new oAuth2 client as the given principal.

Specified by:

create in interface OAuth2ClientService

Parameters:

oAuth2Client - the OAuth2Client to register

principal - the current user

Returns:

the newly registered client

update

public OAuth2Client update(String clientId,
                           OAuth2Client oAuth2Client,
                           NuxeoPrincipal principal)

Description copied from interface: OAuth2ClientService

Updates an exiting oAuth2 client as the given principal.

Specified by:

update in interface OAuth2ClientService

Parameters:

clientId - the client id of oAuth2Client to update

oAuth2Client - the new OAuth2Client data

principal - the current user

Returns:

the updated oAuth2Client

delete

public void delete(String clientId,
                   NuxeoPrincipal principal)

Description copied from interface: OAuth2ClientService

Deletes an oAuth2 client as the given principal.

Specified by:

delete in interface OAuth2ClientService

Parameters:

clientId - the client id of the oAuth2Client to delete

principal - the current user

getClientModel

protected DocumentModel getClientModel(String clientId)

queryClients

protected List<DocumentModel> queryClients()

execute

protected <T> T execute(Function<Session,T> function)

Since:

11.1

execute

protected <T> T execute(Function<Session,T> function,
                        NuxeoPrincipal principal)

Since:

11.1

checkPermission

protected void checkPermission(NuxeoPrincipal principal)

validate

protected void validate(OAuth2Client oAuth2Client)

Validates the OAuth2Client. An OAuth2Client is valid if and only if

• It is not null
• The required fields are filled in: OAuth2Client.getId(),OAuth2Client.getName(),OAuth2Client.getRedirectURIs()
• The OAuth2Client.getRedirectURIs() is a valid URI, OAuth2Client.isRedirectURIValid(String)

Parameters:

oAuth2Client - the not null oAuth2Client to validate

Throws:

NullPointerException - if the oAuth2Client is null

NuxeoException - if oAuth2Client is not valid

Since:

11.1

checkUnicity

protected void checkUnicity(String clientId)

Checks if a client with the clientId is unique.

Parameters:

clientId - the client id to check

Throws:

NuxeoException - if an oAuth2 client with the given clientId already exists

Since:

11.1

getDocument

protected DocumentModel getDocument(String clientId)

Gets the document model from a given clientId

Parameters:

clientId - the oAuth client id

Throws:

NuxeoException - if there is no document model for the given clientId

Since:

11.1