public interface DynamicClientRegistrationPlugin extends Plugin
This interface defines the methods that PingFederate calls when performing policy processing for OAuth 2.0 Dynamic Client Registration.
See ConfigurablePlugin
for methods that need to be implemented to handle plugin configuration.
Modifier and Type | Field and Description |
---|---|
static String |
IN_PARAMETER_NAME_REQUEST_BODY
The input parameter name for the HTTP request body in the "inParameters" map.
|
static String |
IN_PARAMETER_NAME_REQUEST_CONTENT_TYPE
The input parameter name for the HTTP request content type in the "inParameters" map.
|
Modifier and Type | Method and Description |
---|---|
void |
processPlugin(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
DynamicClient dynamicClient,
Map<String,Object> inParameters)
This method is invoked in policy processing of Dynamic Client Registration.
|
configure
getPluginDescriptor
static final String IN_PARAMETER_NAME_REQUEST_BODY
String
.static final String IN_PARAMETER_NAME_REQUEST_CONTENT_TYPE
String
.void processPlugin(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DynamicClient dynamicClient, Map<String,Object> inParameters) throws ClientRegistrationException
request
- HttpServletRequest object that can be used to read cookies, parameters and headers. It may
be used to find out more about the request such as the full URL the request was made to.
Accessing the HttpSession from the request is not recommended. SessionStateSupport
may be used as an alternative.response
- HttpServletResponse object.dynamicClient
- An object representing the client to be registered. Implementations can modify the values
within this object to manipulate the client before it is registered.inParameters
- A map containing a set of input parameters. Available input parameters are prefixed with
IN_PARAMETER_NAME_*
in this interface.ClientRegistrationException
- An exception indicating an unsuccessful client registration.Copyright 2019 Ping Identity Corp. All rights reserved.