Package org.forgerock.openig.fapi.apiclient

Class ApiClient.ApiClientBuilder

java.lang.Object

org.forgerock.openig.fapi.apiclient.ApiClient.ApiClientBuilder

Enclosing class:

ApiClient

public static final class ApiClient.ApiClientBuilder
extends Object

Builder of ApiClient objects.

Method Summary

Modifier and Type	Method	Description
ApiClient	build()	Builds an ApiClient.
ApiClient.ApiClientBuilder	clientName(String clientName)	Set the clientName.
ApiClient.ApiClientBuilder	deleted(boolean deleted)	Set the deleted flag.
ApiClient.ApiClientBuilder	oAuth2ClientId(String oAuth2ClientId)	Set the oAuth2ClientId value.
ApiClient.ApiClientBuilder	organisation(ApiClientOrganisation organisation)	Set the client's organisation.
ApiClient.ApiClientBuilder	roles(List<String> roles)	Set the client's roles.
ApiClient.ApiClientBuilder	softwareId(String softwareId)	Set the softwareId.
ApiClient.ApiClientBuilder	softwareStatementAssertion(SignedJwt softwareStatementAssertion)	Set the softwareStatementAssertion.
ApiClient.ApiClientBuilder	withEmbeddedJwksSupplier(JWKSet jwkSet)	Configure the JWKS with an embedded JWKSet.
ApiClient.ApiClientBuilder	withJwkSetSecretStore(JwkSetSecretStore jwkSetSecretStore)	Configure the JWKS with a remote JWKSet, using a JwkSetSecretStore.
ApiClient.ApiClientBuilder	withUriJwksSupplier(URI jwksUri, JwkSetService jwkSetService)	Configure the JWKS with a remote JWKSet, using the JwkSetService to obtain the JwkSetSecretStore for the jwks_uri.

Methods inherited from class java.lang.Object

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

Method Details

oAuth2ClientId

public ApiClient.ApiClientBuilder oAuth2ClientId(String oAuth2ClientId)

Set the oAuth2ClientId value.

Parameters:

oAuth2ClientId - the client's OAuth2.0 client_id

Returns:

the builder

softwareId

public ApiClient.ApiClientBuilder softwareId(String softwareId)

Set the softwareId.

Parameters:

softwareId - the software_id of the software being used by the client

Returns:

the builder

clientName

public ApiClient.ApiClientBuilder clientName(String clientName)

Set the clientName.

Parameters:

clientName - the name of the client

Returns:

the builder

withEmbeddedJwksSupplier

public ApiClient.ApiClientBuilder withEmbeddedJwksSupplier(JWKSet jwkSet)

Configure the JWKS with an embedded JWKSet.

Parameters:

jwkSet - the JWKSet for the supplier to return

Returns:

the builder

withUriJwksSupplier

public ApiClient.ApiClientBuilder withUriJwksSupplier(URI jwksUri,
 JwkSetService jwkSetService)

Configure the JWKS with a remote JWKSet, using the JwkSetService to obtain the JwkSetSecretStore for the jwks_uri.

Parameters:

jwksUri - the location of the JWKSet

jwkSetService - the service to use to retrieve the JWKSet

Returns:

the builder

withJwkSetSecretStore

public ApiClient.ApiClientBuilder withJwkSetSecretStore(JwkSetSecretStore jwkSetSecretStore)

Configure the JWKS with a remote JWKSet, using a JwkSetSecretStore. This provides support for a preconfigured JwkSetSecretStore, with options provided.

Parameters:

jwkSetSecretStore - the JwkSetSecretStore to use to retrieve the JWKSet

Returns:

the builder

softwareStatementAssertion

public ApiClient.ApiClientBuilder softwareStatementAssertion(SignedJwt softwareStatementAssertion)

Set the softwareStatementAssertion.

Parameters:

softwareStatementAssertion - the SignedJwt representation of the software statement used during registration

Returns:

the builder

organisation

public ApiClient.ApiClientBuilder organisation(ApiClientOrganisation organisation)

Set the client's organisation.

Parameters:

organisation - the ApiClientOrganisation that this client belongs to

Returns:

the builder

deleted

public ApiClient.ApiClientBuilder deleted(boolean deleted)

Set the deleted flag.

Parameters:

deleted - flag indicating if ApiClient has been soft deleted in datastore.

Returns:

the builder

roles

public ApiClient.ApiClientBuilder roles(List<String> roles)

Set the client's roles.

Parameters:

roles - the roles that the client is authorized to perform

Returns:

the builder

build

public ApiClient build()

Builds an ApiClient.

Returns:

the ApiClient