Package de.captaingoldfish.scim.sdk.client.builder

Class ETagRequestBuilder<T extends ResourceNode>

java.lang.Object

de.captaingoldfish.scim.sdk.client.builder.RequestBuilder<T>

de.captaingoldfish.scim.sdk.client.builder.ETagRequestBuilder<T>

Direct Known Subclasses:

DeleteBuilder, GetBuilder, PatchBuilder, UpdateBuilder

public abstract class ETagRequestBuilder<T extends ResourceNode>
extends RequestBuilder<T>

author Pascal Knueppel
created at: 13.12.2019 - 09:02

an abstract class for request builder that may use etags in the requests

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ETagRequestBuilder(Class<T> responseEntityType, ScimHttpClient scimHttpClient)
	ETagRequestBuilder(String baseUrl, String endpoint, Class<T> responseEntityType, ScimHttpClient scimHttpClient)

Method Summary

Modifier and Type	Method	Description
protected ETag	getVersion()	the last known version of this resource
protected boolean	isUseIfMatch()	if the If-Match header should be used
protected boolean	isUseIfNoneMatch()	if the If-None-Match header should be used
ETagRequestBuilder<T>	setETagForIfMatch(ETag version)	uses the given version with a If-Match header in the request
ETagRequestBuilder<T>	setETagForIfMatch(String version)	uses the given version with a If-Match header in the request
ETagRequestBuilder<T>	setETagForIfNoneMatch(ETag version)	uses the given version with a If-Match header in the request
ETagRequestBuilder<T>	setETagForIfNoneMatch(String version)	uses the given version with a If-Match header in the request

Methods inherited from class de.captaingoldfish.scim.sdk.client.builder.RequestBuilder

addHeaderToRequest, getBaseUrl, getEndpoint, getHttpUriRequest, getResource, getResponseEntityType, getScimHttpClient, isExpectedResponseCode, isResponseParseable, sendRequest, sendRequest, sendRequestWithMultiHeaders, setResource, setResource, toResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

ETagRequestBuilder

protected ETagRequestBuilder(Class<T> responseEntityType,
                             ScimHttpClient scimHttpClient)

ETagRequestBuilder

public ETagRequestBuilder(String baseUrl,
                          String endpoint,
                          Class<T> responseEntityType,
                          ScimHttpClient scimHttpClient)

Method Detail

setETagForIfMatch

public ETagRequestBuilder<T> setETagForIfMatch(String version)

uses the given version with a If-Match header in the request

Parameters:

version - the version to use in the request

Returns:

this builder object

setETagForIfNoneMatch

public ETagRequestBuilder<T> setETagForIfNoneMatch(String version)

uses the given version with a If-Match header in the request

Parameters:

version - the version to use in the request

Returns:

this builder object

setETagForIfMatch

public ETagRequestBuilder<T> setETagForIfMatch(ETag version)

uses the given version with a If-Match header in the request

Parameters:

version - the version to use in the request

Returns:

this builder object

setETagForIfNoneMatch

public ETagRequestBuilder<T> setETagForIfNoneMatch(ETag version)

uses the given version with a If-Match header in the request

Parameters:

version - the version to use in the request

Returns:

this builder object

getVersion

protected ETag getVersion()

the last known version of this resource

isUseIfMatch

protected boolean isUseIfMatch()

if the If-Match header should be used

isUseIfNoneMatch

protected boolean isUseIfNoneMatch()

if the If-None-Match header should be used