org.nuxeo.ecm.restapi.server.jaxrs

Class OAuth2Object

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.restapi.server.jaxrs.OAuth2Object

All Implemented Interfaces:

Resource, Adaptable

public class OAuth2Object
extends AbstractResource<ResourceTypeImpl>

Endpoint to retrieve OAuth2 authentication data

Since:

8.4

Field Summary

Fields

Modifier and Type	Field and Description
static String	TOKEN_DIR

Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor and Description
OAuth2Object()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addProvider(javax.servlet.http.HttpServletRequest request, NuxeoOAuth2ServiceProvider provider) Creates a new OAuth2 service provider.
protected javax.ws.rs.core.Response	buildResponse(javax.ws.rs.core.Response.StatusType status, Object obj)
protected void	checkNotAnonymousUser()
protected void	checkPermission(String nxuser)
javax.ws.rs.core.Response	deleteClientToken(String clientId, String nxuser, javax.servlet.http.HttpServletRequest request) Deletes a oauth2 client token.
javax.ws.rs.core.Response	deleteProvider(String providerId, javax.servlet.http.HttpServletRequest request) Deletes an OAuth2 service provider.
javax.ws.rs.core.Response	deleteProviderToken(String providerId, String nxuser, javax.servlet.http.HttpServletRequest request) Deletes an OAuth2 provider token.
protected void	deleteToken(DocumentModel token)
javax.ws.rs.core.Response	deleteToken(String providerId, String nxuser, javax.servlet.http.HttpServletRequest request) Deprecated. since 10.2 Use deleteProviderToken(String, String, HttpServletRequest) instead.
protected OAuth2Client	getClient(String clientId)
javax.ws.rs.core.Response	getClient(String clientId, javax.servlet.http.HttpServletRequest request) Retrieves a oauth2 client.
List<OAuth2Client>	getClients(javax.servlet.http.HttpServletRequest request) Retrieves oauth2 clients.
javax.ws.rs.core.Response	getClientToken(String clientId, String nxuser, javax.servlet.http.HttpServletRequest request) Retrieves a oauth2 client token.
List<NuxeoOAuth2Token>	getClientUserTokens(javax.servlet.http.HttpServletRequest request) Retrieves all oauth2 client tokens for the current user.
protected com.google.api.client.auth.oauth2.Credential	getCredential(NuxeoOAuth2ServiceProvider provider, NuxeoOAuth2Token token)
protected NuxeoOAuth2ServiceProvider	getProvider(String providerId)
javax.ws.rs.core.Response	getProvider(String providerId, javax.servlet.http.HttpServletRequest request) Retrieves oauth2 data for a given provider.
protected List<NuxeoOAuth2ServiceProvider>	getProviders()
List<NuxeoOAuth2ServiceProvider>	getProviders(javax.servlet.http.HttpServletRequest request) Lists all oauth2 service providers.
javax.ws.rs.core.Response	getProviderToken(String providerId, String nxuser, javax.servlet.http.HttpServletRequest request) Retrieves an OAuth2 provider token.
List<NuxeoOAuth2Token>	getProviderUserTokens(javax.servlet.http.HttpServletRequest request) Retrieves all oauth2 provider tokens for the current user.
protected NuxeoOAuth2Token	getToken(NuxeoOAuth2ServiceProvider provider, String nxuser)
protected NuxeoOAuth2Token	getToken(OAuth2Client client, String nxuser)
javax.ws.rs.core.Response	getToken(String providerId, javax.servlet.http.HttpServletRequest request) Retrieves a valid access token for a given provider and the current user.
javax.ws.rs.core.Response	getToken(String providerId, String nxuser, javax.servlet.http.HttpServletRequest request) Deprecated. since 10.2 Use getProviderToken(String, String, HttpServletRequest) instead.
protected DocumentModel	getTokenDoc(NuxeoOAuth2ServiceProvider provider, String nxuser)
protected DocumentModel	getTokenDoc(OAuth2Client client, String nxuser)
protected List<NuxeoOAuth2Token>	getTokens()
List<NuxeoOAuth2Token>	getTokens(javax.servlet.http.HttpServletRequest request) Retrieves all OAuth2 tokens.
protected List<NuxeoOAuth2Token>	getTokens(String nxuser)
protected boolean	hasPermission(String nxuser)
javax.ws.rs.core.Response	updateClientToken(String clientId, String nxuser, javax.servlet.http.HttpServletRequest request, NuxeoOAuth2Token token) Updates an OAuth2 client token.
javax.ws.rs.core.Response	updateProvider(String providerId, javax.servlet.http.HttpServletRequest request, NuxeoOAuth2ServiceProvider provider) Updates an OAuth2 service provider.
javax.ws.rs.core.Response	updateProviderToken(String providerId, String nxuser, javax.servlet.http.HttpServletRequest request, NuxeoOAuth2Token token) Updates an OAuth2 provider token.
protected NuxeoOAuth2Token	updateToken(NuxeoOAuth2ServiceProvider provider, String nxuser, NuxeoOAuth2Token token)
protected NuxeoOAuth2Token	updateToken(OAuth2Client client, String nxuser, NuxeoOAuth2Token token)
javax.ws.rs.core.Response	updateToken(String providerId, String nxuser, javax.servlet.http.HttpServletRequest request, NuxeoOAuth2Token token) Deprecated. since 10.2 Use updateProviderToken(String, String, HttpServletRequest, NuxeoOAuth2Token) instead.
protected void	updateTokenDoc(NuxeoOAuth2Token token, DocumentModel entry)

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, initialize, isAdapter, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_DIR

