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

Class DeleteBuilder<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.DeleteBuilder<T>

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

author Pascal Knueppel
created at: 16.12.2019 - 11:35

Constructor Summary

Constructors

Constructor	Description
DeleteBuilder(String fullUrl, Class<T> responseEntityType, ScimHttpClient scimHttpClient)	if the resource should be retrieved by using the fully qualified url
DeleteBuilder(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 Map<String,String>	getRequiredResponseHeaders()	a delete response does not require any response headers
protected boolean	isExpectedResponseCode(int httpStatus)	tells this abstract class if the http status from the server is the expected success status
DeleteBuilder<T>	setETagForIfMatch(ETag version)	uses the given version with a If-Match header in the request
DeleteBuilder<T>	setETagForIfMatch(String version)	uses the given version with a If-Match header in the request
DeleteBuilder<T>	setETagForIfNoneMatch(ETag version)	uses the given version with a If-Match header in the request
DeleteBuilder<T>	setETagForIfNoneMatch(String version)	uses the given version with a If-Match header in the request
protected DeleteBuilder<T>	setExpectedResponseHeaders(Map<String,String> requiredResponseHeaders)	Kept protected for delete requests to prevent misunderstandings.

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, getResource, getResponseEntityType, getScimHttpClient, 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 Details

DeleteBuilder

public DeleteBuilder(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

DeleteBuilder

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

Method Details

setExpectedResponseHeaders

protected DeleteBuilder<T> setExpectedResponseHeaders(Map<String,String> requiredResponseHeaders)

Kept protected for delete requests to prevent misunderstandings. The delete-response-header check is disabled by default because we do not expect any content-types on delete for example

Overrides:

setExpectedResponseHeaders in class RequestBuilder<T extends ResourceNode>

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

setETagForIfMatch

public DeleteBuilder<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 DeleteBuilder<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 DeleteBuilder<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 DeleteBuilder<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

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>

Returns:

a delete request to the desired resource

getRequiredResponseHeaders

protected Map<String,String> getRequiredResponseHeaders()

a delete response does not require any response headers

Overrides:

getRequiredResponseHeaders in class RequestBuilder<T extends ResourceNode>