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

Class BulkBuilder.BulkRequestOperationCreator

java.lang.Object

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

Enclosing class:

BulkBuilder

public static class BulkBuilder.BulkRequestOperationCreator
extends Object

an additional build step class that allows to set the values of a bulk operation

Constructor Summary

Constructors

Constructor	Description
BulkRequestOperationCreator(BulkBuilder bulkBuilder, String path)

Method Summary

Modifier and Type	Method	Description
BulkBuilder.BulkRequestOperationCreator	bulkId(String bulkId)	sets the bulkId for this operation.
BulkBuilder.BulkRequestOperationCreator	data(com.fasterxml.jackson.databind.JsonNode data)	sets the request body for this operation if any is required
BulkBuilder.BulkRequestOperationCreator	data(String data)	sets the request body for this operation if any is required
BulkBuilder.BulkRequestOperationCreator	maxResourceLevel(int maxResourceLevel)	only usable for the SCIM-SDKs Bulk-Get custom feature.
BulkBuilder.BulkRequestOperationCreator	method(HttpMethod method)	sets the http method for this bulk operation
BulkBuilder	next()
BulkBuilder.BulkRequestOperationCreator	returnResource(boolean returnResource)	asks the server to return the resource within the bulk response.
ServerResponse<BulkResponse>	sendRequest()	builds the operation and directly sends the request to the server
ServerResponse<BulkResponse>	sendRequest(Consumer<ServerResponse<BulkResponse>> responseHandler)	builds the operation and directly sends the request to the server
ServerResponse<BulkResponse>	sendRequest(Map<String,String> httpHeaders)	builds the operation and directly sends the request to the server
ServerResponse<BulkResponse>	sendRequest(Map<String,String> httpHeaders, Consumer<ServerResponse<BulkResponse>> responseHandler)	builds the operation and directly sends the request to the server
ServerResponse<BulkResponse>	sendRequestWithMultiHeaders(Map<String,String[]> httpHeaders)	builds the operation and directly sends the request to the server
ServerResponse<BulkResponse>	sendRequestWithMultiHeaders(Map<String,String[]> httpHeaders, Consumer<ServerResponse<BulkResponse>> responseHandler)	builds the operation and directly sends the request to the server
BulkBuilder.BulkRequestOperationCreator	version(ETag version)	sets the etag version for this operation which may be used on update, path and delete requests

Methods inherited from class java.lang.Object

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

Constructor Details

BulkRequestOperationCreator

public BulkRequestOperationCreator(BulkBuilder bulkBuilder,
 String path)

Method Details

method

public BulkBuilder.BulkRequestOperationCreator method(HttpMethod method)

sets the http method for this bulk operation

bulkId

public BulkBuilder.BulkRequestOperationCreator bulkId(String bulkId)

sets the bulkId for this operation. Required if http method is post and optional in any other cases

data

public BulkBuilder.BulkRequestOperationCreator data(String data)

sets the request body for this operation if any is required

data

public BulkBuilder.BulkRequestOperationCreator data(com.fasterxml.jackson.databind.JsonNode data)

sets the request body for this operation if any is required

version

public BulkBuilder.BulkRequestOperationCreator version(ETag version)

sets the etag version for this operation which may be used on update, path and delete requests

returnResource

public BulkBuilder.BulkRequestOperationCreator returnResource(boolean returnResource)

asks the server to return the resource within the bulk response. This feature is supported only by the SCIM-SDK implementation.

maxResourceLevel

public BulkBuilder.BulkRequestOperationCreator maxResourceLevel(int maxResourceLevel)

only usable for the SCIM-SDKs Bulk-Get custom feature. It limits the amount of resources to be returned from the server if the bulk-get feature is utilized

next

public BulkBuilder next()

Returns:

builds the operation object and returns to the owning top level instance

sendRequest

public ServerResponse<BulkResponse> sendRequest()

builds the operation and directly sends the request to the server

sendRequest

public ServerResponse<BulkResponse> sendRequest(Consumer<ServerResponse<BulkResponse>> responseHandler)

builds the operation and directly sends the request to the server

Parameters:

responseHandler - a helper method to will allow the client to react to each individual response. This makes only sense if the feature ScimClientConfig.isEnableAutomaticBulkRequestSplitting() is enabled

sendRequest

public ServerResponse<BulkResponse> sendRequest(Map<String,String> httpHeaders)

builds the operation and directly sends the request to the server

sendRequest

public ServerResponse<BulkResponse> sendRequest(Map<String,String> httpHeaders,
 Consumer<ServerResponse<BulkResponse>> responseHandler)

builds the operation and directly sends the request to the server

Parameters:

responseHandler - a helper method to will allow the client to react to each individual response. This makes only sense if the feature ScimClientConfig.isEnableAutomaticBulkRequestSplitting() is enabled

sendRequestWithMultiHeaders

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

builds the operation and directly sends the request to the server

sendRequestWithMultiHeaders

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

builds the operation and directly sends the request to the server

Parameters:

responseHandler - a helper method to will allow the client to react to each individual response. This makes only sense if the feature ScimClientConfig.isEnableAutomaticBulkRequestSplitting() is enabled