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

Class RegisterRestWebServiceImpl

  • All Implemented Interfaces:
    RegisterRestWebService
    @Path("/")
public class RegisterRestWebServiceImpl
extends Object
implements RegisterRestWebService
    Implementation for register REST web services.
    Version:
    March 29, 2022
    Author:
    Javier Rojas Blum, Yuriy Zabrovarnyy, Yuriy Movchan

    • Method Summary

      All Methods Instance Methods Concrete 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.

    • Constructor Detail

      • RegisterRestWebServiceImpl

        public RegisterRestWebServiceImpl()

    • Method Detail

      • requestRegister

        public jakarta.ws.rs.core.Response requestRegister​(String requestParams,
                                                   jakarta.servlet.http.HttpServletRequest httpRequest,
                                                   jakarta.ws.rs.core.SecurityContext securityContext)
        Description copied from interface: RegisterRestWebService
        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.
        Specified by:
        requestRegister in interface RegisterRestWebService
        Parameters:
        requestParams - request parameters
        httpRequest - http request object
        securityContext - An injectable interface that provides access to security related information.
        Returns:
        response

      • requestClientUpdate

        public jakarta.ws.rs.core.Response requestClientUpdate​(String requestParams,
                                                       String clientId,
                                                       String authorization,
                                                       jakarta.servlet.http.HttpServletRequest httpRequest,
                                                       jakarta.ws.rs.core.SecurityContext securityContext)
        Description copied from interface: RegisterRestWebService
        This operation updates the Client Metadata for a previously registered client.
        Specified by:
        requestClientUpdate in interface RegisterRestWebService
        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

        public jakarta.ws.rs.core.Response requestClientRead​(String clientId,
                                                     String authorization,
                                                     jakarta.servlet.http.HttpServletRequest httpRequest,
                                                     jakarta.ws.rs.core.SecurityContext securityContext)
        Description copied from interface: RegisterRestWebService
        This operation retrieves the Client Metadata for a previously registered client.
        Specified by:
        requestClientRead in interface RegisterRestWebService
        Parameters:
        clientId - Unique Client identifier.
        securityContext - An injectable interface that provides access to security related information.
        Returns:
        response

      • delete

        public jakarta.ws.rs.core.Response delete​(String clientId,
                                          String authorization,
                                          jakarta.servlet.http.HttpServletRequest httpRequest,
                                          jakarta.ws.rs.core.SecurityContext securityContext)
        Description copied from interface: RegisterRestWebService
        This operation removes the Client Metadata for a previously registered client.
        Specified by:
        delete in interface RegisterRestWebService
        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.