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

Class UpdateBuilder<T extends ResourceNode>

java.lang.Object

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

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

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

public class UpdateBuilder<T extends ResourceNode>
extends ETagRequestBuilder<T>

author Pascal Knueppel
created at: 16.12.2019 - 12:04

Constructor Summary

Constructors

Constructor	Description
UpdateBuilder(String fullUrl, Class<T> responseEntityType, ScimHttpClient scimHttpClient)	if the resource should be retrieved by using the fully qualified url
UpdateBuilder(String baseUrl, String endpoint, String resourceId, Class<T> responseEntityType, ScimHttpClient scimHttpClient)

Method Summary

Modifier and Type	Method	Description
protected org.apache.http.client.methods.HttpUriRequest	getHttpUriRequest()	builds the request for the server
protected boolean	isExpectedResponseCode(int httpStatus)	tells this abstract class if the http status from the server is the expected success status
UpdateBuilder<T>	setETagForIfMatch(ETag version)	uses the given version with a If-Match header in the request
UpdateBuilder<T>	setETagForIfMatch(String version)	uses the given version with a If-Match header in the request
UpdateBuilder<T>	setETagForIfNoneMatch(ETag version)	uses the given version with a If-Match header in the request
UpdateBuilder<T>	setETagForIfNoneMatch(String version)	uses the given version with a If-Match header in the request
UpdateBuilder<T>	setExpectedResponseHeaders(Map<String,String> requiredResponseHeaders)	Set this if the SCIM provider is not behaving SCIM compliant by manipulating the expected headers that will be returned from the server null: The headers are checked as normally for the content-type "application/scim+json" empty map: The check of response headers is disabled filled map: The check of the response headers will be done with the entries of this map
UpdateBuilder<T>	setResource(com.fasterxml.jackson.databind.JsonNode resource)
UpdateBuilder<T>	setResource(String resource)

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

getVersion, isUseIfMatch, isUseIfNoneMatch

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

addHeaderToRequest, getBaseUrl, getEndpoint, getRequiredHttpHeaders, getRequiredResponseHeaders, getResource, getResponseEntityType, getScimHttpClient, isResponseParseable, sendRequest, sendRequest, sendRequestWithMultiHeaders, toResponse

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateBuilder

public UpdateBuilder(String fullUrl,
 Class<T> responseEntityType,
 ScimHttpClient scimHttpClient)

if the resource should be retrieved by using the fully qualified url

Parameters:

fullUrl - the fully qualified url to the required resource

responseEntityType - the type of the resource that should be returned

scimHttpClient - the http client instance

UpdateBuilder

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

Method Details

setExpectedResponseHeaders

public UpdateBuilder<T> setExpectedResponseHeaders(Map<String,String> requiredResponseHeaders)

Set this if the SCIM provider is not behaving SCIM compliant by manipulating the expected headers that will be returned from the server

• null: The headers are checked as normally for the content-type "application/scim+json"
• empty map: The check of response headers is disabled
• filled map: The check of the response headers will be done with the entries of this map

Overrides:

setExpectedResponseHeaders in class RequestBuilder<T extends ResourceNode>

setResource

public UpdateBuilder<T> setResource(String resource)

Overrides:

setResource in class RequestBuilder<T extends ResourceNode>

Parameters:

resource - sets the resource that should be sent to the service provider

setResource

public UpdateBuilder<T> setResource(com.fasterxml.jackson.databind.JsonNode resource)

Overrides:

setResource in class RequestBuilder<T extends ResourceNode>

Parameters:

resource - sets the resource that should be sent to the service provider

setETagForIfMatch

public UpdateBuilder<T> setETagForIfMatch(String version)

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

Overrides:

setETagForIfMatch in class ETagRequestBuilder<T extends ResourceNode>

Parameters:

version - the version to use in the request

Returns:

this builder object

setETagForIfNoneMatch

public UpdateBuilder<T> setETagForIfNoneMatch(String version)

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

Overrides:

setETagForIfNoneMatch in class ETagRequestBuilder<T extends ResourceNode>

Parameters:

version - the version to use in the request

Returns:

this builder object

setETagForIfMatch

public UpdateBuilder<T> setETagForIfMatch(ETag version)

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

Overrides:

setETagForIfMatch in class ETagRequestBuilder<T extends ResourceNode>

Parameters:

version - the version to use in the request

Returns:

this builder object

setETagForIfNoneMatch

public UpdateBuilder<T> setETagForIfNoneMatch(ETag version)

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

Overrides:

setETagForIfNoneMatch in class ETagRequestBuilder<T extends ResourceNode>

Parameters:

version - the version to use in the request

Returns:

this builder object

isExpectedResponseCode

protected boolean isExpectedResponseCode(int httpStatus)

tells this abstract class if the http status from the server is the expected success status

Specified by:

isExpectedResponseCode in class RequestBuilder<T extends ResourceNode>

Parameters:

httpStatus - the http status from the server

Returns:

true if the response status shows success

getHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest getHttpUriRequest()

Description copied from class: RequestBuilder

builds the request for the server

Specified by:

getHttpUriRequest in class RequestBuilder<T extends ResourceNode>