Package org.mockserver.scim

Class ScimShaper

java.lang.Object

org.mockserver.scim.ScimShaper

public class ScimShaper
extends Object

Shapes raw stored resources into SCIM 2.0 wire representations and builds the SCIM envelopes (ListResponse and Error). Responsible for injecting the schemas, id, and meta attributes every SCIM resource must carry.

SCIM responses use the application/scim+json media type and a small set of well-known schema URNs defined in RFC 7643/7644.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ScimShaper.ResourceType	The two SCIM resource types served by this provider, expressed as the singular resource name used in URLs (Users, Groups) mapped to its core schema URN.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final String	ERROR_SCHEMA
static final String	GROUP_SCHEMA
static final String	LIST_RESPONSE_SCHEMA
static final String	PATCH_OP_SCHEMA
static final String	SERVICE_PROVIDER_CONFIG_SCHEMA
static final String	USER_SCHEMA

Constructor Summary

Constructors

Constructor	Description
ScimShaper()

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	error(int status, String detail, String scimType)	Builds a SCIM Error envelope.
com.fasterxml.jackson.databind.node.ObjectNode	listResponse(List<com.fasterxml.jackson.databind.node.ObjectNode> resources, int totalResults, int startIndex)	Builds a SCIM ListResponse envelope around the supplied (already shaped) resources.
com.fasterxml.jackson.databind.node.ObjectNode	shapeResource(com.fasterxml.jackson.databind.node.ObjectNode stored, ScimShaper.ResourceType type, String publicBaseUrl, String basePath, boolean created)	Shapes a stored resource into its SCIM wire form: ensures schemas contains the resource's core schema, ensures id is present, and injects/refreshes meta.

Methods inherited from class java.lang.Object

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

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

USER_SCHEMA

public static final String USER_SCHEMA

See Also:

• Constant Field Values

GROUP_SCHEMA

public static final String GROUP_SCHEMA

See Also:

• Constant Field Values

LIST_RESPONSE_SCHEMA

public static final String LIST_RESPONSE_SCHEMA

See Also:

• Constant Field Values

ERROR_SCHEMA

public static final String ERROR_SCHEMA

See Also:

• Constant Field Values

PATCH_OP_SCHEMA

public static final String PATCH_OP_SCHEMA

See Also:

• Constant Field Values

SERVICE_PROVIDER_CONFIG_SCHEMA

public static final String SERVICE_PROVIDER_CONFIG_SCHEMA

See Also:

• Constant Field Values

Constructor Details

ScimShaper

public ScimShaper()

Method Details

shapeResource

public com.fasterxml.jackson.databind.node.ObjectNode shapeResource(com.fasterxml.jackson.databind.node.ObjectNode stored,
 ScimShaper.ResourceType type,
 String publicBaseUrl,
 String basePath,
 boolean created)

Shapes a stored resource into its SCIM wire form: ensures schemas contains the resource's core schema, ensures id is present, and injects/refreshes meta.

Parameters:

stored - the raw stored resource (already carries the persisted id)

type - the resource type (User/Group)

publicBaseUrl - scheme+authority for the meta.location (may be empty/null)

basePath - the provider base path (e.g. /scim/v2)

created - true when this is a freshly created resource (sets meta.created)

Returns:

a new shaped ObjectNode (the input is not mutated)

listResponse

public com.fasterxml.jackson.databind.node.ObjectNode listResponse(List<com.fasterxml.jackson.databind.node.ObjectNode> resources,
 int totalResults,
 int startIndex)

Builds a SCIM ListResponse envelope around the supplied (already shaped) resources.

Parameters:

resources - the page of resources to include

totalResults - total number of matching resources (before pagination)

startIndex - 1-based index of the first resource in this page

error

public com.fasterxml.jackson.databind.node.ObjectNode error(int status,
 String detail,
 String scimType)

Builds a SCIM Error envelope.

Parameters:

status - the HTTP status code (as a string, per RFC 7644)

detail - a human-readable description

scimType - the SCIM detail error keyword (may be null, e.g. for 401/404/500)