com.unboundid.scim.data

Class BaseResource

java.lang.Object

com.unboundid.scim.data.BaseResource

All Implemented Interfaces:

SCIMResponse

Direct Known Subclasses:

ClientExample.DeviceResource, GroupResource, ResourceDescriptor, ServiceProviderConfig, UserResource

public class BaseResource
extends Object
implements SCIMResponse

This class represents a SCIM resource. It could also be sub-typed for specific resource types (ie. Users or Groups) that provide convenience methods for accessing specific attribute values.

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceFactory<BaseResource>	BASE_RESOURCE_FACTORY A ResourceFactory for creating BaseResource instances.

Constructor Summary

Constructors

Constructor and Description
BaseResource(ResourceDescriptor resourceDescriptor) Construct an empty BaseResource with the specified ResourceDescriptor.
BaseResource(ResourceDescriptor resourceDescriptor, SCIMObject scimObject) Construct a BaseResource with the specified ResourceDescriptor and backed by the given SCIMObject.

Method Summary

Methods

Modifier and Type	Method and Description
void	addOrReplaceMultiValuedValue(String name, ComplexValue attributeValue) Add or replace a value on a multi-valued attribute with the specified name.
void	addOrReplaceMultiValuedValue(String schema, String name, ComplexValue attributeValue) Add or replace a value on a multi-valued attribute with the specified schema and name.
boolean	equals(Object o)
<T> Collection<T>	getAttributeValues(String schema, String name, AttributeValueResolver<T> resolver) Retrieves a multi-valued attribute value.
ComplexValue	getComplexAttributeValue(String name) Get a complex attribute with the specified name.
ComplexValue	getComplexAttributeValue(String schema, String name) Get a complex attribute with the specified name and schema.
String	getExternalId() Retrieves the unique identifier for the Resource as defined by the Service Consumer.
String	getId() Retrieves the unique identifier for the SCIM Resource as defined by the Service Provider.
Meta	getMeta() Retrieves the metadata about the resource.
Collection<ComplexValue>	getMultiValuedAttribute(String name) Get the values of a multi-valued attribute with the specified name.
Collection<ComplexValue>	getMultiValuedAttribute(String schema, String name) Get the values of the multi-valued attribute specified by schema and attribute name.
ResourceDescriptor	getResourceDescriptor() Retrieves the ResourceDescriptor for this resource.
SCIMObject	getScimObject() Retrieves the SCIMObject wrapped by this resource.
SimpleValue	getSimpleAttributeValue(String name) Get a simple attribute with the specified name.
SimpleValue	getSimpleAttributeValue(String schema, String name) Get a simple attribute with the specified name and schema.
<T> T	getSingularAttributeValue(String schema, String name, AttributeValueResolver<T> resolver) Retrieves a singular attribute value.
int	hashCode()
void	marshal(Marshaller marshaller, OutputStream outputStream) Marshals this response using the specified Marshaller to the specified OutputStream.
<T> void	setAttributeValues(String schema, String name, AttributeValueResolver<T> resolver, Collection<T> values) Sets a multi-valued attribute value.
void	setComplexAttribute(String name, ComplexValue attributeValue) Set a complex attribute value with the specified name.
void	setComplexAttribute(String schema, String name, ComplexValue attributeValue) Set a complex attribute value with the specified schema and name.
void	setExternalId(String externalId) Sets the unique identifier for the Resource as defined by the Service Consumer.
void	setId(String id) Sets the unique identifier for the SCIM Resource.
void	setMeta(Meta meta) Sets the metadata about the resource.
void	setMultiValuedAttribute(String name, Collection<ComplexValue> values) Set all values of a multi-valued attribute with the specified name.
void	setMultiValuedAttribute(String schema, String name, Collection<ComplexValue> values) Set all values of a multi-valued attribute with the specified schema and name.
void	setSimpleAttribute(String name, SimpleValue value) Set a simple attribute value with the specified name, using an AttributeValueResolver appropriate for the attribute data type.
void	setSimpleAttribute(String schema, String name, SimpleValue value) Set a simple attribute value with the specified schema and name, using an AttributeValueResolver appropriate for the attribute data type.
<T> void	setSingularAttributeValue(String schema, String name, AttributeValueResolver<T> resolver, T value) Sets a singular attribute value.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

