Package com.unboundid.scim2.client.requests

Class ReplaceRequestBuilder<T extends ScimResource>

java.lang.Object

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

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

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

public final class ReplaceRequestBuilder<T extends ScimResource>
extends ResourceReturningRequestBuilder<ReplaceRequestBuilder<T>>

A builder for SCIM replace requests.

Field Summary

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
ReplaceRequestBuilder(jakarta.ws.rs.client.WebTarget target, T resource)	Create a new replace request builder.

Method Summary

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

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

ReplaceRequestBuilder

public ReplaceRequestBuilder(@NotNull
                             jakarta.ws.rs.client.WebTarget target,
                             @NotNull
                             T resource)

Create a new replace request builder.

Parameters:

target - The WebTarget to PUT.

resource - The SCIM resource to replace.

Method Detail

ifMatch

@NotNull
public ReplaceRequestBuilder<T> ifMatch()

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

Returns:

This builder.

invoke

@NotNull
public T invoke()
         throws ScimException

Invoke the SCIM replace request.

Returns:

The successfully replaced SCIM resource.

Throws:

ScimException - If an error occurred.

invoke

@NotNull
public <C> C invoke(@NotNull
                    Class<C> cls)
             throws 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:

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

ScimException - If the SCIM service provider responded with an error.