Package org.forgerock.openig.fapi.apiclient.service

Interface ApiClientService

All Known Implementing Classes:

IdmApiClientService

public interface ApiClientService

Service which handles CRUD operations for ApiClient objects for a particular data store.

ApiClient objects are created during the OAuth2.0 Dynamic Client Registration (DCR) process.

Method Summary

Modifier and Type	Method	Description
Promise<ApiClient,ApiClientServiceException>	create(Context context, String oAuth2ClientId, SoftwareStatement softwareStatement)	Creates an ApiClient using a SoftwareStatement provides as part of the DCR request.
Promise<ApiClient,ApiClientServiceException>	delete(Context context, String oAuth2ClientId)	Deletes an ApiClient.
Promise<ApiClient,ApiClientServiceException>	get(Context context, String oAuth2ClientId)	Gets an ApiClient.
Promise<ApiClient,ApiClientServiceException>	update(Context context, String oAuth2ClientId, SoftwareStatement softwareStatement)	Updates an ApiClient using DCR data.

Method Details

create

Promise<ApiClient,ApiClientServiceException> create(Context context,
 String oAuth2ClientId,
 SoftwareStatement softwareStatement)

Creates an ApiClient using a SoftwareStatement provides as part of the DCR request.

Parameters:

context - the current context within which the operation is being performed

oAuth2ClientId - the OAuth2.0 client_id from the DCR response

softwareStatement - the SoftwareStatement used in the DCR request used to create the OAuth2.0 client

Returns:

Promise which either returns the created ApiClient or an ApiClientServiceException if an error occurs.

get

Promise<ApiClient,ApiClientServiceException> get(Context context,
 String oAuth2ClientId)

Gets an ApiClient.

Parameters:

context - the current context within which the operation is being performed

oAuth2ClientId - the OAuth2.0 client_id of the ApiClient

Returns:

Promise which either returns the ApiClient or an ApiClientServiceException if an error occurs.

update

Promise<ApiClient,ApiClientServiceException> update(Context context,
 String oAuth2ClientId,
 SoftwareStatement softwareStatement)

Updates an ApiClient using DCR data.

Parameters:

context - the current context within which the operation is being performed

oAuth2ClientId - the OAuth2.0 client_id from the DCR response

softwareStatement - the SoftwareStatement used in the DCR request used to create the OAuth2.0 client

Returns:

Promise which either returns the updated ApiClient or an ApiClientServiceException if an error occurs.

delete

Promise<ApiClient,ApiClientServiceException> delete(Context context,
 String oAuth2ClientId)

Deletes an ApiClient.

Parameters:

context - the current context within which the operation is being performed

oAuth2ClientId - the OAuth2.0 client_id of the ApiClient

Returns:

Promise which either returns the deleted ApiClient or an ApiClientServiceException if an error occurs.