BASE_RESOURCE_FACTORY

public static final ResourceFactory<BaseResource> BASE_RESOURCE_FACTORY

A ResourceFactory for creating BaseResource instances.

Constructor Detail

BaseResource

public BaseResource(ResourceDescriptor resourceDescriptor,
            SCIMObject scimObject)

Construct a BaseResource with the specified ResourceDescriptor and backed by the given SCIMObject.

Parameters:

resourceDescriptor - The resource descriptor for this SCIM resource.

scimObject - The SCIMObject containing all the SCIM attributes and their values.

BaseResource

public BaseResource(ResourceDescriptor resourceDescriptor)

Construct an empty BaseResource with the specified ResourceDescriptor.

Parameters:

resourceDescriptor - The resource descriptor for this SCIM resource.

Method Detail

getResourceDescriptor

public ResourceDescriptor getResourceDescriptor()

Retrieves the ResourceDescriptor for this resource.

Returns:

The ResourceDescriptor for this resource.

getScimObject

public SCIMObject getScimObject()

Retrieves the SCIMObject wrapped by this resource.

Returns:

The SCIMObject wrapped by this resource.

getId

public String getId()

Retrieves the unique identifier for the SCIM Resource as defined by the Service Provider.

Returns:

The unique identifier for the SCIM Resource as defined by the Service Provider.

setId

public void setId(String id)

Sets the unique identifier for the SCIM Resource.

Parameters:

id - The unique identifier for the SCIM Resource.

getExternalId

public String getExternalId()

Retrieves the unique identifier for the Resource as defined by the Service Consumer.

Returns:

The unique identifier for the Resource as defined by the Service Consumer.

setExternalId

public void setExternalId(String externalId)

Sets the unique identifier for the Resource as defined by the Service Consumer.

Parameters:

externalId - The unique identifier for the Resource as defined by the Service Consumer.

getMeta

public Meta getMeta()

Retrieves the metadata about the resource.

Returns:

The metadata about the resource.

setMeta

public void setMeta(Meta meta)

Sets the metadata about the resource.

Parameters:

meta - The metadata about the resource.

getSingularAttributeValue

public <T> T getSingularAttributeValue(String schema,
                              String name,
                              AttributeValueResolver<T> resolver)

Retrieves a singular attribute value.

Type Parameters:

T - The type of the resolved instance representing the value of sub-attribute.

Parameters:

schema - The schema URI of the attribute value to retrieve.

name - The name of the attribute value to retrieve.

resolver - The AttributeValueResolver the should be used to resolve the value to an instance.

Returns:

The resolved value instance or null if the specified attribute does not exist.

setSingularAttributeValue

public <T> void setSingularAttributeValue(String schema,
                                 String name,
                                 AttributeValueResolver<T> resolver,
                                 T value)
                               throws InvalidResourceException

Sets a singular attribute value.

Type Parameters:

T - The type of the resolved instance representing the value of sub-attribute.

Parameters:

schema - The schema URI of the attribute value to retrieve.

name - The name of the attribute value to retrieve.

resolver - The AttributeValueResolver the should be used to resolve the instance to attribute value.

value - The value instance.

Throws:

InvalidResourceException - if the attribute is not defined by the resource.

getAttributeValues

public <T> Collection<T> getAttributeValues(String schema,
                                   String name,
                                   AttributeValueResolver<T> resolver)

Retrieves a multi-valued attribute value.

Type Parameters:

T - The type of the resolved instance representing the value of sub-attribute.

Parameters:

schema - The schema URI of the attribute value to retrieve.

name - The name of the attribute value to retrieve.

resolver - The AttributeValueResolver the should be used to resolve the value to an instance.

Returns:

The collection of resolved value instances or null if the specified attribute does not exist.

setAttributeValues

