Package de.captaingoldfish.scim.sdk.common.request

Class BulkRequestOperation

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializable.Base

com.fasterxml.jackson.databind.JsonNode

com.fasterxml.jackson.databind.node.BaseJsonNode

com.fasterxml.jackson.databind.node.ContainerNode<com.fasterxml.jackson.databind.node.ObjectNode>

com.fasterxml.jackson.databind.node.ObjectNode

de.captaingoldfish.scim.sdk.common.resources.base.ScimObjectNode

de.captaingoldfish.scim.sdk.common.request.BulkRequestOperation

All Implemented Interfaces:

com.fasterxml.jackson.core.TreeNode, com.fasterxml.jackson.databind.JsonSerializable, com.fasterxml.jackson.databind.node.JsonNodeCreator, ScimNode, Serializable, Iterable<com.fasterxml.jackson.databind.JsonNode>

public class BulkRequestOperation
extends ScimObjectNode

author Pascal Knueppel
created at: 25.10.2019 - 21:12

Defines operations within a bulk job. Each operation corresponds to a single HTTP request against a resource endpoint. REQUIRED.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkRequestOperation.BulkRequestOperationBuilder	override lombok builder with public constructor

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonNode

com.fasterxml.jackson.databind.JsonNode.OverwriteMode

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable

com.fasterxml.jackson.databind.JsonSerializable.Base

Field Summary

Fields

Modifier and Type	Field	Description
String	uniqueIdentifier	this identifier is exclusively used on bulk requests to be able to check if this request was already tried to be handled once.

Fields inherited from class com.fasterxml.jackson.databind.node.ObjectNode

_children

Fields inherited from class com.fasterxml.jackson.databind.node.ContainerNode

_nodeFactory

Constructor Summary

Constructors

Constructor	Description
BulkRequestOperation()
BulkRequestOperation(HttpMethod method, String bulkId, String path, String data, ETag version, Boolean returnResource, Integer maxResourceLevel)

Method Summary

Modifier and Type	Method	Description
static BulkRequestOperation.BulkRequestOperationBuilder	builder()
Optional<String>	getBulkId()	The transient identifier of a newly created resource, unique within a bulk request and created by the client.
Optional<String>	getData()	The resource data as it would appear for a single SCIM POST, PUT, or PATCH operation.
Integer	getMaxResourceLevel()	this field allows clients to limit the number of transitive retrieved resources from the bulk-response to keep the response profile low
HttpMethod	getMethod()	The HTTP method of the current operation.
String	getPath()	The resource's relative path to the SCIM service provider's root.
String	getUniqueIdentifier()	this identifier is exclusively used on bulk requests to be able to check if this request was already tried to be handled once.
Optional<ETag>	getVersion()	The version of the resource being returned.
Optional<Boolean>	isReturnResource()	this field allows clients to explicitly ask to return the created or modified resource in the bulk response.
void	setBulkId(String bulkId)	The transient identifier of a newly created resource, unique within a bulk request and created by the client.
void	setData(com.fasterxml.jackson.databind.JsonNode data)	The resource data as it would appear for a single SCIM POST, PUT, or PATCH operation.
void	setData(String data)	The resource data as it would appear for a single SCIM POST, PUT, or PATCH operation.
void	setMaxResourceLevel(Integer maxResourceLevel)	this field allows clients to limit the number of transitive retrieved resources from the bulk-response to keep the response profile low
void	setMethod(HttpMethod method)	The HTTP method of the current operation.
void	setPath(String path)	The resource's relative path to the SCIM service provider's root.
void	setReturnResource(Boolean returnResource)	this field allows clients to explicitly ask the server to return the created or modified resource in the bulk response.
void	setUniqueIdentifier(String uniqueIdentifier)	this identifier is exclusively used on bulk requests to be able to check if this request was already tried to be handled once.
void	setVersion(ETag version)	The version of the resource being returned.
void	setVersion(String version)	The version of the resource being returned.

Methods inherited from class de.captaingoldfish.scim.sdk.common.resources.base.ScimObjectNode

addAttribute, equals, getArrayAttribute, getBinaryAttribute, getBooleanAttribute, getDateTimeAttribute, getDoubleAttribute, getIntegerAttribute, getLongAttribute, getObjectAttribute, getSchemaAttribute, getSimpleArrayAttribute, getSimpleArrayAttribute, getSimpleArrayAttributeSet, getSimpleArrayAttributeSet, getStringAttribute, getStringAttribute, isEmpty, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeList, setDateTimeAttribute, setDateTimeAttribute, setDateTimeAttribute, setDateTimeAttribute, setStringAttributeList, setStringAttributeList, toPrettyString, toString

Methods inherited from class com.fasterxml.jackson.databind.node.ObjectNode

