Package swiss.trustbroker.api.idm.dto

Class IdmProvisioningRequest.IdmProvisioningRequestBuilder

java.lang.Object

swiss.trustbroker.api.idm.dto.IdmProvisioningRequest.IdmProvisioningRequestBuilder

Enclosing class:

IdmProvisioningRequest

public static class IdmProvisioningRequest.IdmProvisioningRequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
IdmProvisioningRequest.IdmProvisioningRequestBuilder	accountSource(String accountSource)	The account source from CP config
IdmProvisioningRequest.IdmProvisioningRequestBuilder	additionalData(Map<Object,Object> additionalData)	This is not provided directly by the XTB core code, but is resulting from other custom interface implementations.
IdmProvisioningRequest	build()
IdmProvisioningRequest.IdmProvisioningRequestBuilder	cpAttributes(Map<? extends AttributeName,List<String>> cpAttributes)	Map of attributes received from the CP, to be provisioned in the IDM (not null, not modifiable).
IdmProvisioningRequest.IdmProvisioningRequestBuilder	cpAuthenticationQoa(Integer cpAuthenticationQoa)	Quality of authentication provided by CP, mapped to the XTB order model.
IdmProvisioningRequest.IdmProvisioningRequestBuilder	cpSubjectNameId(String cpSubjectNameId)	The subject name ID returned by the CP.
IdmProvisioningRequest.IdmProvisioningRequestBuilder	homeName(String homeName)	The name in the IDM as filtering parameter for the IDM.
IdmProvisioningRequest.IdmProvisioningRequestBuilder	homeNameMigrationAlias(String homeNameMigrationAlias)	Used for provisioning during migration from a CP to another.
IdmProvisioningRequest.IdmProvisioningRequestBuilder	identifyingClaim(AttributeName identifyingClaim)	Claim to address the user in the IDM (not null).
IdmProvisioningRequest.IdmProvisioningRequestBuilder	idmAttributes(Map<? extends AttributeName,List<String>> idmAttributes)	Map of attributes received from the IDM (not null, not modifiable).
IdmProvisioningRequest.IdmProvisioningRequestBuilder	logOnly(boolean logOnly)	If true, provisioning changes are only logged, not applied.
IdmProvisioningRequest.IdmProvisioningRequestBuilder	modes(List<String> modes)	Provisioning mode flags specific to implementations.
IdmProvisioningRequest.IdmProvisioningRequestBuilder	provisioningAttributes(List<? extends AttributeName> provisioningAttributes)	List of attributes to provision.
IdmProvisioningRequest.IdmProvisioningRequestBuilder	queriedStores(Set<String> queriedStores)	Returns the IdmLookup store(s) that were queried for the additionalData - including those that did not find a result.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

identifyingClaim

public IdmProvisioningRequest.IdmProvisioningRequestBuilder identifyingClaim(AttributeName identifyingClaim)

Claim to address the user in the IDM (not null).

Returns:

this.

homeName

public IdmProvisioningRequest.IdmProvisioningRequestBuilder homeName(String homeName)

The name in the IDM as filtering parameter for the IDM.

Returns:

this.

accountSource

public IdmProvisioningRequest.IdmProvisioningRequestBuilder accountSource(String accountSource)

The account source from CP config

Returns:

this.

homeNameMigrationAlias

public IdmProvisioningRequest.IdmProvisioningRequestBuilder homeNameMigrationAlias(String homeNameMigrationAlias)

Used for provisioning during migration from a CP to another.
It is used to detect data from the source CP of the migration when provisioning for the target CP.

Returns:

this.

cpSubjectNameId

public IdmProvisioningRequest.IdmProvisioningRequestBuilder cpSubjectNameId(String cpSubjectNameId)

The subject name ID returned by the CP.

Returns:

this.

cpAuthenticationQoa

public IdmProvisioningRequest.IdmProvisioningRequestBuilder cpAuthenticationQoa(Integer cpAuthenticationQoa)

Quality of authentication provided by CP, mapped to the XTB order model.

Returns:

this.

logOnly

public IdmProvisioningRequest.IdmProvisioningRequestBuilder logOnly(boolean logOnly)

If true, provisioning changes are only logged, not applied.

Returns:

this.

modes

public IdmProvisioningRequest.IdmProvisioningRequestBuilder modes(List<String> modes)

Provisioning mode flags specific to implementations. All flags for all implementations are passed in.

Returns:

this.

idmAttributes

public IdmProvisioningRequest.IdmProvisioningRequestBuilder idmAttributes(Map<? extends AttributeName,List<String>> idmAttributes)

Map of attributes received from the IDM (not null, not modifiable).
Empty list if the user was not found by the IdmQueryService.

Returns:

this.

cpAttributes

public IdmProvisioningRequest.IdmProvisioningRequestBuilder cpAttributes(Map<? extends AttributeName,List<String>> cpAttributes)

Map of attributes received from the CP, to be provisioned in the IDM (not null, not modifiable).

Returns:

this.

provisioningAttributes

public IdmProvisioningRequest.IdmProvisioningRequestBuilder provisioningAttributes(List<? extends AttributeName> provisioningAttributes)

List of attributes to provision.

Returns:

this.

additionalData

public IdmProvisioningRequest.IdmProvisioningRequestBuilder additionalData(Map<Object,Object> additionalData)

This is not provided directly by the XTB core code, but is resulting from other custom interface implementations.
The map key indicates the source of the data. It can be used by the implementations to match related interface implementations in order to share internal data structures such as lookup results.
Currently the data returned by the IdmQueryService interface implementations is passed here.

Returns:

this.

See Also:

• IdmResult.getAdditionalData()

queriedStores

public IdmProvisioningRequest.IdmProvisioningRequestBuilder queriedStores(Set<String> queriedStores)

Returns the IdmLookup store(s) that were queried for the additionalData - including those that did not find a result.
Currently the data returned by the IdmQueryService interface implementations is passed here.

Returns:

this.

Since:

1.12.0

See Also:

• IdmResult.getQueriedStores()

build

public IdmProvisioningRequest build()

toString

public String toString()

Overrides:

toString in class Object