Package org.gluu.oxauth.register.ws.rs

Class RegisterRestWebServiceImpl

java.lang.Object

org.gluu.oxauth.register.ws.rs.RegisterRestWebServiceImpl

All Implemented Interfaces:

RegisterRestWebService

@Path("/")
public class RegisterRestWebServiceImpl
extends java.lang.Object
implements RegisterRestWebService

Implementation for register REST web services.

Version:

May 20, 2020

Author:

Javier Rojas Blum, Yuriy Zabrovarnyy, Yuriy Movchan

Constructor Summary

Constructors

Constructor	Description
RegisterRestWebServiceImpl()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	delete(java.lang.String clientId, java.lang.String authorization, javax.servlet.http.HttpServletRequest httpRequest, javax.ws.rs.core.SecurityContext securityContext)	This operation removes the Client Metadata for a previously registered client.
javax.ws.rs.core.Response	requestClientRead(java.lang.String clientId, java.lang.String authorization, javax.servlet.http.HttpServletRequest httpRequest, javax.ws.rs.core.SecurityContext securityContext)	This operation retrieves the Client Metadata for a previously registered client.
javax.ws.rs.core.Response	requestClientUpdate(java.lang.String requestParams, java.lang.String clientId, java.lang.String authorization, javax.servlet.http.HttpServletRequest httpRequest, javax.ws.rs.core.SecurityContext securityContext)	This operation updates the Client Metadata for a previously registered client.
javax.ws.rs.core.Response	requestRegister(java.lang.String requestParams, javax.servlet.http.HttpServletRequest httpRequest, javax.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisterRestWebServiceImpl

public RegisterRestWebServiceImpl()

Method Detail

requestRegister

public javax.ws.rs.core.Response requestRegister(java.lang.String requestParams,
                                                 javax.servlet.http.HttpServletRequest httpRequest,
                                                 javax.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 javax.ws.rs.core.Response requestClientUpdate(java.lang.String requestParams,
                                                     java.lang.String clientId,
                                                     @HeaderParam("Authorization")
                                                     java.lang.String authorization,
                                                     @Context
                                                     javax.servlet.http.HttpServletRequest httpRequest,
                                                     @Context
                                                     javax.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 javax.ws.rs.core.Response requestClientRead(java.lang.String clientId,
                                                   java.lang.String authorization,
                                                   javax.servlet.http.HttpServletRequest httpRequest,
                                                   javax.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 javax.ws.rs.core.Response delete(java.lang.String clientId,
                                        java.lang.String authorization,
                                        javax.servlet.http.HttpServletRequest httpRequest,
                                        javax.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.