Package com.pingidentity.sdk.oauth20.registration

Interface DynamicClientRegistrationPlugin

All Superinterfaces:
ConfigurablePlugin, DescribablePlugin, Plugin
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.

Since:
9.0

  • Field Details

    • IN_PARAMETER_NAME_REQUEST_BODY

      static final String IN_PARAMETER_NAME_REQUEST_BODY
      The input parameter name for the HTTP request body in the "inParameters" map. The value is a String.
      See Also:

    • IN_PARAMETER_NAME_REQUEST_CONTENT_TYPE

      static final String IN_PARAMETER_NAME_REQUEST_CONTENT_TYPE
      The input parameter name for the HTTP request content type in the "inParameters" map. The value is a String.
      See Also:

  • Method Details

    • processPlugin

      @Deprecated(since="13.1", forRemoval=true) default void processPlugin(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DynamicClient dynamicClient, Map<String,Object> inParameters) throws ClientRegistrationException
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method is invoked in policy processing of Dynamic Client Registration.
      Parameters:
      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.
      Throws:
      ClientRegistrationException - An exception indicating an unsuccessful client registration.
      Since:
      9.0

    • processPlugin

      default void processPlugin(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, DynamicClient dynamicClient, Map<String,Object> inParameters) throws ClientRegistrationException
      This method is invoked in policy processing of Dynamic Client Registration.
      Parameters:
      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.
      Throws:
      ClientRegistrationException - An exception indicating an unsuccessful client registration.
      Since:
      13.1

    • processPluginGet

      @Deprecated(since="13.1", forRemoval=true) default void processPluginGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DynamicClient existingDynamicClient, Map<String,Object> inParameters) throws ClientRegistrationException
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method is invoked in policy processing of Dynamic Client Registration Management get.
      Parameters:
      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.
      existingDynamicClient - An object representing the client as it exists at the time of the get request.
      inParameters - A map containing a set of input parameters. Available input parameters are prefixed with IN_PARAMETER_NAME_* in this interface.
      Throws:
      ClientRegistrationException - An exception indicating an unsuccessful client get.
      Since:
      10.1

    • processPluginGet

      default void processPluginGet(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, DynamicClient existingDynamicClient, Map<String,Object> inParameters) throws ClientRegistrationException
      This method is invoked in policy processing of Dynamic Client Registration Management get.
      Parameters:
      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.
      existingDynamicClient - An object representing the client as it exists at the time of the get request.
      inParameters - A map containing a set of input parameters. Available input parameters are prefixed with IN_PARAMETER_NAME_* in this interface.
      Throws:
      ClientRegistrationException - An exception indicating an unsuccessful client get.
      Since:
      13.1

    • processPluginUpdate

      @Deprecated(since="13.1", forRemoval=true) default void processPluginUpdate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DynamicClient dynamicClient, DynamicClient existingDynamicClient, Map<String,Object> inParameters) throws ClientRegistrationException
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 13.1, use processPluginUpdate(HttpServletRequest, HttpServletResponse, DynamicClient, DynamicClient, Map) instead.
      This method is invoked in policy processing of Dynamic Client Registration Management update.
      Parameters:
      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 updated. Implementations can modify the values within this object to manipulate the client before it is updated.
      existingDynamicClient - An object representing the client as it exists before the update request. Implementations can use the values within this object to manipulate the dynamicClient before it is updated.
      inParameters - A map containing a set of input parameters. Available input parameters are prefixed with IN_PARAMETER_NAME_* in this interface.
      Throws:
      ClientRegistrationException - An exception indicating an unsuccessful client update.
      Since:
      10.1

    • processPluginUpdate

      default void processPluginUpdate(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, DynamicClient dynamicClient, DynamicClient existingDynamicClient, Map<String,Object> inParameters) throws ClientRegistrationException
      This method is invoked in policy processing of Dynamic Client Registration Management update.
      Parameters:
      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 updated. Implementations can modify the values within this object to manipulate the client before it is updated.
      existingDynamicClient - An object representing the client as it exists before the update request. Implementations can use the values within this object to manipulate the dynamicClient before it is updated.
      inParameters - A map containing a set of input parameters. Available input parameters are prefixed with IN_PARAMETER_NAME_* in this interface.
      Throws:
      ClientRegistrationException - An exception indicating an unsuccessful client update.
      Since:
      13.1

    • processPluginDelete

      @Deprecated(since="13.1", forRemoval=true) default void processPluginDelete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DynamicClient existingDynamicClient, Map<String,Object> inParameters) throws ClientRegistrationException
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 13.1, use processPluginDelete(HttpServletRequest, HttpServletResponse, DynamicClient, Map) instead.
      This method is invoked in policy processing of Dynamic Client Registration Management delete.
      Parameters:
      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.
      existingDynamicClient - An object representing the client as it exists before the delete request. Implementations can use the values within this object to do preprocessing logic before the delete.
      inParameters - A map containing a set of input parameters. Available input parameters are prefixed with IN_PARAMETER_NAME_* in this interface.
      Throws:
      ClientRegistrationException - An exception indicating an unsuccessful client delete.
      Since:
      10.1

    • processPluginDelete

      default void processPluginDelete(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, DynamicClient existingDynamicClient, Map<String,Object> inParameters) throws ClientRegistrationException
      This method is invoked in policy processing of Dynamic Client Registration Management delete.
      Parameters:
      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.
      existingDynamicClient - An object representing the client as it exists before the delete request. Implementations can use the values within this object to do preprocessing logic before the delete.
      inParameters - A map containing a set of input parameters. Available input parameters are prefixed with IN_PARAMETER_NAME_* in this interface.
      Throws:
      ClientRegistrationException - An exception indicating an unsuccessful client delete.
      Since:
      13.1