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

Class BulkResponseGetOperation

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

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 BulkResponseGetOperation
extends ScimObjectNode

this class will represent a bulk-get response node that contains the data of a specific resource together with its children. This data structure can be transitively nested and thus become very large if not used with care

Since:

29.08.2022

Author:

Pascal Knueppel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkResponseGetOperation.BulkResponseGetOperationBuilder	override lombok builder with public constructor

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
BulkResponseGetOperation()
BulkResponseGetOperation(String nodePath, String resourceId, Integer status, String resourceType, ScimResponse resource, List<BulkResponseGetOperation> children)

Method Summary

Modifier and Type	Method	Description
static BulkResponseGetOperation.BulkResponseGetOperationBuilder	builder()
List<BulkResponseGetOperation>	getChildren()	the children of this resource if any are present
ErrorResponse	getErrorResponse()	if the http status code is unequal to 200 this method can be called to get the error response
String	getNodePath()	the node path of this resource that references the position of this resource within the parent.
<T extends ResourceNode> T	getResource(Class<T> type)
String	getResourceId()	the id of the resource that is referenced
String	getResourceType()	the name of the resource type that is referenced with this resource.
Integer	getStatus()	the http response status for this resource.
void	setChildren(List<BulkResponseGetOperation> children)	the children of this resource if any are present
void	setNodePath(String nodePath)	the node path of this resource that references the position of this resource within the parent.
<T extends ScimResponse> void	setResource(T resource)	the resource that represents this node
void	setResourceId(String resourceId)	the id of the resource that is referenced
void	setResourceType(String resourceType)	the name of the resource type that is referenced with this resource.
void	setStatus(Integer status)	the http response status for this resource.

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

addAttribute, getArrayAttribute, getBooleanAttribute, getDateTimeAttribute, getDoubleAttribute, getIntegerAttribute, getLongAttribute, getObjectAttribute, getSchemaAttribute, 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, putIfAbsent, 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, 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

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 Detail

BulkResponseGetOperation

public BulkResponseGetOperation(String nodePath,
                                String resourceId,
                                Integer status,
                                String resourceType,
                                ScimResponse resource,
                                List<BulkResponseGetOperation> children)

BulkResponseGetOperation

public BulkResponseGetOperation()

Method Detail

getResourceId

public String getResourceId()

the id of the resource that is referenced

setResourceId

public void setResourceId(String resourceId)

the id of the resource that is referenced

getNodePath

public String getNodePath()

the node path of this resource that references the position of this resource within the parent. If null this resource is the one requested within the bulk-request

setNodePath

public void setNodePath(String nodePath)

the node path of this resource that references the position of this resource within the parent. If null this resource is the one requested within the bulk-request

getStatus

public Integer getStatus()

the http response status for this resource. It might happen that a transitive resource cannot be retrieved because of missing access rights and in such a case the response object for this resource would contain a 403 status code

setStatus

public void setStatus(Integer status)

the http response status for this resource. It might happen that a transitive resource cannot be retrieved because of missing access rights and in such a case the response object for this resource would contain a 403 status code

getResourceType

public String getResourceType()

the name of the resource type that is referenced with this resource. In case that a group is retrieved and this node represents one of its members it might be either a User or a Group and this field will help determining which type of resource is represented

setResourceType

public void setResourceType(String resourceType)

the name of the resource type that is referenced with this resource. In case that a group is retrieved and this node represents one of its members it might be either a User or a Group and this field will help determining which type of resource is represented

getResource

public <T extends ResourceNode> T getResource(Class<T> type)

Returns:

the resource that represents this node

getErrorResponse

public ErrorResponse getErrorResponse()

if the http status code is unequal to 200 this method can be called to get the error response

setResource

public <T extends ScimResponse> void setResource(T resource)

the resource that represents this node

getChildren

public List<BulkResponseGetOperation> getChildren()

the children of this resource if any are present

setChildren

public void setChildren(List<BulkResponseGetOperation> children)

the children of this resource if any are present

builder

public static BulkResponseGetOperation.BulkResponseGetOperationBuilder builder()