ScimAttributeAware (WSO2 Charon

java.lang.Object
- org.wso2.charon3.core.objects.ScimAttributeAware

Direct Known Subclasses:

AbstractSCIMObject
```
public abstract class ScimAttributeAware
extends Object
```
This class is used as a helper implementation and shall provide additional functionality to the AbstractSCIMObject that will help reading, replacing attributes from objects and also an equals implementation of AbstractSCIMObjects is added.

Constructor Summary

Constructors
Constructor and Description

ScimAttributeAware()

Constructors
Constructor and Description
`ScimAttributeAware()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addMultivaluedComplexAtribute(List<MultiValuedComplexType> multiValuedComplexTypeList, SCIMAttributeSchema complexDefinition, SCIMAttributeSchema valueDefinition, SCIMAttributeSchema displayDefinition, SCIMAttributeSchema typeDefinition, SCIMAttributeSchema primaryDefinition, SCIMAttributeSchema referenceDefinition)` this method will add a `MultiValuedComplexType` list to the given `getResource()`
`static boolean`	`attributeMetaEquals(Attribute attribute, Attribute attributeOther)` tells us if the given two attributes do contain the same meta-data
`static boolean`	`attributesEquals(Attribute attribute, Attribute attributeOther)` checks that two given attributes are equals by running through their structure recursively
`static boolean`	`complexAttributeEquals(ComplexAttribute attribute, ComplexAttribute otherAttribute)` tells us if two complex attributes are identical or not
`boolean`	`equals(Object object)` this method is used to compare to scim objects
`Optional<ComplexAttribute>`	`getComplexAttribute(SCIMAttributeSchema scimAttributeSchema)` gets a `ComplexAttribute` from the given `getResource()` object
`LocalDateTime`	`getCreatedDateTime()`
`Instant`	`getCreatedInstant()`
`Long`	`getCreatedLong()`
`String`	`getExternalId()`
`String`	`getId()`
`LocalDateTime`	`getLastModifiedDateTime()`
`Instant`	`getLastModifiedInstant()`
`Long`	`getLastModifiedLong()`
`String`	`getLocation()`
`Optional<MultiValuedAttribute>`	`getMultiValuedAttribute(SCIMAttributeSchema scimAttributeSchema)` gets a `MultiValuedAttribute` from the given `getResource()` object
`protected Optional<List<MultiValuedComplexType>>`	`getMultivaluedComplexType(SCIMAttributeSchema multiValuedDefinition, SCIMAttributeSchema valueDefinition, SCIMAttributeSchema displayDefinition, SCIMAttributeSchema typeDefinition, SCIMAttributeSchema primaryDefinition, SCIMAttributeSchema referenceDefinition)` extracts a multi-valued-complex-type from the `getResource()` object by the given attribute definitions
`ComplexAttribute`	`getOrCrateComplexAttribute(SCIMAttributeSchema scimAttributeSchema)` gets a `ComplexAttribute` from the given `getResource()` object if it does exist and will create it if it does not exist
`abstract AbstractSCIMObject`	`getResource()`
`String`	`getResourceType()`
`protected BiConsumer<SCIMAttributeSchema,Supplier<Object>>`	`getSetSubAttributeConsumer(ComplexAttribute complexAttribute)` returns a `BiConsumer` that will add a new `SimpleAttribute` to the given `ComplexAttribute`
`Optional<SimpleAttribute>`	`getSimpleAttribute(SCIMAttributeSchema scimAttributeSchema)` gets a `SimpleAttribute` from the given `getResource()` object
`Optional<SimpleAttribute>`	`getSimpleAttribute(SCIMAttributeSchema scimAttributeSchema, ComplexAttribute complexAttribute)` gets a `SimpleAttribute` from the given `complexAttribute` object
`Optional<String>`	`getSimpleAttributeValue(SCIMAttributeSchema scimAttributeSchema, ComplexAttribute complexAttribute)` gets a `SimpleAttribute` from the given `complexAttribute` object
`int`	`hashCode()`
`protected boolean`	`isBlank(String s)` tells us if this string is blank or not
`protected boolean`	`isNotBlank(String s)` tells us if this string is blank or not
`static boolean`	`multiValuedAttributeEquals(MultiValuedAttribute attribute, MultiValuedAttribute otherAttribute)` tells us if two simple attributes are identical
`void`	`replaceCreated(Instant createdDate)` sets the created date into the given SCIM resource
`void`	`replaceCreated(LocalDateTime createdDate)` sets the created date into the given SCIM resource
`void`	`replaceCreated(Long createdTimestamp)` sets the created date into the given SCIM resource as localized date string based on the current system time
`void`	`replaceExternalId(String externalId)` sets or overrides the external id attribute of the given `getResource()` object
`void`	`replaceId(String id)` sets or overrides the id attribute of the given `getResource()` object
`void`	`replaceLastModified(Instant lastModifiedInstant)` sets the last modified date into the given SCIM resource
`void`	`replaceLastModified(LocalDateTime lastModifiedDateTime)` sets the last modified date into the given SCIM resource
`void`	`replaceLastModified(Long lastModifiedTimestamp)` sets the last modified timestamp date into the given SCIM resource as localized date string based on the current system time
`void`	`replaceLocation(String resourceType)` sets or overrides the location attribute of the given `getResource()` object
`void`	`replaceResourceType(String resourceType)` sets or overrides the resource type attribute of the given `getResource()` object
`void`	`replaceSimpleAttribute(SCIMAttributeSchema scimAttributeSchema, Object value)` sets a `SimpleAttribute` for the given `getResource()`
`static boolean`	`simpleAttributeEquals(SimpleAttribute attribute1, SimpleAttribute attribute2)` tells us if two simple attributes are identical
`protected String`	`stripToNull(String s)` returns null if this string is blank and removed all whitespaces in the front and at the rear if it is not blank

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScimAttributeAware
```
public ScimAttributeAware()
```
- Method Detail
  - getId
```
public String getId()
```
    Returns:
    
    the id of the SCIM getResource()
  - replaceId
```
public void replaceId(String id)
```
    sets or overrides the id attribute of the given getResource() object
    
    Parameters:
    
    id - the id attribute to write
  - getExternalId
```
public String getExternalId()
```
    Returns:
    
    the external id of the SCIM getResource()
  - replaceExternalId
```
public void replaceExternalId(String externalId)
```
    sets or overrides the external id attribute of the given getResource() object
    
    Parameters:
    
    externalId - the external id attribute to write
  - getResourceType
```
public String getResourceType()
```
    Returns:
    
    the resource type of the SCIM getResource()
  - replaceResourceType
```
public void replaceResourceType(String resourceType)
```
    sets or overrides the resource type attribute of the given getResource() object
    
    Parameters:
    
    resourceType - the resource type attribute to write
  - getLocation
```
public String getLocation()
```
    Returns:
    
    the location of the SCIM getResource()
  - replaceLocation
```
public void replaceLocation(String resourceType)
```
    sets or overrides the location attribute of the given getResource() object
    
    Parameters:
    
    resourceType - the location attribute to write
  - getCreatedLong
```
public Long getCreatedLong()
```
    Returns:
    
    the created timestamp as long of the SCIM getResource() in UTC
  - getCreatedDateTime
```
public LocalDateTime getCreatedDateTime()
```
    Returns:
    
    the created timestamp as LocalDateTime of the SCIM getResource()
  - getCreatedInstant
```
public Instant getCreatedInstant()
```
    Returns:
    
    the created timestamp as Instant of the SCIM getResource() in UTC
  - replaceCreated
```
public void replaceCreated(LocalDateTime createdDate)
```
    sets the created date into the given SCIM resource
    
    Parameters:
    
    createdDate - the java local date time representaiton
  - replaceCreated
```
public void replaceCreated(Instant createdDate)
```
    sets the created date into the given SCIM resource
    
    Parameters:
    
    createdDate - the java local date time representaiton
  - replaceCreated
```
public void replaceCreated(Long createdTimestamp)
```
    sets the created date into the given SCIM resource as localized date string based on the current system time
    
    Parameters:
    
    createdTimestamp - the UTC timestamp as long
  - getLastModifiedDateTime
```
public LocalDateTime getLastModifiedDateTime()
```
    Returns:
    
    the last modified timestamp as LocalDateTime of the SCIM getResource()
  - getLastModifiedInstant
```
public Instant getLastModifiedInstant()
```
    Returns:
    
    the last modified timestamp as LocalDateTime of the SCIM getResource() in UTC
  - getLastModifiedLong
```
public Long getLastModifiedLong()
```
    Returns:
    
    the created timestamp as long of the SCIM getResource() in UTC
  - replaceLastModified
```
public void replaceLastModified(LocalDateTime lastModifiedDateTime)
```
    sets the last modified date into the given SCIM resource
    
    Parameters:
    
    lastModifiedDateTime - the java local date time representaiton
  - replaceLastModified
```
public void replaceLastModified(Instant lastModifiedInstant)
```
    sets the last modified date into the given SCIM resource
    
    Parameters:
    
    lastModifiedInstant - the java local date time representaiton
  - replaceLastModified
```
public void replaceLastModified(Long lastModifiedTimestamp)
```
    sets the last modified timestamp date into the given SCIM resource as localized date string based on the current system time
    
    Parameters:
    
    lastModifiedTimestamp - the UTC timestamp as long
  - getSimpleAttribute
```
public Optional<SimpleAttribute> getSimpleAttribute(SCIMAttributeSchema scimAttributeSchema)
```
    gets a SimpleAttribute from the given getResource() object
    
    Parameters:
    
    scimAttributeSchema - the attribute that should be read from the getResource()
    
    Returns:
    
    the attribute from the getResource() or an empty
  - getSimpleAttribute
```
public Optional<SimpleAttribute> getSimpleAttribute(SCIMAttributeSchema scimAttributeSchema,
                                                    ComplexAttribute complexAttribute)
```
    gets a SimpleAttribute from the given complexAttribute object
    
    Parameters:
    
    scimAttributeSchema - the attribute that should be read from the complexAttribute
    
    complexAttribute - the attribute that should be read from the complexAttribute
    
    Returns:
    
    the attribute from the complexAttribute or an empty
  - getSimpleAttributeValue
```
public Optional<String> getSimpleAttributeValue(SCIMAttributeSchema scimAttributeSchema,
                                                ComplexAttribute complexAttribute)
```
    gets a SimpleAttribute from the given complexAttribute object
    
    Parameters:
    
    scimAttributeSchema - the attribute that should be read from the complexAttribute
    
    complexAttribute - the attribute that should be read from the complexAttribute if (scimAttributeSchema == null || complexAttribute == null) { return Optional.empty(); }
    
    Returns:
    
    the value from the complexAttribute or an empty
  - getComplexAttribute
```
public Optional<ComplexAttribute> getComplexAttribute(SCIMAttributeSchema scimAttributeSchema)
```
    gets a ComplexAttribute from the given getResource() object
    
    Parameters:
    
    scimAttributeSchema - the attribute that should be read from the getResource()
    
    Returns:
    
    the attribute from the getResource() or an empty
  - getOrCrateComplexAttribute
```
public ComplexAttribute getOrCrateComplexAttribute(SCIMAttributeSchema scimAttributeSchema)
```
    gets a ComplexAttribute from the given getResource() object if it does exist and will create it if it does not exist
    
    Parameters:
    
    scimAttributeSchema - the attribute that should be read from the getResource()
    
    Returns:
    
    the attribute from the getResource() or a new attribute that will also be added to the getResource() object
  - getMultiValuedAttribute
```
public Optional<MultiValuedAttribute> getMultiValuedAttribute(SCIMAttributeSchema scimAttributeSchema)
```
    gets a MultiValuedAttribute from the given getResource() object
    
    Parameters:
    
    scimAttributeSchema - the attribute that should be read from the getResource()
    
    Returns:
    
    the attribute from the getResource() or an empty
  - replaceSimpleAttribute
```
public void replaceSimpleAttribute(SCIMAttributeSchema scimAttributeSchema,
                                   Object value)
```
    sets a SimpleAttribute for the given getResource()
    
    Parameters:
    
    scimAttributeSchema - the attribute to set
    
    value - the value that represents the attribute
  - addMultivaluedComplexAtribute
```
protected void addMultivaluedComplexAtribute(List<MultiValuedComplexType> multiValuedComplexTypeList,
                                             SCIMAttributeSchema complexDefinition,
                                             SCIMAttributeSchema valueDefinition,
                                             SCIMAttributeSchema displayDefinition,
                                             SCIMAttributeSchema typeDefinition,
                                             SCIMAttributeSchema primaryDefinition,
                                             SCIMAttributeSchema referenceDefinition)
```
    this method will add a MultiValuedComplexType list to the given getResource()
    
    Parameters:
    
    multiValuedComplexTypeList - the list of attributes that should be added if they are present
    
    complexDefinition - the definition of the complex attribute that should be added to the getResource()
    
    valueDefinition - the definition of the value-attribute for the given complex-type
    
    displayDefinition - the definition of the display-attribute for the given complex-type
    
    typeDefinition - the definition of the type-attribute for the given complex-type
    
    primaryDefinition - the definition of the primary-attribute for the given complex-type
    
    referenceDefinition - the definition of the reference-attribute for the given complex-type
  - getSetSubAttributeConsumer
```
protected BiConsumer<SCIMAttributeSchema,Supplier<Object>> getSetSubAttributeConsumer(ComplexAttribute complexAttribute)
```
    returns a BiConsumer that will add a new SimpleAttribute to the given ComplexAttribute
    
    Parameters:
    
    complexAttribute - the ComplexAttribute that will be extended by a SimpleAttribute
    
    Returns:
    
    the consumer that performs the execution of adding a SimpleAttribute to the given ComplexAttribute
  - getMultivaluedComplexType
```
protected Optional<List<MultiValuedComplexType>> getMultivaluedComplexType(SCIMAttributeSchema multiValuedDefinition,
                                                                           SCIMAttributeSchema valueDefinition,
                                                                           SCIMAttributeSchema displayDefinition,
                                                                           SCIMAttributeSchema typeDefinition,
                                                                           SCIMAttributeSchema primaryDefinition,
                                                                           SCIMAttributeSchema referenceDefinition)
```
    extracts a multi-valued-complex-type from the getResource() object by the given attribute definitions
    
    Parameters:
    
    multiValuedDefinition - the multi valued complex type definition
    
    valueDefinition - the value-definition of the multi-valued-complex type
    
    displayDefinition - the display-definition of the multi-valued-complex type
    
    typeDefinition - the type-definition of the multi-valued-complex type
    
    primaryDefinition - the primary-definition of the multi-valued-complex type
    
    referenceDefinition - the reference-definition of the multi-valued-complex type
    
    Returns:
    
    a list of the given MultiValuedComplexTypes
  - equals
```
public boolean equals(Object object)
```
    this method is used to compare to scim objects
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - the object to compare with this object
    
    Returns:
    
    true if both attributes do contain the same attributes and values
  - attributesEquals
```
public static boolean attributesEquals(Attribute attribute,
                                       Attribute attributeOther)
```
    checks that two given attributes are equals by running through their structure recursively
    
    Returns:
    
    true if the given attributes are equals, false else
  - attributeMetaEquals
```
public static boolean attributeMetaEquals(Attribute attribute,
                                          Attribute attributeOther)
```
    tells us if the given two attributes do contain the same meta-data
    
    Returns:
    
    if the meta-data is identical
  - simpleAttributeEquals
```
public static boolean simpleAttributeEquals(SimpleAttribute attribute1,
                                            SimpleAttribute attribute2)
```
    tells us if two simple attributes are identical
    
    Returns:
    
    true if the attributes are identical, false else
  - multiValuedAttributeEquals
```
public static boolean multiValuedAttributeEquals(MultiValuedAttribute attribute,
                                                 MultiValuedAttribute otherAttribute)
```
    tells us if two simple attributes are identical
    
    Returns:
    
    true if the attributes are identical, false else
  - complexAttributeEquals
```
public static boolean complexAttributeEquals(ComplexAttribute attribute,
                                             ComplexAttribute otherAttribute)
```
    tells us if two complex attributes are identical or not
    
    Returns:
    
    true if the attributes are identical, false else
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isBlank
```
protected boolean isBlank(String s)
```
    tells us if this string is blank or not
  - isNotBlank
```
protected boolean isNotBlank(String s)
```
    tells us if this string is blank or not
  - stripToNull
```
protected String stripToNull(String s)
```
    returns null if this string is blank and removed all whitespaces in the front and at the rear if it is not blank
  - getResource
```
public abstract AbstractSCIMObject getResource()
```
    Returns:
    
    the SCIM resource object that is used for in the given implementation class

Class ScimAttributeAware

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScimAttributeAware

Method Detail

getId

replaceId

getExternalId

replaceExternalId

getResourceType

replaceResourceType

getLocation

replaceLocation

getCreatedLong

getCreatedDateTime

getCreatedInstant

replaceCreated

replaceCreated

replaceCreated

getLastModifiedDateTime

getLastModifiedInstant

getLastModifiedLong

replaceLastModified

replaceLastModified

replaceLastModified

getSimpleAttribute

getSimpleAttribute

getSimpleAttributeValue

getComplexAttribute

getOrCrateComplexAttribute

getMultiValuedAttribute

replaceSimpleAttribute

addMultivaluedComplexAtribute

getSetSubAttributeConsumer

getMultivaluedComplexType

equals

attributesEquals

attributeMetaEquals

simpleAttributeEquals

multiValuedAttributeEquals

complexAttributeEquals

hashCode

isBlank

isNotBlank

stripToNull

getResource