com.sap.scimono.entity

Class Resource<T>

java.lang.Object

com.sap.scimono.entity.Resource<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Group, ResourceType, Schema, ServiceProviderConfig, User

public abstract class Resource<T>
extends Object
implements Serializable

This class represents a SCIM Resource and is the base class for Users and Groups. All sub-resources (User/Group/custom) need to be in the same Java package or JSON deserialization will break. It is possible to include extra metadata in the JSON to make deserialization work but it won't be compliant with the SCIM specification.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Resource.Builder<T> The Builder class is used to construct instances of the Resource

Field Summary

Fields

Modifier and Type	Field and Description
static String	CORE_SCHEMA

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Resource(Resource.Builder<T> builder)
protected	Resource(String id, String externalId, Meta meta, Set<String> schemas)

Method Summary

Modifier and Type	Method and Description
abstract Resource.Builder<T>	builder()
boolean	equals(Object obj)
Map<String,Extension>	getCustomExtensions()
Extension	getExtension(String urn) Provides the Extension with the given URN
Map<String,Extension>	getExtensions() Provides an unmodifiable view of all additional Extension fields of the user
String	getExternalId() Gets the external Id of the resource.
String	getId() Gets the Id of the resource.
Meta	getMeta() Gets the meta attribute
@NotNull @Size(min=1) Set<String>	getSchemas() Gets the list of defined schemas
void	handleExtensionSchema(String schemaId, Object value)
boolean	hasCustomExtensions()
boolean	hasExtensions()
int	hashCode()
boolean	isExtensionPresent(String urn) Checks if an extension with the given urn is present because an extension is not returned if no field is set

Methods inherited from class java.lang.Object

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

Field Detail

CORE_SCHEMA

public static final String CORE_SCHEMA

See Also:

Constant Field Values

Constructor Detail

Resource

protected Resource(String id,
                   String externalId,
                   Meta meta,
                   Set<String> schemas)

Resource

protected Resource(Resource.Builder<T> builder)

Method Detail

getId

public String getId()

Gets the Id of the resource.

Returns:

the id of the resource

getExternalId

public String getExternalId()

Gets the external Id of the resource.

For more information please look at SCIM core schema 2.0, section 5.1

Returns:

the externalId

getMeta

public Meta getMeta()

Gets the meta attribute

Returns:

the meta

getSchemas

@NotNull
 @Size(min=1)
public @NotNull @Size(min=1) Set<String> getSchemas()

Gets the list of defined schemas

Returns:

a the list of schemas as a Set

getExtensions

public Map<String,Extension> getExtensions()

Provides an unmodifiable view of all additional Extension fields of the user

Returns:

an unmodifiable view of the extensions

getExtension

public Extension getExtension(String urn)

Provides the Extension with the given URN

Parameters:

urn - The URN of the extension

Returns:

The extension for the given URN

Throws:

IllegalArgumentException - If urn is null or empty

NoSuchElementException - If extension with given urn is not available

isExtensionPresent

public boolean isExtensionPresent(String urn)

Checks if an extension with the given urn is present because an extension is not returned if no field is set

Parameters:

urn - urn of the extension

Returns:

true if the given extension is present, else false

hasExtensions

public boolean hasExtensions()

hasCustomExtensions

public boolean hasCustomExtensions()

getCustomExtensions

public Map<String,Extension> getCustomExtensions()

handleExtensionSchema

public void handleExtensionSchema(String schemaId,
                                  Object value)

builder

public abstract Resource.Builder<T> builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object