Class RetrieveRequestBuilder.Typed
- java.lang.Object
-
- com.unboundid.scim2.client.requests.RequestBuilder<T>
-
- com.unboundid.scim2.client.requests.ResourceReturningRequestBuilder<T>
-
- com.unboundid.scim2.client.requests.RetrieveRequestBuilder<RetrieveRequestBuilder.Typed>
-
- com.unboundid.scim2.client.requests.RetrieveRequestBuilder.Typed
-
- Enclosing class:
- RetrieveRequestBuilder<T extends RetrieveRequestBuilder<T>>
public static final class RetrieveRequestBuilder.Typed extends RetrieveRequestBuilder<RetrieveRequestBuilder.Typed>
A builder for SCIM retrieve requests for where the returned resource POJO type will be provided.
-
-
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 Typed(jakarta.ws.rs.client.WebTarget target)
Create a new generic retrieve request builder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RetrieveRequestBuilder.Typed
ifNoneMatch(String version)
Retrieve the resource only if the resource has been modified since the provided version.<T> T
invoke(Class<T> cls)
Invoke the SCIM retrieve 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
-
-
-
-
Constructor Detail
-
Typed
public Typed(jakarta.ws.rs.client.WebTarget target)
Create a new generic retrieve request builder.- Parameters:
target
- The WebTarget to GET.
-
-
Method Detail
-
ifNoneMatch
public RetrieveRequestBuilder.Typed ifNoneMatch(String version)
Retrieve the resource only if the resource has been modified since the provided version. If the resource has not been modified, NotModifiedException will be thrown when calling invoke.- Parameters:
version
- The version of the resource to compare.- Returns:
- This builder.
-
invoke
public <T> T invoke(Class<T> cls) throws ScimException
Invoke the SCIM retrieve request.- Type Parameters:
T
- The type of object to return.- Parameters:
cls
- The Java class object used to determine the type to return.- Returns:
- The successfully retrieved SCIM resource.
- Throws:
jakarta.ws.rs.ProcessingException
- If a JAX-RS runtime exception occurred.ScimException
- If the SCIM service provider responded with an error.
-
-