Package de.captaingoldfish.scim.sdk.common.resources.complex

Class BulkConfig

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.complex.BulkConfig

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

author Pascal Knueppel
created at: 18.10.2019 - 10:06

represents the bulk configuration for a ServiceProvider object

A complex type that specifies bulk configuration options. See Section 3.7 of [RFC7644]. REQUIRED.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkConfig.BulkConfigBuilder	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
protected static final Integer	DEFAULT_MAX_OPERATIONS	the default maximum number of operations is 1.
protected static final Long	DEFAULT_MAX_PAYLOAD_SIZE	the default maximum payload is set to 2MB

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
BulkConfig()
BulkConfig(Boolean supported, Integer maxOperations, Long maxPayloadSize, Boolean returnResourcesEnabled, Boolean returnResourcesByDefault, Boolean supportBulkGet)

Method Summary

Modifier and Type	Method	Description
static BulkConfig.BulkConfigBuilder	builder()
Integer	getMaxOperations()	An integer value specifying the maximum number of operations.
Long	getMaxPayloadSize()	An integer value specifying the maximum payload size in bytes.
boolean	isReturnResourcesByDefault()	Allows the service provider to return resources at all endpoints by default on bulk-requests even if the client did not explicitly asked for them.
boolean	isReturnResourcesEnabled()	Enable return resources at bulk endpoint.
boolean	isSupportBulkGet()	Allows the service provider to return resources at all endpoints by default on bulk-requests even if the client did not explicitly asked for them.
boolean	isSupported()	A Boolean value specifying whether the operation is supported.
void	setMaxOperations(Integer maxOperations)	An integer value specifying the maximum number of operations.
void	setMaxPayloadSize(Long maxPayloadSize)	An integer value specifying the maximum payload size in bytes.
void	setReturnResourcesByDefault(Boolean returnResourcesByDefault)	Allows the service provider to return resources at all endpoints by default on bulk-requests even if the client did not explicitly asked for them.
void	setReturnResourcesEnabled(Boolean returnResourcesEnabled)	Enable return resources at bulk endpoint.
void	setSupportBulkGet(Boolean supportBulkGet)	Allows the service provider to return resources at all endpoints by default on bulk-requests even if the client did not explicitly asked for them.
void	setSupported(Boolean supported)	A Boolean value specifying whether or not the operation is supported.

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

DEFAULT_MAX_OPERATIONS

protected static final Integer DEFAULT_MAX_OPERATIONS

the default maximum number of operations is 1. This will enforce the developer to modify the service provider configuration to the applications requirements

DEFAULT_MAX_PAYLOAD_SIZE

protected static final Long DEFAULT_MAX_PAYLOAD_SIZE

the default maximum payload is set to 2MB

Constructor Details

BulkConfig

public BulkConfig()

BulkConfig

public BulkConfig(Boolean supported,
 Integer maxOperations,
 Long maxPayloadSize,
 Boolean returnResourcesEnabled,
 Boolean returnResourcesByDefault,
 Boolean supportBulkGet)

Method Details

isSupported

public boolean isSupported()

A Boolean value specifying whether the operation is supported. REQUIRED.

setSupported

public void setSupported(Boolean supported)

A Boolean value specifying whether or not the operation is supported. REQUIRED.

getMaxOperations

public Integer getMaxOperations()

An integer value specifying the maximum number of operations. REQUIRED.

setMaxOperations

public void setMaxOperations(Integer maxOperations)

An integer value specifying the maximum number of operations. REQUIRED.

getMaxPayloadSize

public Long getMaxPayloadSize()

An integer value specifying the maximum payload size in bytes. REQUIRED.

setMaxPayloadSize

public void setMaxPayloadSize(Long maxPayloadSize)

An integer value specifying the maximum payload size in bytes. REQUIRED.

isReturnResourcesEnabled

public boolean isReturnResourcesEnabled()

Enable return resources at bulk endpoint. If a resource gets created or modified the bulk-endpoint will return the resource if the client explicitly asked for it in the response.

setReturnResourcesEnabled

public void setReturnResourcesEnabled(Boolean returnResourcesEnabled)

Enable return resources at bulk endpoint. If a resource gets created or modified the bulk-endpoint will return the resource if the client explicitly asked for it in the response.

isReturnResourcesByDefault

public boolean isReturnResourcesByDefault()

Allows the service provider to return resources at all endpoints by default on bulk-requests even if the client did not explicitly asked for them.

setReturnResourcesByDefault

public void setReturnResourcesByDefault(Boolean returnResourcesByDefault)

Allows the service provider to return resources at all endpoints by default on bulk-requests even if the client did not explicitly asked for them.

isSupportBulkGet

public boolean isSupportBulkGet()

Allows the service provider to return resources at all endpoints by default on bulk-requests even if the client did not explicitly asked for them.

setSupportBulkGet

public void setSupportBulkGet(Boolean supportBulkGet)

Allows the service provider to return resources at all endpoints by default on bulk-requests even if the client did not explicitly asked for them.

builder

public static BulkConfig.BulkConfigBuilder builder()