public <T> void setAttributeValues(String schema,
                          String name,
                          AttributeValueResolver<T> resolver,
                          Collection<T> values)
                        throws InvalidResourceException

Sets a multi-valued attribute value.

Type Parameters:

T - The type of the resolved instance representing the value of sub-attribute.

Parameters:

schema - The schema URI of the attribute value to retrieve.

name - The name of the attribute value to retrieve.

resolver - The AttributeValueResolver the should be used to resolve the instance to attribute value.

values - The value instances.

Throws:

InvalidResourceException - if the attribute is not defined by the resource.

setSimpleAttribute

public void setSimpleAttribute(String name,
                      SimpleValue value)
                        throws InvalidResourceException

Set a simple attribute value with the specified name, using an AttributeValueResolver appropriate for the attribute data type.

Parameters:

name - the name of the attribute to be set, must be unique among all schemas in use by the Resource.

value - the new attribute value.

Throws:

InvalidResourceException - if no attribute with the specified name is defined on the Resource, if the name is ambiguous, or if the attribute is not of a simple data type.

setSimpleAttribute

public void setSimpleAttribute(String schema,
                      String name,
                      SimpleValue value)
                        throws InvalidResourceException

Set a simple attribute value with the specified schema and name, using an AttributeValueResolver appropriate for the attribute data type.

Parameters:

schema - Schema URI of the attribute to be set.

name - the name of the attribute to be set.

value - the new attribute value.

Throws:

InvalidResourceException - if no attribute with the specified name is defined by the schema, or if the attribute is not of a simple data type.

setComplexAttribute

public void setComplexAttribute(String name,
                       ComplexValue attributeValue)
                         throws InvalidResourceException

Set a complex attribute value with the specified name.

Parameters:

name - the name of the attribute to be set, must be unique among all schemas in use by the Resource.

attributeValue - ComplexValue object containing a map of sub-attribute names and values

Throws:

InvalidResourceException - if no attribute with the specified name is defined on the Resource, if the name is ambiguous, or if the attribute is not of a complex data type.

setComplexAttribute

public void setComplexAttribute(String schema,
                       String name,
                       ComplexValue attributeValue)
                         throws InvalidResourceException

Set a complex attribute value with the specified schema and name.

Parameters:

schema - Schema URI of the attribute to be set.

name - The name of the attribute to be set.

attributeValue - ComplexValue object containing a map of sub-attribute names and values.

Throws:

InvalidResourceException - if the name is not defined by the specified schema or the attribute is not of a complex data type.

setMultiValuedAttribute

public void setMultiValuedAttribute(String name,
                           Collection<ComplexValue> values)
                             throws InvalidResourceException

Set all values of a multi-valued attribute with the specified name. If the attribute already exists, all values are overwritten.

Parameters:

name - The name of the attribute to be set, must be unique among all schemas in use by the Resource.

values - A collection of complex attribute values.

Throws:

InvalidResourceException - if no attribute with the specified name is defined on the Resource, if the name is ambiguous, or if the attribute is not multi-valued.

setMultiValuedAttribute

public void setMultiValuedAttribute(String schema,
                           String name,
                           Collection<ComplexValue> values)
                             throws InvalidResourceException

Set all values of a multi-valued attribute with the specified schema and name. If the attribute already exists, all values are overwritten.

Parameters:

schema - Schema URI of the attribute to be set.

name - The name of the attribute to be set.

values - A collection of complex attribute values.

Throws:

InvalidResourceException - if the name is not defined by the specified schema or if the attribute is not multi-valued.

addOrReplaceMultiValuedValue

public void addOrReplaceMultiValuedValue(String name,
                                ComplexValue attributeValue)
                                  throws InvalidResourceException

Add or replace a value on a multi-valued attribute with the specified name. If the attribute includes a canonical type sub-attribute then a value matching the type will be overwritten. Otherwise the new value is added to the value list of the attribute.

Parameters:

name - The name of the attribute to be set, must be unique among all schemas in use by the Resource.

attributeValue - the complex attribute value.

Throws:

