de.captaingoldfish.scim.sdk.common.response

Class BulkResponseOperation

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.response.BulkResponseOperation

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 BulkResponseOperation
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/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable

com.fasterxml.jackson.databind.JsonSerializable.Base

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<HttpMethod>	VALID_METHODS these are the only http methods allowed by bulk

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 and Description
BulkResponseOperation()
BulkResponseOperation(HttpMethod method, String bulkId, ETag version, String location, Integer status, ErrorResponse response)

Method Summary

Modifier and Type	Method and Description
Optional<String>	getBulkId() The transient identifier of a newly created resource, unique within a bulk request and created by the client.
Optional<String>	getLocation() The resource endpoint URL.
HttpMethod	getMethod() The HTTP method of the current operation.
Optional<ErrorResponse>	getResponse() The HTTP response body for the specified request operation.
Integer	getStatus() The HTTP response status code for the requested operation.
Optional<ETag>	getVersion() The version of the resource being returned.
void	setBulkId(String bulkId) The transient identifier of a newly created resource, unique within a bulk request and created by the client.
void	setLocation(String location) The resource endpoint URL.
void	setMethod(HttpMethod method) The HTTP method of the current operation.
void	setResponse(ErrorResponse response) The HTTP response body for the specified request operation.
void	setStatus(Integer status) The HTTP response status code for the requested operation.
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, getArrayAttribute, getBooleanAttribute, getDateTimeAttribute, getDoubleAttribute, getIntegerAttribute, getLongAttribute, getObjectAttribute, getSimpleArrayAttribute, getSimpleArrayAttribute, getSimpleArrayAttributeSet, getSimpleArrayAttributeSet, getStringAttribute, getStringAttribute, isEmpty, 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, asToken, deepCopy, elements, equals, equals, fieldNames, fields, findParent, findParents, findValue, findValues, findValuesAsText, get, get, getNodeType, hashCode, isEmpty, isObject, path, path, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, putAll, putAll, putArray, putNull, putObject, putPOJO, putRawValue, remove, remove, removeAll, replace, required, retain, retain, serialize, 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

findPath, numberType, required, traverse, traverse

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, 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

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

VALID_METHODS

protected static final List<HttpMethod> VALID_METHODS

these are the only http methods allowed by bulk

Constructor Detail

BulkResponseOperation

public BulkResponseOperation()

BulkResponseOperation

public BulkResponseOperation(HttpMethod method,
                             String bulkId,
                             ETag version,
                             String location,
                             Integer status,
                             ErrorResponse response)

Method Detail

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".

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).

getLocation

public Optional<String> getLocation()

The resource endpoint URL. REQUIRED in a response, except in the event of a POST failure.

setLocation

public void setLocation(String location)

The resource endpoint URL. REQUIRED in a response, except in the event of a POST failure.

getStatus

public Integer getStatus()

The HTTP response status code for the requested operation. When indicating an error, the "response" attribute MUST contain the detail error response as per Section 3.12.

setStatus

public void setStatus(Integer status)

The HTTP response status code for the requested operation. When indicating an error, the "response" attribute MUST contain the detail error response as per Section 3.12.

getResponse

public Optional<ErrorResponse> getResponse()

The HTTP response body for the specified request operation. When indicating a response with an HTTP status other than a 200-series response, the response body MUST be included. For normal completion, the server MAY elect to omit the response body.

setResponse

public void setResponse(ErrorResponse response)

The HTTP response body for the specified request operation. When indicating a response with an HTTP status other than a 200-series response, the response body MUST be included. For normal completion, the server MAY elect to omit the response body.