Package io.jans.as.server.register.ws.rs

Interface RegisterRestWebService

  • All Known Implementing Classes:
    RegisterRestWebServiceImpl
    public interface RegisterRestWebService
    Provides interface for register REST web services.
    Version:
    0.1, 01.11.2012
    Author:
    Javier Rojas Blum, Yuriy Zabrovarnyy

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      jakarta.ws.rs.core.Response delete​(String clientId, String authorization, jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.ws.rs.core.SecurityContext securityContext)
      This operation removes the Client Metadata for a previously registered client.
      jakarta.ws.rs.core.Response requestClientRead​(String clientId, String authorization, jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.ws.rs.core.SecurityContext securityContext)
      This operation retrieves the Client Metadata for a previously registered client.
      jakarta.ws.rs.core.Response requestClientUpdate​(String requestParams, String clientId, String authorization, jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.ws.rs.core.SecurityContext securityContext)
      This operation updates the Client Metadata for a previously registered client.
      jakarta.ws.rs.core.Response requestRegister​(String requestParams, jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.ws.rs.core.SecurityContext securityContext)
      In order for an OpenID Connect client to utilize OpenID services for a user, the client needs to register with the OpenID Provider to acquire a client ID and shared secret.

    • Method Detail

      • requestRegister

        @POST
@Path("/register")
@Produces("application/json")
jakarta.ws.rs.core.Response requestRegister​(String requestParams,
                                            @Context
                                            jakarta.servlet.http.HttpServletRequest httpRequest,
                                            @Context
                                            jakarta.ws.rs.core.SecurityContext securityContext)
        In order for an OpenID Connect client to utilize OpenID services for a user, the client needs to register with the OpenID Provider to acquire a client ID and shared secret.
        Parameters:
        requestParams - request parameters
        httpRequest - http request object
        securityContext - An injectable interface that provides access to security related information.
        Returns:
        response

      • requestClientUpdate

        @PUT
@Path("register")
@Produces("application/json")
jakarta.ws.rs.core.Response requestClientUpdate​(String requestParams,
                                                @QueryParam("client_id")
                                                String clientId,
                                                @HeaderParam("Authorization")
                                                String authorization,
                                                @Context
                                                jakarta.servlet.http.HttpServletRequest httpRequest,
                                                @Context
                                                jakarta.ws.rs.core.SecurityContext securityContext)
        This operation updates the Client Metadata for a previously registered client.
        Parameters:
        requestParams - request parameters
        clientId - client id
        authorization - Access Token that is used at the Client Configuration Endpoint
        httpRequest - http request object
        securityContext - An injectable interface that provides access to security related information.
        Returns:
        response

      • requestClientRead

        @GET
@Path("/register")
@Produces("application/json")
jakarta.ws.rs.core.Response requestClientRead​(@QueryParam("client_id")
                                              String clientId,
                                              @HeaderParam("Authorization")
                                              String authorization,
                                              @Context
                                              jakarta.servlet.http.HttpServletRequest httpRequest,
                                              @Context
                                              jakarta.ws.rs.core.SecurityContext securityContext)
        This operation retrieves the Client Metadata for a previously registered client.
        Parameters:
        clientId - Unique Client identifier.
        securityContext - An injectable interface that provides access to security related information.
        Returns:
        response

      • delete

        @DELETE
@Path("/register")
@Produces("application/json")
jakarta.ws.rs.core.Response delete​(@QueryParam("client_id")
                                   String clientId,
                                   @HeaderParam("Authorization")
                                   String authorization,
                                   @Context
                                   jakarta.servlet.http.HttpServletRequest httpRequest,
                                   @Context
                                   jakarta.ws.rs.core.SecurityContext securityContext)
        This operation removes the Client Metadata for a previously registered client.
        Parameters:
        clientId - Unique Client identifier.
        securityContext - An injectable interface that provides access to security related information.
        Returns:
        If a client has been successfully deprovisioned, the authorization server responds with an HTTP 204 No Content message.

        If the registration access token used to make this request is not valid, the server responds with HTTP 401 Unauthorized.

        If the client does not exist on this server, the server responds with HTTP 401 Unauthorized.

        If the client is not allowed to delete itself, the server responds with HTTP 403 Forbidden.