com.nimbusds.openid.connect.provider.spi.reg

Interface RegistrationInterceptor

All Superinterfaces:

Lifecycle

@ThreadSafe
public interface RegistrationInterceptor
extends Lifecycle

Service Provider Interface (SPI) for intercepting and optionally modifying HTTP requests at the client registration endpoint. The loaded and enabled SPI implementation will be called when an HTTP request is received at the client registration endpoint.

An SPI implementation which requires a client X.509 certificate included in the HTTP request and successfully validated by the web server / TLS proxy can retrieve it using the HTTPRequest.getClientX509Certificate() and related methods.

Implementations must be thread-safe.

Method Summary

Modifier and Type	Method and Description
default com.nimbusds.oauth2.sdk.http.HTTPRequest	interceptDeleteRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest httpRequest, InterceptorContext interceptorCtx) Intercepts an HTTP DELETE request at the client registration endpoint.
default com.nimbusds.oauth2.sdk.http.HTTPRequest	interceptGetRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest httpRequest, InterceptorContext interceptorCtx) Intercepts an HTTP GET request at the client registration endpoint.
default com.nimbusds.oauth2.sdk.http.HTTPRequest	interceptPostRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest httpRequest, InterceptorContext interceptorCtx) Intercepts an HTTP POST request at the client registration endpoint.
default com.nimbusds.oauth2.sdk.http.HTTPRequest	interceptPutRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest httpRequest, InterceptorContext interceptorCtx) Intercepts an HTTP PUT request at the client registration endpoint.

Methods inherited from interface com.nimbusds.openid.connect.provider.spi.Lifecycle

init, isEnabled, shutdown

Method Detail

interceptPostRequest

default com.nimbusds.oauth2.sdk.http.HTTPRequest interceptPostRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest httpRequest,
                                                                      InterceptorContext interceptorCtx)
                                                               throws WrappedHTTPResponseException

Intercepts an HTTP POST request at the client registration endpoint. Passes the HTTP request unmodified by default.

Parameters:

httpRequest - The HTTP POST request.

interceptorCtx - The interceptor context.

Returns:

The HTTP POST request to pass on to the endpoint for further processing.

Throws:

WrappedHTTPResponseException - To return an HTTP (error) response immediately.

interceptGetRequest

default com.nimbusds.oauth2.sdk.http.HTTPRequest interceptGetRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest httpRequest,
                                                                     InterceptorContext interceptorCtx)
                                                              throws WrappedHTTPResponseException

Intercepts an HTTP GET request at the client registration endpoint. Passes the HTTP request unmodified by default.

Parameters:

httpRequest - The HTTP GET request.

interceptorCtx - The interceptor context.

Returns:

The HTTP GET request to pass on to the endpoint for further processing.

Throws:

WrappedHTTPResponseException - To return an HTTP (error) response immediately.

interceptPutRequest

default com.nimbusds.oauth2.sdk.http.HTTPRequest interceptPutRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest httpRequest,
                                                                     InterceptorContext interceptorCtx)
                                                              throws WrappedHTTPResponseException

Intercepts an HTTP PUT request at the client registration endpoint. Passes the HTTP request unmodified by default.

Parameters:

httpRequest - The HTTP PUT request.

interceptorCtx - The interceptor context.

Returns:

The HTTP PUT request to pass on to the endpoint for further processing.

Throws:

WrappedHTTPResponseException - To return an HTTP (error) response immediately.

interceptDeleteRequest

default com.nimbusds.oauth2.sdk.http.HTTPRequest interceptDeleteRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest httpRequest,
                                                                        InterceptorContext interceptorCtx)
                                                                 throws WrappedHTTPResponseException

Intercepts an HTTP DELETE request at the client registration endpoint. Passes the HTTP request unmodified by default.

Parameters:

httpRequest - The HTTP DELETE request.

interceptorCtx - The interceptor context.

Returns:

The HTTP DELETE request to pass on to the endpoint for further processing.

Throws:

WrappedHTTPResponseException - To return an HTTP (error) response immediately.