_at, _childrenEqual, _contentsToSerialize, _put, _withArray, _withArrayAddTailProperty, _withObject, _withObjectAddTailProperty, asToken, deepCopy, elements, equals, fieldNames, fields, findParent, findParents, findValue, findValues, findValuesAsText, forEachEntry, get, get, getNodeType, hashCode, isEmpty, isObject, optional, path, path, properties, propertyStream, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, putAll, putAll, putArray, putIfAbsent, putNull, putObject, putPOJO, putRawValue, remove, remove, removeAll, removeIf, replace, required, retain, retain, serialize, serializeFilteredContents, serializeWithType, set, setAll, setAll, size, values, valueStream, with, withArray, withArrayProperty, withObject, withObjectProperty, without, without

Methods inherited from class com.fasterxml.jackson.databind.node.ContainerNode

arrayNode, arrayNode, asText, binaryNode, binaryNode, booleanNode, missingNode, nullNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, objectNode, pojoNode, rawValueNode, removeNulls, textNode

Methods inherited from class com.fasterxml.jackson.databind.node.BaseJsonNode

_bigIntFromBigDec, _jsonPointerIfValid, _reportWrongNodeOperation, _reportWrongNodeType, _withXxxMayReplace, _withXxxVerifyReplace, findPath, numberType, required, traverse, traverse, withArray, withObject

Methods inherited from class com.fasterxml.jackson.databind.JsonNode

_reportRequiredViolation, _this, asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, asOptional, asText, at, at, bigIntegerValue, binaryValue, booleanValue, canConvertToExactIntegral, canConvertToInt, canConvertToLong, decimalValue, doubleValue, findParents, findValues, findValuesAsText, floatValue, has, has, hasNonNull, hasNonNull, intValue, isArray, isBigDecimal, isBigInteger, isBinary, isBoolean, isContainerNode, isDouble, isFloat, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isPojo, isShort, isTextual, isValueNode, iterator, longValue, numberValue, optional, require, requiredAt, requiredAt, requireNonNull, shortValue, textValue, withArray, withArray, withObject, withObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface de.captaingoldfish.scim.sdk.common.resources.base.ScimNode

getAttributeDescription, getAttributeName, getCanonicalValues, getMutability, getReferenceTypes, getReturned, getScimNodeName, getUniqueness, getValueType, isCaseExact, isMultiValued, isRequired

Field Details

uniqueIdentifier

public String uniqueIdentifier

this identifier is exclusively used on bulk requests to be able to check if this request was already tried to be handled once. If this happens and the second try fails too, this operation is marked as failure within the bulk response. This is necessary in order to find bulkId references that cannot be resolved.

Constructor Details

BulkRequestOperation

public BulkRequestOperation()

BulkRequestOperation

public BulkRequestOperation(HttpMethod method,
 String bulkId,
 String path,
 String data,
 ETag version,
 Boolean returnResource,
 Integer maxResourceLevel)

Parameters:

method - The HTTP method of the current operation. Possible values are "POST", "PUT", "PATCH", or "DELETE". REQUIRED.

bulkId - The transient identifier of a newly created resource, unique within a bulk request and created by the client. The bulkId serves as a surrogate resource id enabling clients to uniquely identify newly created resources in the response and cross-reference new resources in and across operations within a bulk request. REQUIRED when "method" is "POST".

path - The resource's relative path to the SCIM service provider's root. If "method" is "POST", the value must specify a resource type endpoint, e.g., /Users or /Groups, whereas all other "method" values must specify the path to a specific resource, e.g., /Users/2819c223-7f76-453a-919d-413861904646. REQUIRED in a request.

data - The resource data as it would appear for a single SCIM POST, PUT, or PATCH operation. REQUIRED in a request when "method" is "POST", "PUT", or "PATCH".

version - The version of the resource being returned. This value must be the same as the entity-tag (ETag) HTTP response header (see Sections 2.1 and 2.3 of [RFC7232]). This attribute has "caseExact" as "true". Service provider support for this attribute is optional and subject to the service provider's support for versioning (see Section 3.14 of [RFC7644]). If a service provider provides "version" (entity-tag) for a representation and the generation of that entity-tag does not satisfy all of the characteristics of a strong validator (see Section 2.1 of [RFC7232]), then the origin server MUST mark the "version" (entity-tag) as weak by prefixing its opaque value with "W/" (case sensitive).

returnResource - this field allows clients to explicitly ask the server to return the created or modified resource in the bulk response. This does only work with the SCIM-SDK server implementation under the condition that the feature BulkConfig.isReturnResourcesEnabled() is enabled in the ServiceProvider configuration.

maxResourceLevel - this field allows clients to limit the number of transitive retrieved resources from the bulk-response to keep the response profile low. This is a custom feature usable with the SCIM-SDK server implementation that is only usable if the BulkConfig.isSupportBulkGet() feature is enabled within the ServiceProvider configuration.

Method Details

getMethod

public HttpMethod getMethod()

The HTTP method of the current operation. Possible values are "POST", "PUT", "PATCH", or "DELETE". REQUIRED.

setMethod

public void setMethod(HttpMethod method)

The HTTP method of the current operation. Possible values are "POST", "PUT", "PATCH", or "DELETE". REQUIRED.

getBulkId

public Optional<String> getBulkId()

