Package com.unboundid.scim2.client.requests

Class ModifyRequestBuilder<T extends ModifyRequestBuilder<T>>

java.lang.Object

com.unboundid.scim2.client.requests.RequestBuilder<T>

com.unboundid.scim2.client.requests.ResourceReturningRequestBuilder<T>

com.unboundid.scim2.client.requests.ModifyRequestBuilder<T>

Direct Known Subclasses:

ModifyRequestBuilder.Generic, ModifyRequestBuilder.Typed

public abstract class ModifyRequestBuilder<T extends ModifyRequestBuilder<T>>
extends ResourceReturningRequestBuilder<T>

A builder for SCIM modify requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModifyRequestBuilder.Generic<T extends com.unboundid.scim2.common.ScimResource>	A builder for SCIM modify requests for where the returned resource POJO type will be the same as the original.
static class	ModifyRequestBuilder.Typed	A builder for SCIM modify requests for where the returned resource POJO type will be provided.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<com.unboundid.scim2.common.messages.PatchOperation>	operations	The list of patch operations to include in the request.
protected String	version	The version to match.

Fields inherited from class com.unboundid.scim2.client.requests.ResourceReturningRequestBuilder

attributes, excluded

Fields inherited from class com.unboundid.scim2.client.requests.RequestBuilder

headers, queryParams

Method Summary

Modifier and Type	Method	Description
T	addOperation(com.unboundid.scim2.common.messages.PatchOperation op)	Add a new patch operation this this patch request.
T	addValues(com.unboundid.scim2.common.Path path, Object... objects)	Add values to the multi-valued attribute specified by the path.
T	addValues(com.unboundid.scim2.common.Path path, Collection<?> objects)	Add values to the multi-valued attribute specified by the path.
T	addValues(String path, Object... objects)	Add values to the multi-valued attribute specified by the path.
T	addValues(String path, Collection<?> objects)	Add values to the multi-valued attribute specified by the path.
T	removeValues(com.unboundid.scim2.common.Path path)	Remove all values of the attribute specified by the path.
T	removeValues(String path)	Remove all values of the attribute specified by the path.
T	replaceValue(com.unboundid.scim2.common.Path path, Object object)	Set value of the attribute specified by the path, replacing any existing value(s).
T	replaceValue(String path, Object object)	Set value of the attribute specified by the path, replacing any existing value(s).
T	replaceValues(com.unboundid.scim2.common.Path path, Object... objects)	Set values of the attribute specified by the path, replacing any existing values.
T	replaceValues(com.unboundid.scim2.common.Path path, Collection<Object> objects)	Set values of the attribute specified by the path, replacing any existing values.
T	replaceValues(String path, Object... objects)	Set values of the attribute specified by the path, replacing any existing values.
T	replaceValues(String path, Collection<Object> objects)	Set values of the attribute specified by the path, replacing any existing values.

Methods inherited from class com.unboundid.scim2.client.requests.ResourceReturningRequestBuilder

attributes, excludedAttributes

Methods inherited from class com.unboundid.scim2.client.requests.RequestBuilder

accept, contentType, getAccept, getContentType, header, queryParam, target

Methods inherited from class java.lang.Object

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

Field Detail

operations

protected final List<com.unboundid.scim2.common.messages.PatchOperation> operations

The list of patch operations to include in the request.

version

protected String version

The version to match.

Method Detail

replaceValue

public T replaceValue(String path,
                      Object object)
               throws com.unboundid.scim2.common.exceptions.ScimException

Set value of the attribute specified by the path, replacing any existing value(s).

Parameters:

path - The path to the attribute whose value to set.

object - The value to set.

Returns:

This patch operation request.

Throws:

com.unboundid.scim2.common.exceptions.ScimException - If the path is invalid.

replaceValue

public T replaceValue(com.unboundid.scim2.common.Path path,
                      Object object)

Set value of the attribute specified by the path, replacing any existing value(s).

Parameters:

path - The path to the attribute whose value to set.

object - The value to set.

Returns:

This patch operation request.

replaceValues

public T replaceValues(String path,
                       Collection<Object> objects)
                throws com.unboundid.scim2.common.exceptions.ScimException

Set values of the attribute specified by the path, replacing any existing values.

Parameters:

path - The path to the attribute whose value to set.

objects - The value(s) to set.

Returns:

This patch operation request.

Throws:

com.unboundid.scim2.common.exceptions.ScimException - If the path is invalid.

replaceValues

public T replaceValues(com.unboundid.scim2.common.Path path,
                       Collection<Object> objects)

Set values of the attribute specified by the path, replacing any existing values.

Parameters:

path - The path to the attribute whose value to set.

objects - The value(s) to set.

Returns:

This patch operation request.

replaceValues

public T replaceValues(String path,
                       Object... objects)
                throws com.unboundid.scim2.common.exceptions.ScimException

Set values of the attribute specified by the path, replacing any existing values.

Parameters:

path - The path to the attribute whose value to set.

objects - The value(s) to set.

Returns:

This patch operation request.

Throws:

com.unboundid.scim2.common.exceptions.ScimException - If the path is invalid.

replaceValues

public T replaceValues(com.unboundid.scim2.common.Path path,
                       Object... objects)

Set values of the attribute specified by the path, replacing any existing values.

Parameters:

path - The path to the attribute whose value to set.

objects - The value(s) to set.

Returns:

This patch operation request.

addValues

public T addValues(String path,
                   Collection<?> objects)
            throws com.unboundid.scim2.common.exceptions.ScimException

Add values to the multi-valued attribute specified by the path.

Parameters:

path - The path to the multi-valued attribute.

objects - The values to add.

Returns:

This patch operation request.

Throws:

com.unboundid.scim2.common.exceptions.ScimException - If the path is invalid.

addValues

public T addValues(com.unboundid.scim2.common.Path path,
                   Collection<?> objects)

Add values to the multi-valued attribute specified by the path.

Parameters:

path - The path to the multi-valued attribute.

objects - The values to add.

Returns:

This patch operation request.

addValues

public T addValues(String path,
                   Object... objects)
            throws com.unboundid.scim2.common.exceptions.ScimException

Add values to the multi-valued attribute specified by the path.

Parameters:

path - The path to the multi-valued attribute.

objects - The values to add.

Returns:

This patch operation request.

Throws:

com.unboundid.scim2.common.exceptions.ScimException - If the path is invalid.

addValues

public T addValues(com.unboundid.scim2.common.Path path,
                   Object... objects)

Add values to the multi-valued attribute specified by the path.

Parameters:

path - The path to the multi-valued attribute.

objects - The values to add.

Returns:

This patch operation request.

removeValues

public T removeValues(String path)
               throws com.unboundid.scim2.common.exceptions.ScimException

Remove all values of the attribute specified by the path.

Parameters:

path - The path to the attribute whose value to remove.

Returns:

This patch operation request.

Throws:

com.unboundid.scim2.common.exceptions.ScimException - If the path is invalid.

removeValues

public T removeValues(com.unboundid.scim2.common.Path path)
               throws com.unboundid.scim2.common.exceptions.ScimException

Remove all values of the attribute specified by the path.

Parameters:

path - The path to the attribute whose value to remove.

Returns:

This patch operation request.

Throws:

com.unboundid.scim2.common.exceptions.ScimException - If the path is invalid.

addOperation

public T addOperation(com.unboundid.scim2.common.messages.PatchOperation op)

Add a new patch operation this this patch request.

Parameters:

op - The patch operation to add.

Returns:

This patch operation request.