InvalidResourceException - if no attribute with the specified name is defined on the Resource, if the name is ambiguous, or if the attribute is not multi-valued.

addOrReplaceMultiValuedValue

public void addOrReplaceMultiValuedValue(String schema,
                                String name,
                                ComplexValue attributeValue)
                                  throws InvalidResourceException

Add or replace a value on a multi-valued attribute with the specified schema and name. If the attribute includes a canonical type sub-attribute then a value matching the type will be overwritten. Otherwise the new value is added to the value list of the attribute.

Parameters:

schema - Schema URI of the attribute to be set.

name - The name of the attribute to be set.

attributeValue - the complex attribute value .

Throws:

InvalidResourceException - if the attribute name is not defined by the specified schema or if the attribute is not multi-valued.

getSimpleAttributeValue

public SimpleValue getSimpleAttributeValue(String name)
                                    throws InvalidResourceException

Get a simple attribute with the specified name.

Parameters:

name - The name of the attribute to retrieve, must be unique among all schemas in use by the Resource.

Returns:

A SimpleValue, or null if the attribute is not present on this Resource instance.

Throws:

InvalidResourceException - if no attribute with the specified name is defined on the Resource, or if the name is ambiguous.

getSimpleAttributeValue

public SimpleValue getSimpleAttributeValue(String schema,
                                  String name)
                                    throws InvalidResourceException

Get a simple attribute with the specified name and schema.

Parameters:

schema - The schema URI of the attribute to retrieve.

name - The name of the attribute to retrieve.

Returns:

A SimpleValue, or null if the attribute is not present on this Resource instance.

Throws:

InvalidResourceException - if the attribute is not defined by the resource schema or is not of a simple type.

getComplexAttributeValue

public ComplexValue getComplexAttributeValue(String name)
                                      throws InvalidResourceException

Get a complex attribute with the specified name.

Parameters:

name - The name of the attribute to retrieve, must be unique among all schemas in use by the Resource.

Returns:

A ComplexValue, or null if the attribute is not present on this Resource instance.

Throws:

InvalidResourceException - if no attribute with the specified name is defined on the Resource, or if the name is ambiguous.

getComplexAttributeValue

public ComplexValue getComplexAttributeValue(String schema,
                                    String name)
                                      throws InvalidResourceException

Get a complex attribute with the specified name and schema.

Parameters:

schema - The schema URI of the attribute to retrieve.

name - The name of the attribute to retrieve.

Returns:

A ComplexValue, or null if the attribute is not present on this Resource instance.

Throws:

InvalidResourceException - if the attribute is not defined by the resource schema or is not complex.

getMultiValuedAttribute

public Collection<ComplexValue> getMultiValuedAttribute(String name)
                                                 throws InvalidResourceException

Get the values of a multi-valued attribute with the specified name.

Parameters:

name - The name of the attribute to retrieve, must be unique among all schemas in use by the Resource.

Returns:

A Collection of ComplexValue, one for each value instance, or null if the attribute is not present on this Resource instance.

Throws:

InvalidResourceException - if the attribute is not defined by this SCIMResource or if the attribute is not multi-valued.

getMultiValuedAttribute

public Collection<ComplexValue> getMultiValuedAttribute(String schema,
                                               String name)
                                                 throws InvalidResourceException

Get the values of the multi-valued attribute specified by schema and attribute name.

Parameters:

schema - The schema URI of the attribute to retrieve.

name - The name of the attribute to retrieve.

Returns:

A Collection of ComplexValue, one for each value instance, or null if the attribute is not present on this Resource instance.

Throws:

InvalidResourceException - if the attribute is not defined by this SCIMResource or if the attribute is not multi-valued.

marshal

public void marshal(Marshaller marshaller,
           OutputStream outputStream)
             throws Exception

Marshals this response using the specified Marshaller to the specified OutputStream.

Specified by:

marshal in interface SCIMResponse

Parameters:

marshaller - The Marshaller to use.

outputStream - The OutputStream to write to.

Throws:

Exception - if an error occurs while performing the marshaling.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object