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	APPLICATION_JSON_NXENTITY
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	checkPermission()
javax.ws.rs.core.Response	deleteProvider(String providerId, javax.servlet.http.HttpServletRequest request) Deletes an OAuth2 service provider.
protected void	deleteToken(DocumentModel token)
javax.ws.rs.core.Response	deleteToken(String providerId, String nxuser, javax.servlet.http.HttpServletRequest request) Deletes an OAuth2 Token.
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.
protected NuxeoOAuth2Token	getToken(NuxeoOAuth2ServiceProvider provider, 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) Retrieves an OAuth2 Token.
protected DocumentModel	getTokenDoc(NuxeoOAuth2ServiceProvider provider, 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()
javax.ws.rs.core.Response	updateProvider(String providerId, javax.servlet.http.HttpServletRequest request, NuxeoOAuth2ServiceProvider provider) Updates an OAuth2 service provider.
protected NuxeoOAuth2Token	updateToken(NuxeoOAuth2ServiceProvider provider, String nxuser, NuxeoOAuth2Token token)
javax.ws.rs.core.Response	updateToken(String providerId, String nxuser, javax.servlet.http.HttpServletRequest request, NuxeoOAuth2Token token) Updates an OAuth2 Token.

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

APPLICATION_JSON_NXENTITY

public static final String APPLICATION_JSON_NXENTITY

See Also:

Constant Field Values

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)
                                              throws IOException,
                                                     RestOperationException

Lists all oauth2 service providers.

Throws:

IOException

RestOperationException

Since:

9.2

getProvider

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

Retrieves oauth2 data for a given provider.

Throws:

IOException

RestOperationException

addProvider

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

Creates a new OAuth2 service provider.

Throws:

IOException

RestOperationException

Since:

9.2

updateProvider

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

Updates an OAuth2 service provider.

Throws:

IOException

RestOperationException

Since:

9.2

deleteProvider

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

Deletes an OAuth2 service provider.

Throws:

IOException

RestOperationException

Since:

9.2

getToken

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

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

Throws:

IOException

RestOperationException

getTokens

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

Retrieves all OAuth2 tokens.

Throws:

IOException

RestOperationException

Since:

9.2

getToken

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

Retrieves an OAuth2 Token.

Throws:

IOException

RestOperationException

Since:

9.2

updateToken

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

Updates an OAuth2 Token.

Throws:

IOException

RestOperationException

Since:

9.2

deleteToken

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

Deletes an OAuth2 Token.

Throws:

IOException

RestOperationException

Since:

9.2

getProviders

protected List<NuxeoOAuth2ServiceProvider> getProviders()

getProvider

protected NuxeoOAuth2ServiceProvider getProvider(String providerId)
                                          throws RestOperationException

Throws:

RestOperationException

getTokens

protected List<NuxeoOAuth2Token> getTokens()

getTokens

protected List<NuxeoOAuth2Token> getTokens(String nxuser)

getTokenDoc

protected DocumentModel getTokenDoc(NuxeoOAuth2ServiceProvider provider,
                                    String nxuser)
                             throws RestOperationException

Throws:

RestOperationException

getToken

protected NuxeoOAuth2Token getToken(NuxeoOAuth2ServiceProvider provider,
                                    String nxuser)
                             throws RestOperationException

Throws:

RestOperationException

updateToken

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

Throws:

RestOperationException

deleteToken

protected void deleteToken(DocumentModel token)
                    throws RestOperationException

Throws:

RestOperationException

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()
                        throws RestOperationException

Throws:

RestOperationException

hasPermission

protected boolean hasPermission()