org.wso2.charon3.core.objects

Class AbstractSCIMObject

java.lang.Object

org.wso2.charon3.core.objects.ScimAttributeAware

org.wso2.charon3.core.objects.AbstractSCIMObject

All Implemented Interfaces:

Serializable, SCIMObject

Direct Known Subclasses:

Group, ListedResource, Role, User

public class AbstractSCIMObject
extends ScimAttributeAware
implements SCIMObject

This represents the object which is a collection of attributes defined by common-schema. These attributes MUST be included in all other objects which become SCIM resources.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Attribute>	attributeList Collection of attributes which constitute this resource.
protected List<String>	schemaList List of schemas where the attributes of this resource, are defined.

Constructor Summary

Constructors

Constructor and Description
AbstractSCIMObject()

Method Summary

Modifier and Type	Method and Description
protected void	createMetaAttribute() crete the meta attribute of the scim object
void	deleteAttribute(String id) Deleting an attribute is the responsibility of an attribute holder.
void	deleteSubAttribute(String parentAttribute, String childAttribute) Deleting a sub attribute of complex attribute is the responsibility of an attribute holder.
void	deleteSubSubAttribute(String childAttribute, String parentAttribute, String grandParentAttribute) This deletion method is only applicable for extension schema Deleting a sub attribute of complex attribute is the responsibility of an attribute holder.
void	deleteSubValuesSubAttribute(String grandParentAttribute, String parentAttribute, String subValue, String childAttribute)
void	deleteValuesSubAttribute(String attribute, String subAttribute, String subSimpleAttribute) Deleting a sub value's sub attribute of multivalued attribute is the responsibility of an attribute holder.
Attribute	getAttribute(String attributeName)
Map<String,Attribute>	getAttributeList()
Date	getCreatedDate() Deprecated.
Date	getLastModified() Deprecated.
protected ComplexAttribute	getMetaAttribute() Return the meta attribute
AbstractSCIMObject	getResource()
List<String>	getSchemaList()
boolean	isAttributeExist(String attributeName)
protected boolean	isMetaAttributeExist()
protected boolean	isSchemaExists(String schemaName)
void	setAttribute(Attribute newAttribute) Set the attributes in the SCIM Object.
void	setAttribute(Attribute newAttribute, ResourceTypeSchema resourceSchema) Set the attributes and corresponding schema in the SCIM Object.
void	setCreatedDate(Date createdDate) Deprecated.
void	setCreatedInstant(Instant created)
void	setExternalId(String externalId) Set a String that is an identifier for the resource as defined by the provisioning client.
void	setId(String id) Set a value for the id attribute.
void	setLastModified(Date lastModifiedDate) Deprecated.
void	setLastModifiedInstant(Instant lastModified)
void	setLocation(String location) set the location of the meta attribute
void	setResourceType(String resourceType) set the resourceType of the meta attribute
void	setSchema(String schema)
String	toString()

Methods inherited from class org.wso2.charon3.core.objects.ScimAttributeAware

addMultivaluedComplexAtribute, attributeMetaEquals, attributesEquals, complexAttributeEquals, equals, getComplexAttribute, getCreatedDateTime, getCreatedInstant, getCreatedLong, getExternalId, getId, getLastModifiedDateTime, getLastModifiedInstant, getLastModifiedLong, getLocation, getMultiValuedAttribute, getMultivaluedComplexType, getOrCrateComplexAttribute, getResourceType, getSetSubAttributeConsumer, getSimpleAttribute, getSimpleAttribute, getSimpleAttributeValue, hashCode, isBlank, isNotBlank, multiValuedAttributeEquals, replaceCreated, replaceCreated, replaceCreated, replaceExternalId, replaceId, replaceLastModified, replaceLastModified, replaceLastModified, replaceLocation, replaceResourceType, replaceSimpleAttribute, simpleAttributeEquals, stripToNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

attributeList

protected Map<String,Attribute> attributeList

Collection of attributes which constitute this resource.

schemaList

protected List<String> schemaList

List of schemas where the attributes of this resource, are defined.

Constructor Detail

AbstractSCIMObject

public AbstractSCIMObject()

Method Detail

setAttribute

public void setAttribute(Attribute newAttribute,
                         ResourceTypeSchema resourceSchema)

Set the attributes and corresponding schema in the SCIM Object.

Parameters:

newAttribute -

resourceSchema -

setAttribute

public void setAttribute(Attribute newAttribute)

Set the attributes in the SCIM Object.

Parameters:

newAttribute -

isSchemaExists

protected boolean isSchemaExists(String schemaName)

