Package de.captaingoldfish.scim.sdk.client.builder

Class BulkBuilder

java.lang.Object

de.captaingoldfish.scim.sdk.client.builder.RequestBuilder<BulkResponse>

de.captaingoldfish.scim.sdk.client.builder.BulkBuilder

public class BulkBuilder
extends RequestBuilder<BulkResponse>

author Pascal Knueppel
created at: 08.03.2020

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkBuilder.BulkRequestOperationCreator	an additional build step class that allows to set the values of a bulk operation

Constructor Summary

Constructors

Constructor	Description
BulkBuilder(String baseUrl, ScimHttpClient scimHttpClient, boolean isFullUrl, Supplier<ServiceProvider> serviceProviderSupplier)	if the resource should be retrieved by using the fully qualified url

Method Summary

Modifier and Type	Method	Description
BulkBuilder	addOperations(List<BulkRequestOperation> requestOperations)	adds the given list of operations
BulkBuilder.BulkRequestOperationCreator	bulkRequestOperation(String path)	sets the path to the resource endpoint e.g.
BulkBuilder.BulkRequestOperationCreator	bulkRequestOperation(String path, String id)	sets the path to the resource endpoint e.g.
BulkBuilder	failOnErrors(Integer failOnErrors)	sets how many errors are allowed on the server side before the request should be rolled back
List<BulkRequestOperation>	getBulkRequestOperationList()	the bulk request operations that should be executed
protected org.apache.http.client.methods.HttpUriRequest	getHttpUriRequest()	builds the request for the server
protected String	getIdFromLocationAttribute(BulkResponseOperation bulkResponseOperation)	extracted into its own method for unit tests.
protected String	getResource()	overrides the default method from the superclass to have easier control of the resource that will be put into the request body
protected boolean	isExpectedResponseCode(int httpStatus)	tells this abstract class if the http status from the server is the expected success status
protected Function<HttpResponse,Boolean>	isResponseParseable()	checks if the response contains a schema-uri that matches the value of SchemaUris.BULK_RESPONSE_URI
ServerResponse<BulkResponse>	sendRequestWithMultiHeaders(Map<String,String[]> httpHeaders)	sends the defined request to the service provider
void	setServiceProviderSupplier(Supplier<ServiceProvider> serviceProviderSupplier)	contains the configuration of the service provider that is used to determine the max-operations of a bulk request and to help to split the operations into several requests if necessary.

Methods inherited from class de.captaingoldfish.scim.sdk.client.builder.RequestBuilder

addHeaderToRequest, getBaseUrl, getEndpoint, getResponseEntityType, getScimHttpClient, sendRequest, sendRequest, setResource, setResource, toResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkBuilder

public BulkBuilder(String baseUrl,
                   ScimHttpClient scimHttpClient,
                   boolean isFullUrl,
                   Supplier<ServiceProvider> serviceProviderSupplier)

if the resource should be retrieved by using the fully qualified url

Parameters:

baseUrl - the fully qualified url to the required resource

scimHttpClient - the http client instance

isFullUrl - if the given base url is the fully qualified url or not

serviceProviderSupplier - contains the configuration of the service provider that is used to determine the max-operations of a bulk request and to help to split the operations into several requests if necessary.
This object might be null

Method Detail

isExpectedResponseCode

protected boolean isExpectedResponseCode(int httpStatus)

tells this abstract class if the http status from the server is the expected success status

Specified by:

isExpectedResponseCode in class RequestBuilder<BulkResponse>

Parameters:

httpStatus - the http status from the server

Returns:

true if the response status shows success

getHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest getHttpUriRequest()

builds the request for the server

Specified by:

getHttpUriRequest in class RequestBuilder<BulkResponse>

getResource

protected String getResource()

overrides the default method from the superclass to have easier control of the resource that will be put into the request body

Overrides:

getResource in class RequestBuilder<BulkResponse>

isResponseParseable

protected Function<HttpResponse,Boolean> isResponseParseable()

checks if the response contains a schema-uri that matches the value of SchemaUris.BULK_RESPONSE_URI

Overrides:

isResponseParseable in class RequestBuilder<BulkResponse>

failOnErrors

public BulkBuilder failOnErrors(Integer failOnErrors)

sets how many errors are allowed on the server side before the request should be rolled back

Parameters:

failOnErrors - the number of errors that are accepted on the server side

bulkRequestOperation

public BulkBuilder.BulkRequestOperationCreator bulkRequestOperation(String path)

sets the path to the resource endpoint e.g. "/Users" or "/Groups"

bulkRequestOperation

public BulkBuilder.BulkRequestOperationCreator bulkRequestOperation(String path,
                                                                    String id)

sets the path to the resource endpoint e.g. "/Users" or "/Groups"

Parameters:

path - "/Users", "/Groups" or any other registered resource path

id - the id of an existing resource in case of patch, update or delete

addOperations

public BulkBuilder addOperations(List<BulkRequestOperation> requestOperations)

adds the given list of operations

sendRequestWithMultiHeaders

public ServerResponse<BulkResponse> sendRequestWithMultiHeaders(Map<String,String[]> httpHeaders)

sends the defined request to the service provider

Overrides:

sendRequestWithMultiHeaders in class RequestBuilder<BulkResponse>

Parameters:

httpHeaders - allows the user to add additional http headers to the request

Returns:

the response from the given request. A response must not be returned in any case from the service provider so the returned type is still optional

getIdFromLocationAttribute

protected String getIdFromLocationAttribute(BulkResponseOperation bulkResponseOperation)

extracted into its own method for unit tests.

getBulkRequestOperationList

public List<BulkRequestOperation> getBulkRequestOperationList()

the bulk request operations that should be executed

setServiceProviderSupplier

public void setServiceProviderSupplier(Supplier<ServiceProvider> serviceProviderSupplier)

contains the configuration of the service provider that is used to determine the max-operations of a bulk request and to help to split the operations into several requests if necessary.
This object might be null