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

Class ScimResponse

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

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>

Direct Known Subclasses:

BulkResponse, CreateResponse, DeleteResponse, EmptyPatchResponse, ErrorResponse, GetResponse, ListResponse, UpdateResponse

public abstract class ScimResponse
extends AbstractSchemasHolder

author Pascal Knueppel
created at: 03.10.2019 - 19:29

The abstract implementation for all responses created by this framework

See Also:

• Serialized Form

Nested Class Summary

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

Modifier	Constructor	Description
protected	ScimResponse()
	ScimResponse(com.fasterxml.jackson.databind.JsonNode responseNode)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	buildJakartaResponse()	builds a response object that should be usable with most of the common rest apis
javax.ws.rs.core.Response	buildResponse()	builds a response object that should be usable with most of the common rest apis
Map<String,String>	getHttpHeaders()	contains the http header attributes for the response
abstract int	getHttpStatus()	the http status code of the response
protected void	setETag(Meta meta)	will set the entity tag into the response headers

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

Constructor Details

ScimResponse

public ScimResponse(com.fasterxml.jackson.databind.JsonNode responseNode)

ScimResponse

protected ScimResponse()

Method Details

setETag

protected void setETag(Meta meta)

will set the entity tag into the response headers

Parameters:

meta - the meta attribute that might contain a version-attribute which is the entity tag

buildResponse

public javax.ws.rs.core.Response buildResponse()

builds a response object that should be usable with most of the common rest apis

Returns:

a jax-rs response containing the response body and the http headers

buildJakartaResponse

public jakarta.ws.rs.core.Response buildJakartaResponse()

builds a response object that should be usable with most of the common rest apis

Returns:

a jakarta-rs response containing the response body and the http headers

getHttpStatus

public abstract int getHttpStatus()

the http status code of the response

getHttpHeaders

public Map<String,String> getHttpHeaders()

contains the http header attributes for the response