Package org.nuxeo.ecm.restapi.server

Class OAuth2Object

java.lang.Object
org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>
org.nuxeo.ecm.restapi.server.OAuth2Object
All Implemented Interfaces:
Resource, Adaptable
public class OAuth2Object extends AbstractResource<ResourceTypeImpl>
Endpoint to retrieve OAuth2 authentication data
Since:
8.4

  • Field Details

  • Constructor Details

    • OAuth2Object

      public OAuth2Object()

  • Method Details

    • getProviders

      @GET @Path("provider") public List<NuxeoOAuth2ServiceProvider> getProviders(@Context jakarta.servlet.http.HttpServletRequest request)
      Lists all oauth2 service providers.
      Since:
      9.2

    • getProvider

      @GET @Path("provider/{providerId}") public jakarta.ws.rs.core.Response getProvider(@PathParam("providerId") String providerId, @Context jakarta.servlet.http.HttpServletRequest request)
      Retrieves oauth2 data for a given provider.

    • addProvider

      @POST @Path("provider") @Consumes("application/json") public jakarta.ws.rs.core.Response addProvider(@Context jakarta.servlet.http.HttpServletRequest request, NuxeoOAuth2ServiceProvider provider)
      Creates a new OAuth2 service provider.
      Since:
      9.2

    • updateProvider

      @PUT @Path("provider/{providerId}") @Consumes("application/json") public jakarta.ws.rs.core.Response updateProvider(@PathParam("providerId") String providerId, @Context jakarta.servlet.http.HttpServletRequest request, NuxeoOAuth2ServiceProvider provider)
      Updates an OAuth2 service provider.
      Since:
      9.2

    • deleteProvider

      @DELETE @Path("provider/{providerId}") public jakarta.ws.rs.core.Response deleteProvider(@PathParam("providerId") String providerId, @Context jakarta.servlet.http.HttpServletRequest request)
      Deletes an OAuth2 service provider.
      Since:
      9.2

    • getToken

      @GET @Path("provider/{providerId}/token") public jakarta.ws.rs.core.Response getToken(@PathParam("providerId") String providerId, @Context jakarta.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

      @GET @Path("token") public List<NuxeoOAuth2Token> getTokens(@Context jakarta.servlet.http.HttpServletRequest request)
      Retrieves all OAuth2 tokens.
      Since:
      9.2

    • getTokens

      @GET @Path("token/{type}") public List<NuxeoOAuth2Token> getTokens(@PathParam("type") NuxeoOAuth2TokenType type)
      Retrieves all oAuth2 tokens by NuxeoOAuth2TokenType.
      Parameters:
      type - , the value of NuxeoOAuth2TokenType
      Returns:
      if type is NuxeoOAuth2TokenType.AS_PROVIDER, then we retrieve tokens that are provided by Nuxeo, otherwise those used by Nuxeo to connect to others applications
      Since:
      11.1

    • searchTokens

      @GET @Path("token/search") public List<NuxeoOAuth2Token> searchTokens(@QueryParam("q") String query)
      Search all oAuth2 tokens that match the query.
      Parameters:
      query - the query to match
      Since:
      11.1

    • getProviderToken

      @GET @Path("token/provider/{providerId}/user/{nxuser}") public jakarta.ws.rs.core.Response getProviderToken(@PathParam("providerId") String providerId, @PathParam("nxuser") String nxuser, @Context jakarta.servlet.http.HttpServletRequest request)
      Retrieves an OAuth2 provider token.
      Since:
      10.2

    • updateProviderToken

      @PUT @Path("token/provider/{providerId}/user/{nxuser}") @Consumes("application/json") public jakarta.ws.rs.core.Response updateProviderToken(@PathParam("providerId") String providerId, @PathParam("nxuser") String nxuser, @Context jakarta.servlet.http.HttpServletRequest request, NuxeoOAuth2Token token)
      Updates an OAuth2 provider token.
      Since:
      10.2

    • deleteProviderToken

      @DELETE @Path("token/provider/{providerId}/user/{nxuser}") public jakarta.ws.rs.core.Response deleteProviderToken(@PathParam("providerId") String providerId, @PathParam("nxuser") String nxuser, @Context jakarta.servlet.http.HttpServletRequest request)
      Deletes an OAuth2 provider token.
      Since:
      10.2

    • getProviderUserTokens

      @GET @Path("token/provider") public List<NuxeoOAuth2Token> getProviderUserTokens(@Context jakarta.servlet.http.HttpServletRequest request)
      Retrieves all oauth2 provider tokens for the current user.
      Since:
      10.2

    • getClientUserTokens

      @GET @Path("token/client") public List<NuxeoOAuth2Token> getClientUserTokens(@Context jakarta.servlet.http.HttpServletRequest request)
      Retrieves all oauth2 client tokens for the current user.
      Since:
      10.2

    • getClientToken

      @GET @Path("token/client/{clientId}/user/{nxuser}") public jakarta.ws.rs.core.Response getClientToken(@PathParam("clientId") String clientId, @PathParam("nxuser") String nxuser, @Context jakarta.servlet.http.HttpServletRequest request)
      Retrieves a oauth2 client token.
      Since:
      10.2

    • updateClientToken

      @PUT @Path("token/client/{clientId}/user/{nxuser}") @Consumes("application/json") public jakarta.ws.rs.core.Response updateClientToken(@PathParam("clientId") String clientId, @PathParam("nxuser") String nxuser, @Context jakarta.servlet.http.HttpServletRequest request, NuxeoOAuth2Token token)
      Updates an OAuth2 client token.
      Since:
      10.2

    • deleteClientToken

      @DELETE @Path("token/client/{clientId}/user/{nxuser}") public jakarta.ws.rs.core.Response deleteClientToken(@PathParam("clientId") String clientId, @PathParam("nxuser") String nxuser, @Context jakarta.servlet.http.HttpServletRequest request)
      Deletes a oauth2 client token.
      Since:
      10.2

    • getClients

      @GET @Path("client") public List<OAuth2Client> getClients(@Context jakarta.servlet.http.HttpServletRequest request)
      Retrieves oauth2 clients.
      Since:
      10.2

    • getClient

      @GET @Path("client/{clientId}") public jakarta.ws.rs.core.Response getClient(@PathParam("clientId") String clientId, @Context jakarta.servlet.http.HttpServletRequest request)
      Retrieves a oauth2 client.
      Since:
      10.2

    • createClient

      @POST @Path("client") @Consumes("application/json") @Produces("application/json") public jakarta.ws.rs.core.Response createClient(OAuth2Client client)
      Creates a new oauth2 client.
      Parameters:
      client - the oAuth2Client to create
      Returns:
      the Response
      Since:
      11.1

    • updateClient

      @PUT @Path("client/{clientId}") @Consumes("application/json") @Produces("application/json") public jakarta.ws.rs.core.Response updateClient(@PathParam("clientId") String clientId, OAuth2Client client)
      Updates the oauth2 client.
      Parameters:
      clientId - the oAuth2 client id to update
      client - the oAuth2Client to update
      Returns:
      the Response
      Since:
      11.1

    • deleteClient

      @DELETE @Path("client/{clientId}") public jakarta.ws.rs.core.Response deleteClient(@PathParam("clientId") String clientId)
      Deletes the oauth2 client.
      Parameters:
      clientId - the oAuth2 client id to delete
      Returns:
      the Response
      Since:
      11.1

    • getProviders

      protected List<NuxeoOAuth2ServiceProvider> getProviders()

    • getProvider

      protected NuxeoOAuth2ServiceProvider getProvider(String providerId)

    • getTokens

      @Deprecated(since="11.1", forRemoval=true) protected List<NuxeoOAuth2Token> getTokens()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 11.1. Use OAuth2TokenService.getTokens(NuxeoPrincipal) instead.

    • getTokens

      @Deprecated(since="11.1", forRemoval=true) protected List<NuxeoOAuth2Token> getTokens(String nxuser)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 11.1. Use OAuth2TokenService.getTokens(String) instead.

    • 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 jakarta.ws.rs.core.Response buildResponse(jakarta.ws.rs.core.Response.StatusType status, Object obj) throws IOException
      Throws:
      IOException

    • checkPermission

      protected void checkPermission()

    • checkPermission

      protected void checkPermission(String nxuser)

    • checkNotAnonymousUser

      protected void checkNotAnonymousUser()

    • getPrincipal

      protected NuxeoPrincipal getPrincipal()