public static final String TOKEN_DIR

See Also:

Constant Field Values

Constructor Detail

OAuth2Object

public OAuth2Object()

Method Detail

getProviders

public List<NuxeoOAuth2ServiceProvider> getProviders(@Context
                                                     javax.servlet.http.HttpServletRequest request)

Lists all oauth2 service providers.

Since:

9.2

getProvider

public javax.ws.rs.core.Response getProvider(String providerId,
                                             @Context
                                             javax.servlet.http.HttpServletRequest request)

Retrieves oauth2 data for a given provider.

addProvider

public javax.ws.rs.core.Response addProvider(@Context
                                             javax.servlet.http.HttpServletRequest request,
                                             NuxeoOAuth2ServiceProvider provider)

Creates a new OAuth2 service provider.

Since:

9.2

updateProvider

public javax.ws.rs.core.Response updateProvider(String providerId,
                                                @Context
                                                javax.servlet.http.HttpServletRequest request,
                                                NuxeoOAuth2ServiceProvider provider)

Updates an OAuth2 service provider.

Since:

9.2

deleteProvider

public javax.ws.rs.core.Response deleteProvider(String providerId,
                                                @Context
                                                javax.servlet.http.HttpServletRequest request)

Deletes an OAuth2 service provider.

Since:

9.2

getToken

public javax.ws.rs.core.Response getToken(String providerId,
                                          @Context
                                          javax.servlet.http.HttpServletRequest request)
                                   throws IOException

Retrieves a valid access token for a given provider and the current user. If expired, the token will be refreshed.

Throws:

IOException

getTokens

public List<NuxeoOAuth2Token> getTokens(@Context
                                        javax.servlet.http.HttpServletRequest request)

Retrieves all OAuth2 tokens.

Since:

9.2

getProviderToken

public javax.ws.rs.core.Response getProviderToken(String providerId,
                                                  String nxuser,
                                                  @Context
                                                  javax.servlet.http.HttpServletRequest request)

Retrieves an OAuth2 provider token.

Since:

10.2

getToken

@Deprecated
public javax.ws.rs.core.Response getToken(String providerId,
                                                      String nxuser,
                                                      @Context
                                                      javax.servlet.http.HttpServletRequest request)

Deprecated. since 10.2 Use getProviderToken(String, String, HttpServletRequest) instead.

Retrieves an OAuth2 Token.

Since:

9.2

updateProviderToken

public javax.ws.rs.core.Response updateProviderToken(String providerId,
                                                     String nxuser,
                                                     @Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     NuxeoOAuth2Token token)

Updates an OAuth2 provider token.

Since:

10.2

updateToken

@Deprecated
public javax.ws.rs.core.Response updateToken(String providerId,
                                                         String nxuser,
                                                         @Context
                                                         javax.servlet.http.HttpServletRequest request,
                                                         NuxeoOAuth2Token token)

