org.osiam.resources.scim

Class Extension

java.lang.Object

org.osiam.resources.scim.Extension

public class Extension
extends Object

This class represents a schema extension.

For more detailed information please look at the SCIM core schema 2.0, section 4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Extension.Field This class represents a field of an extension with its type and value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Extension() Default constructor for Jackson
	Extension(String urn) Constructs an extension with the given urn.

Method Summary

Methods

Modifier and Type	Method and Description
void	addOrUpdateField(String fieldName, BigDecimal value) Adds or updates the field specified by the given field name with the given value.
void	addOrUpdateField(String fieldName, BigInteger value) Adds or updates the field specified by the given field name with the given value.
void	addOrUpdateField(String fieldName, Boolean value) Adds or updates the field specified by the given field name with the given value.
void	addOrUpdateField(String fieldName, ByteBuffer value) Adds or updates the field specified by the given field name with the given value.
void	addOrUpdateField(String fieldName, Date value) Adds or updates the field specified by the given field name with the given value.
void	addOrUpdateField(String fieldName, String value) Adds or updates the field specified by the given field name with the given value.
<T> void	addOrUpdateField(String fieldName, T value, ExtensionFieldType<T> type) Adds or updates the field specified by the given field name with the given value of the given type.
void	addOrUpdateField(String fieldName, URI value) Adds or updates the field specified by the given field name with the given value.
boolean	equals(Object obj)
Map<String,Extension.Field>	getAllFields() Provides a Map containing the entries of the extension.
<T> T	getField(String field, ExtensionFieldType<T> extensionFieldType) Return the value for the field with a given name and type.
String	getUrn() Returns the URN of this extension.
int	hashCode()
boolean	isFieldPresent(String field) Checks if the given field is present in this extension because not every field is mandatory (according to scim 2.0 spec).

Methods inherited from class java.lang.Object

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

Constructor Detail

Extension

protected Extension()

Default constructor for Jackson

Extension

public Extension(String urn)

Constructs an extension with the given urn.

Parameters:

urn - the urn of the extension

Method Detail

getUrn

public String getUrn()

Returns the URN of this extension.

Returns:

The URN

getField

public <T> T getField(String field,
             ExtensionFieldType<T> extensionFieldType)

Return the value for the field with a given name and type.

Parameters:

field - The name of the field to retrieve the value of.

extensionFieldType - The type of the field.

Returns:

The value for the field with the given name.

Throws:

NoSuchElementException - if this schema does not contain a field of the given name.

IllegalArgumentException - if the given field is null or an empty string or if the extensionFieldType is null.

addOrUpdateField

public void addOrUpdateField(String fieldName,
                    String value)

Adds or updates the field specified by the given field name with the given value.

Parameters:

fieldName - the field name

value - the new value

addOrUpdateField

public void addOrUpdateField(String fieldName,
                    Boolean value)

Adds or updates the field specified by the given field name with the given value.

Parameters:

fieldName - the field name

value - the new value

addOrUpdateField

public void addOrUpdateField(String fieldName,
                    ByteBuffer value)

Adds or updates the field specified by the given field name with the given value.

Parameters:

fieldName - the field name

value - the new value

addOrUpdateField

public void addOrUpdateField(String fieldName,
                    BigInteger value)

Adds or updates the field specified by the given field name with the given value.

Parameters:

fieldName - the field name

value - the new value

addOrUpdateField

public void addOrUpdateField(String fieldName,
                    BigDecimal value)

Adds or updates the field specified by the given field name with the given value.

Parameters:

fieldName - the field name

value - the new value

addOrUpdateField

public void addOrUpdateField(String fieldName,
                    Date value)

Adds or updates the field specified by the given field name with the given value.

Parameters:

fieldName - the field name

value - the new value

addOrUpdateField

public void addOrUpdateField(String fieldName,
                    URI value)

Adds or updates the field specified by the given field name with the given value.

Parameters:

fieldName - the field name

value - the new value

addOrUpdateField

public <T> void addOrUpdateField(String fieldName,
                        T value,
                        ExtensionFieldType<T> type)

Adds or updates the field specified by the given field name with the given value of the given type.

Parameters:

fieldName - the field name

value - the new value

type - the scim type of the field

getAllFields

public Map<String,Extension.Field> getAllFields()

Provides a Map containing the entries of the extension. Note that the returned Map is immutable.

Returns:

The Entries of this schema as an map.

isFieldPresent

public boolean isFieldPresent(String field)

Checks if the given field is present in this extension because not every field is mandatory (according to scim 2.0 spec).

Parameters:

field - Name of the field to check

Returns:

true if the given field is present, else false

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object