Package com.unboundid.scim2.client.requests

Class ModifyRequestBuilder.Generic<T extends com.unboundid.scim2.common.ScimResource>

java.lang.Object

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

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

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

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

Enclosing class:

ModifyRequestBuilder<T extends ModifyRequestBuilder<T>>

public static final class ModifyRequestBuilder.Generic<T extends com.unboundid.scim2.common.ScimResource>
extends ModifyRequestBuilder<ModifyRequestBuilder.Generic<T>>

A builder for SCIM modify requests for where the returned resource POJO type will be the same as the original.

Nested Class Summary

Nested classes/interfaces inherited from class com.unboundid.scim2.client.requests.ModifyRequestBuilder

ModifyRequestBuilder.Generic<T extends com.unboundid.scim2.common.ScimResource>, ModifyRequestBuilder.Typed

Field Summary

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

operations, version

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

attributes, excluded

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

headers, queryParams

Constructor Summary

Constructors

Constructor	Description
Generic(javax.ws.rs.client.WebTarget target, T resource)	Create a new generic modify request builder.

Method Summary

Modifier and Type	Method	Description
ModifyRequestBuilder.Generic<T>	ifMatch()	Modify the resource only if the resource has not been modified from the resource provided.
T	invoke()	Invoke the SCIM modify request.
<C> C	invoke(Class<C> cls)	Invoke the SCIM modify request.

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

addOperation, addValues, addValues, addValues, addValues, removeValues, removeValues, replaceValue, replaceValue, replaceValues, replaceValues, replaceValues, replaceValues

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

Constructor Detail

Generic

public Generic(javax.ws.rs.client.WebTarget target,
               T resource)

Create a new generic modify request builder.

Parameters:

target - The WebTarget to PATCH.

resource - The SCIM resource to retrieve.

Method Detail

ifMatch

public ModifyRequestBuilder.Generic<T> ifMatch()

Modify the resource only if the resource has not been modified from the resource provided.

Returns:

This builder.

invoke

public T invoke()
         throws com.unboundid.scim2.common.exceptions.ScimException

Invoke the SCIM modify request.

Returns:

The successfully modified SCIM resource.

Throws:

javax.ws.rs.ProcessingException - If a JAX-RS runtime exception occurred.

com.unboundid.scim2.common.exceptions.ScimException - If the SCIM service provider responded with an error.

invoke

public <C> C invoke(Class<C> cls)
             throws com.unboundid.scim2.common.exceptions.ScimException

Invoke the SCIM modify request.

Type Parameters:

C - The type of object to return.

Parameters:

cls - The Java class object used to determine the type to return.

Returns:

The successfully modified SCIM resource.

Throws:

javax.ws.rs.ProcessingException - If a JAX-RS runtime exception occurred.

com.unboundid.scim2.common.exceptions.ScimException - If the SCIM service provider responded with an error.