isAttributeExist

public boolean isAttributeExist(String attributeName)

getAttributeList

public Map<String,Attribute> getAttributeList()

Specified by:

getAttributeList in interface SCIMObject

setSchema

public void setSchema(String schema)

getSchemaList

public List<String> getSchemaList()

Specified by:

getSchemaList in interface SCIMObject

getAttribute

public Attribute getAttribute(String attributeName)

Specified by:

getAttribute in interface SCIMObject

deleteAttribute

public void deleteAttribute(String id)

Deleting an attribute is the responsibility of an attribute holder.

Specified by:

deleteAttribute in interface SCIMObject

Parameters:

id - - name of the attribute

deleteSubAttribute

public void deleteSubAttribute(String parentAttribute,
                               String childAttribute)

Deleting a sub attribute of complex attribute is the responsibility of an attribute holder.

Parameters:

parentAttribute - - name of the parent attribute

childAttribute - - name of the sub attribute

deleteSubSubAttribute

public void deleteSubSubAttribute(String childAttribute,
                                  String parentAttribute,
                                  String grandParentAttribute)
                           throws CharonException

This deletion method is only applicable for extension schema Deleting a sub attribute of complex attribute is the responsibility of an attribute holder.

Parameters:

grandParentAttribute -

parentAttribute -

childAttribute -

Throws:

CharonException

deleteValuesSubAttribute

public void deleteValuesSubAttribute(String attribute,
                                     String subAttribute,
                                     String subSimpleAttribute)

Deleting a sub value's sub attribute of multivalued attribute is the responsibility of an attribute holder.

deleteSubValuesSubAttribute

public void deleteSubValuesSubAttribute(String grandParentAttribute,
                                        String parentAttribute,
                                        String subValue,
                                        String childAttribute)

isMetaAttributeExist

protected boolean isMetaAttributeExist()

setId

public void setId(String id)
           throws CharonException,
                  BadRequestException

Set a value for the id attribute. If attribute not already created in the resource, create attribute and set the value. Unique identifier for the SCIM Resource as defined by the Service Provider This is read-only. So can only set once.

Parameters:

id - Unique identifier for the SCIM Resource as defined by the Service Provider.

Throws:

CharonException

BadRequestException

setExternalId

public void setExternalId(String externalId)
                   throws CharonException,
                          BadRequestException

Set a String that is an identifier for the resource as defined by the provisioning client.

Parameters:

externalId - identifier for the SCIM Resource as defined by the provisioning client.

Throws:

BadRequestException

CharonException

setCreatedDate

@Deprecated
public void setCreatedDate(Date createdDate)
                                throws CharonException,
                                       BadRequestException

Deprecated.

set the created date and time of the resource

Parameters:

createdDate -

Throws:

CharonException

BadRequestException

setCreatedInstant

public void setCreatedInstant(Instant created)
                       throws CharonException,
                              BadRequestException

Throws:

CharonException

BadRequestException

setLastModified

@Deprecated
public void setLastModified(Date lastModifiedDate)
                                 throws CharonException,
                                        BadRequestException

Deprecated.

set the last modified date and time of the resource

Parameters:

lastModifiedDate -

Throws:

CharonException

BadRequestException

setLastModifiedInstant

public void setLastModifiedInstant(Instant lastModified)
                            throws CharonException,
                                   BadRequestException

Throws:

CharonException

BadRequestException

createMetaAttribute

protected void createMetaAttribute()
                            throws CharonException,
                                   BadRequestException

crete the meta attribute of the scim object

Throws:

CharonException

BadRequestException

getMetaAttribute

protected ComplexAttribute getMetaAttribute()

Return the meta attribute

Returns:

ComplexAttribute

setLocation

public void setLocation(String location)
                 throws CharonException,
                        BadRequestException

set the location of the meta attribute

Parameters:

location -

Throws:

CharonException

BadRequestException

setResourceType

public void setResourceType(String resourceType)
                     throws BadRequestException,
                            CharonException

set the resourceType of the meta attribute

Parameters:

resourceType -

Throws:

BadRequestException

CharonException

getCreatedDate

@Deprecated
public Date getCreatedDate()
                                throws CharonException

Deprecated.

Throws:

CharonException

getLastModified

@Deprecated
public Date getLastModified()
                                 throws CharonException

Deprecated.

Throws:

CharonException

toString

public String toString()

Overrides:

toString in class Object

getResource

public AbstractSCIMObject getResource()

Specified by:

getResource in class ScimAttributeAware

Returns:

the SCIM resource object that is used for in the given implementation class