Package de.captaingoldfish.scim.sdk.common.response

Class BulkResponse

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.resources.AbstractSchemasHolder

de.captaingoldfish.scim.sdk.common.response.ScimResponse

de.captaingoldfish.scim.sdk.common.response.BulkResponse

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 BulkResponse
extends ScimResponse

author Pascal Knueppel
created at: 25.10.2019 - 20:34

represents a simple bulk response

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkResponse.BulkResponseBuilder	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 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
BulkResponse()
BulkResponse(List<BulkResponseOperation> bulkResponseOperation, int httpStatus)

Method Summary

Modifier and Type	Method	Description
static BulkResponse.BulkResponseBuilder	builder()
List<BulkResponseOperation>	getBulkResponseOperations()	Defines operations within a bulk job.
Optional<BulkResponseOperation>	getByBulkId(String bulkId)	tries to find a bulk response operation matching the given bulkId.
Optional<BulkResponseOperation>	getByResourceId(String resourceId)	tries to find a bulk response operation by searching for a resource's id.
int	getHttpStatus()	the http status code of the response
List<BulkResponseOperation>	getOperationsWithBulkId()
List<BulkResponseOperation>	getOperationsWithoutBulkId()
void	setBulkResponseOperations(List<BulkResponseOperation> bulkRequestOperations)	Defines operations within a bulk job.

Methods inherited from class de.captaingoldfish.scim.sdk.common.response.ScimResponse

buildJakartaResponse, buildResponse, getHttpHeaders, setETag

Methods inherited from class de.captaingoldfish.scim.sdk.common.resources.AbstractSchemasHolder

addSchema, getSchemas, removeSchema, setSchemas, setSchemas

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

addAttribute, 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, _put, _withArray, _withArrayAddTailProperty, _withObject, _withObjectAddTailProperty, asToken, deepCopy, elements, equals, equals, fieldNames, fields, findParent, findParents, findValue, findValues, findValuesAsText, get, get, getNodeType, hashCode, isEmpty, isObject, path, path, properties, 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, replace, required, retain, retain, serialize, serializeFilteredContents, serializeWithType, set, setAll, setAll, size, with, withArray, 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, 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, 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, require, requiredAt, requiredAt, requireNonNull, shortValue, textValue, withArray, withArray, withObject, 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

Constructor Details

BulkResponse

public BulkResponse(List<BulkResponseOperation> bulkResponseOperation,
 int httpStatus)

BulkResponse

public BulkResponse()

Method Details

getHttpStatus

public int getHttpStatus()

the http status code of the response

Specified by:

getHttpStatus in class ScimResponse

getBulkResponseOperations

public List<BulkResponseOperation> getBulkResponseOperations()

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

setBulkResponseOperations

public void setBulkResponseOperations(List<BulkResponseOperation> bulkRequestOperations)

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

getByBulkId

public Optional<BulkResponseOperation> getByBulkId(String bulkId)

tries to find a bulk response operation matching the given bulkId. It is also possible to get a bulk request with a null-bulkId. Be sure to use that only if you are certain that only a single entry has a null-bulkId

Parameters:

bulkId - the bulk id of the operation that should be extracted (null allowed)

Returns:

the operation or an empty if no operation did match the bulkId

getByResourceId

public Optional<BulkResponseOperation> getByResourceId(String resourceId)

tries to find a bulk response operation by searching for a resource's id. This can be used on update/patch or delete requests

Parameters:

resourceId - the resources id of the operation that should be extracted

Returns:

the operation or an empty if no operation did match the resourceId

getOperationsWithBulkId

public List<BulkResponseOperation> getOperationsWithBulkId()

Returns:

all operations that do have a bulkId

getOperationsWithoutBulkId

public List<BulkResponseOperation> getOperationsWithoutBulkId()

Returns:

all operations that do not have a bulkId

builder

public static BulkResponse.BulkResponseBuilder builder()