The transient identifier of a newly created resource, unique within a bulk request and created by the client. The bulkId serves as a surrogate resource id enabling clients to uniquely identify newly created resources in the response and cross-reference new resources in and across operations within a bulk request. REQUIRED when "method" is "POST".

setBulkId

public void setBulkId(String bulkId)

The transient identifier of a newly created resource, unique within a bulk request and created by the client. The bulkId serves as a surrogate resource id enabling clients to uniquely identify newly created resources in the response and cross-reference new resources in and across operations within a bulk request. REQUIRED when "method" is "POST".

getPath

public String getPath()

The resource's relative path to the SCIM service provider's root. If "method" is "POST", the value must specify a resource type endpoint, e.g., /Users or /Groups, whereas all other "method" values must specify the path to a specific resource, e.g., /Users/2819c223-7f76-453a-919d-413861904646. REQUIRED in a request.

setPath

public void setPath(String path)

The resource's relative path to the SCIM service provider's root. If "method" is "POST", the value must specify a resource type endpoint, e.g., /Users or /Groups, whereas all other "method" values must specify the path to a specific resource, e.g., /Users/2819c223-7f76-453a-919d-413861904646. REQUIRED in a request.

getData

public Optional<String> getData()

The resource data as it would appear for a single SCIM POST, PUT, or PATCH operation. REQUIRED in a request when "method" is "POST", "PUT", or "PATCH".

setData

public void setData(String data)

The resource data as it would appear for a single SCIM POST, PUT, or PATCH operation. REQUIRED in a request when "method" is "POST", "PUT", or "PATCH".

setData

public void setData(com.fasterxml.jackson.databind.JsonNode data)

The resource data as it would appear for a single SCIM POST, PUT, or PATCH operation. REQUIRED in a request when "method" is "POST", "PUT", or "PATCH".

getVersion

public Optional<ETag> getVersion()

The version of the resource being returned. This value must be the same as the entity-tag (ETag) HTTP response header (see Sections 2.1 and 2.3 of [RFC7232]). This attribute has "caseExact" as "true". Service provider support for this attribute is optional and subject to the service provider's support for versioning (see Section 3.14 of [RFC7644]). If a service provider provides "version" (entity-tag) for a representation and the generation of that entity-tag does not satisfy all of the characteristics of a strong validator (see Section 2.1 of [RFC7232]), then the origin server MUST mark the "version" (entity-tag) as weak by prefixing its opaque value with "W/" (case sensitive).

setVersion

public void setVersion(String version)

The version of the resource being returned. This value must be the same as the entity-tag (ETag) HTTP response header (see Sections 2.1 and 2.3 of [RFC7232]). This attribute has "caseExact" as "true". Service provider support for this attribute is optional and subject to the service provider's support for versioning (see Section 3.14 of [RFC7644]). If a service provider provides "version" (entity-tag) for a representation and the generation of that entity-tag does not satisfy all of the characteristics of a strong validator (see Section 2.1 of [RFC7232]), then the origin server MUST mark the "version" (entity-tag) as weak by prefixing its opaque value with "W/" (case sensitive).

setVersion

public void setVersion(ETag version)

The version of the resource being returned. This value must be the same as the entity-tag (ETag) HTTP response header (see Sections 2.1 and 2.3 of [RFC7232]). This attribute has "caseExact" as "true". Service provider support for this attribute is optional and subject to the service provider's support for versioning (see Section 3.14 of [RFC7644]). If a service provider provides "version" (entity-tag) for a representation and the generation of that entity-tag does not satisfy all of the characteristics of a strong validator (see Section 2.1 of [RFC7232]), then the origin server MUST mark the "version" (entity-tag) as weak by prefixing its opaque value with "W/" (case sensitive).

isReturnResource

public Optional<Boolean> isReturnResource()

this field allows clients to explicitly ask to return the created or modified resource in the bulk response.

setReturnResource

public void setReturnResource(Boolean returnResource)

this field allows clients to explicitly ask the server to return the created or modified resource in the bulk response. This does only work with the SCIM-SDK server implementation under the condition that the feature is enabled in the ServiceProvider configuration.

getMaxResourceLevel

public Integer getMaxResourceLevel()

this field allows clients to limit the number of transitive retrieved resources from the bulk-response to keep the response profile low

setMaxResourceLevel

public void setMaxResourceLevel(Integer maxResourceLevel)

this field allows clients to limit the number of transitive retrieved resources from the bulk-response to keep the response profile low

builder

public static BulkRequestOperation.BulkRequestOperationBuilder builder()

getUniqueIdentifier

public String getUniqueIdentifier()

this identifier is exclusively used on bulk requests to be able to check if this request was already tried to be handled once. If this happens and the second try fails too, this operation is marked as failure within the bulk response. This is necessary in order to find bulkId references that cannot be resolved.

setUniqueIdentifier

public void setUniqueIdentifier(String uniqueIdentifier)

this identifier is exclusively used on bulk requests to be able to check if this request was already tried to be handled once. If this happens and the second try fails too, this operation is marked as failure within the bulk response. This is necessary in order to find bulkId references that cannot be resolved.