Deprecated. since 10.2 Use updateProviderToken(String, String, HttpServletRequest, NuxeoOAuth2Token) instead.

Updates an OAuth2 Token.

Since:

9.2

deleteProviderToken

public javax.ws.rs.core.Response deleteProviderToken(String providerId,
                                                     String nxuser,
                                                     @Context
                                                     javax.servlet.http.HttpServletRequest request)

Deletes an OAuth2 provider token.

Since:

10.2

deleteToken

@Deprecated
public javax.ws.rs.core.Response deleteToken(String providerId,
                                                         String nxuser,
                                                         @Context
                                                         javax.servlet.http.HttpServletRequest request)

Deprecated. since 10.2 Use deleteProviderToken(String, String, HttpServletRequest) instead.

Deletes an OAuth2 Token.

Since:

9.2

getProviderUserTokens

public List<NuxeoOAuth2Token> getProviderUserTokens(@Context
                                                    javax.servlet.http.HttpServletRequest request)

Retrieves all oauth2 provider tokens for the current user.

Since:

10.2

getClientUserTokens

public List<NuxeoOAuth2Token> getClientUserTokens(@Context
                                                  javax.servlet.http.HttpServletRequest request)

Retrieves all oauth2 client tokens for the current user.

Since:

10.2

getClientToken

public javax.ws.rs.core.Response getClientToken(String clientId,
                                                String nxuser,
                                                @Context
                                                javax.servlet.http.HttpServletRequest request)

Retrieves a oauth2 client token.

Since:

10.2

updateClientToken

public javax.ws.rs.core.Response updateClientToken(String clientId,
                                                   String nxuser,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   NuxeoOAuth2Token token)

Updates an OAuth2 client token.

Since:

10.2

deleteClientToken

public javax.ws.rs.core.Response deleteClientToken(String clientId,
                                                   String nxuser,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest request)

Deletes a oauth2 client token.

Since:

10.2

getClients

public List<OAuth2Client> getClients(@Context
                                     javax.servlet.http.HttpServletRequest request)

Retrieves oauth2 clients.

Since:

10.2

getClient

public javax.ws.rs.core.Response getClient(String clientId,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request)

Retrieves a oauth2 client.

Since:

10.2

getProviders

protected List<NuxeoOAuth2ServiceProvider> getProviders()

getProvider

protected NuxeoOAuth2ServiceProvider getProvider(String providerId)

getTokens

protected List<NuxeoOAuth2Token> getTokens()

getTokens

protected List<NuxeoOAuth2Token> getTokens(String nxuser)

getClient

protected OAuth2Client getClient(String clientId)

getTokenDoc

protected DocumentModel getTokenDoc(NuxeoOAuth2ServiceProvider provider,
                                    String nxuser)

getTokenDoc

protected DocumentModel getTokenDoc(OAuth2Client client,
                                    String nxuser)

getToken

protected NuxeoOAuth2Token getToken(NuxeoOAuth2ServiceProvider provider,
                                    String nxuser)

getToken

protected NuxeoOAuth2Token getToken(OAuth2Client client,
                                    String nxuser)

updateToken

protected NuxeoOAuth2Token updateToken(NuxeoOAuth2ServiceProvider provider,
                                       String nxuser,
                                       NuxeoOAuth2Token token)

updateToken

protected NuxeoOAuth2Token updateToken(OAuth2Client client,
                                       String nxuser,
                                       NuxeoOAuth2Token token)

updateTokenDoc

protected void updateTokenDoc(NuxeoOAuth2Token token,
                              DocumentModel entry)

deleteToken

protected void deleteToken(DocumentModel token)

getCredential

protected com.google.api.client.auth.oauth2.Credential getCredential(NuxeoOAuth2ServiceProvider provider,
                                                                     NuxeoOAuth2Token token)

buildResponse

protected javax.ws.rs.core.Response buildResponse(javax.ws.rs.core.Response.StatusType status,
                                                  Object obj)
                                           throws IOException

Throws:

IOException

checkPermission

protected void checkPermission(String nxuser)

hasPermission

protected boolean hasPermission(String nxuser)

checkNotAnonymousUser

protected void checkNotAnonymousUser()