Package com.unboundid.scim2.client.requests

Class RetrieveRequestBuilder.Generic<T extends ScimResource>

java.lang.Object

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

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

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

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

Enclosing class:

RetrieveRequestBuilder<T extends RetrieveRequestBuilder<T>>

public static final class RetrieveRequestBuilder.Generic<T extends ScimResource>
extends RetrieveRequestBuilder<RetrieveRequestBuilder.Generic<T>>

A builder for SCIM retrieve 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.RetrieveRequestBuilder

RetrieveRequestBuilder.Generic<T extends ScimResource>, RetrieveRequestBuilder.Typed

Field Summary

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

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

Method Summary

Modifier and Type	Method	Description
RetrieveRequestBuilder.Generic<T>	ifNoneMatch()	Retrieve the resource only if the resource has been modified from the resource provided.
T	invoke()	Invoke the SCIM retrieve 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

Generic

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

Create a new generic retrieve request builder.

Parameters:

target - The WebTarget to GET.

resource - The SCIM resource to retrieve.

Method Detail

ifNoneMatch

public RetrieveRequestBuilder.Generic<T> ifNoneMatch()

Retrieve the resource only if the resource has been modified from the resource provided. If the resource has not been modified, the provided resource will be returned by invoke.

Returns:

This builder.

invoke

public T invoke()
         throws ScimException

Invoke the SCIM retrieve request.

Returns:

The successfully retrieved SCIM resource or the resource provided if the ifNoneMatch method was called and the resource has not been modified.

Throws:

ScimException - If an error occurred.

invoke

public <C> C invoke(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.