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

Class AuthenticationScheme

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.multicomplex.MultiComplexNode

de.captaingoldfish.scim.sdk.common.resources.multicomplex.AuthenticationScheme

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 AuthenticationScheme
extends MultiComplexNode

author Pascal Knueppel
created at: 18.10.2019 - 10:41

A multi-valued complex type that specifies supported authentication scheme properties. To enable seamless discovery of configurations, the service provider SHOULD, with the appropriate security considerations, make the authenticationSchemes attribute publicly accessible without prior authentication. REQUIRED.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthenticationScheme.AuthenticationSchemeBuilder	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
AuthenticationScheme()
AuthenticationScheme(String type, Boolean primary, String display, String value, String ref)
AuthenticationScheme(String name, String description, String type, String specUri, String documentationUri, Boolean primary, String display, String value, String ref)

Method Summary

Modifier and Type	Method	Description
static AuthenticationScheme.AuthenticationSchemeBuilder	builder()
String	getAuthenticationType()	The authentication scheme.
String	getDescription()	A description of the authentication scheme.
Optional<String>	getDocumentationUri()	An HTTP-addressable URL pointing to the authentication scheme's usage documentation.
String	getName()	The common authentication scheme name, e.g., HTTP Basic.
Optional<String>	getSpecUri()	An HTTP-addressable URL pointing to the authentication scheme's specification.
String	getWwwAuthenticateHeaderRepresentation(String realm)	returns this authentication type as string representation that matches the http WWW-Authenticate response header representation
void	setAuthenticationType(String type)	The authentication scheme.
void	setDescription(String description)	A description of the authentication scheme.
void	setDocumentationUri(String documentationUri)	An HTTP-addressable URL pointing to the authentication scheme's usage documentation.
void	setName(String name)	The common authentication scheme name, e.g., HTTP Basic.
void	setSpecUri(String specUri)	An HTTP-addressable URL pointing to the authentication scheme's specification.

Methods inherited from class de.captaingoldfish.scim.sdk.common.resources.multicomplex.MultiComplexNode

getDisplay, getRef, getType, getValue, isPrimary, setDisplay, setPrimary, setRef, setType, setValue

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

AuthenticationScheme

public AuthenticationScheme(String name,
 String description,
 String type,
 String specUri,
 String documentationUri,
 Boolean primary,
 String display,
 String value,
 String ref)

AuthenticationScheme

public AuthenticationScheme(String type,
 Boolean primary,
 String display,
 String value,
 String ref)

AuthenticationScheme

public AuthenticationScheme()

Method Details

getName

public String getName()

The common authentication scheme name, e.g., HTTP Basic. REQUIRED.

setName

public void setName(String name)

The common authentication scheme name, e.g., HTTP Basic. REQUIRED.

getDescription

public String getDescription()

A description of the authentication scheme. REQUIRED.

setDescription

public void setDescription(String description)

A description of the authentication scheme. REQUIRED.

getAuthenticationType

public String getAuthenticationType()

The authentication scheme. This specification defines the values "oauth", "oauth2", "oauthbearertoken", "httpbasic", and "httpdigest". REQUIRED.

setAuthenticationType

public void setAuthenticationType(String type)

The authentication scheme. This specification defines the values "oauth", "oauth2", "oauthbearertoken", "httpbasic", and "httpdigest". REQUIRED.

getSpecUri

public Optional<String> getSpecUri()

An HTTP-addressable URL pointing to the authentication scheme's specification. OPTIONAL.

setSpecUri

public void setSpecUri(String specUri)

An HTTP-addressable URL pointing to the authentication scheme's specification. OPTIONAL.

getDocumentationUri

public Optional<String> getDocumentationUri()

An HTTP-addressable URL pointing to the authentication scheme's usage documentation. OPTIONAL.

setDocumentationUri

public void setDocumentationUri(String documentationUri)

An HTTP-addressable URL pointing to the authentication scheme's usage documentation. OPTIONAL.

getWwwAuthenticateHeaderRepresentation

public String getWwwAuthenticateHeaderRepresentation(String realm)

returns this authentication type as string representation that matches the http WWW-Authenticate response header representation

builder

public static AuthenticationScheme.AuthenticationSchemeBuilder builder()