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 and Description
DeleteBuilder(String baseUrl, ScimClientConfig scimClientConfig, Class<T> responseEntityType)

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.client.methods.HttpUriRequest	getHttpUriRequest() builds the request for the server
protected <T1 extends ScimResponse> Class<T1>	getResponseType(int responseCode) a delete-response if a status code of 204 is returned an error response in all other cases
DeleteBuilder<T>	setEndpoint(String endpoint)
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
DeleteBuilder<T>	setId(String id)

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

sendRequest, setResource, setResource

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteBuilder

public DeleteBuilder(String baseUrl,
                     ScimClientConfig scimClientConfig,
                     Class<T> responseEntityType)

Method Detail

setId

public DeleteBuilder<T> setId(String id)

Parameters:

resource - sets the resource id of the resource that should be delete from the server

setEndpoint

public DeleteBuilder<T> setEndpoint(String endpoint)

Overrides:

setEndpoint in class RequestBuilder<T extends ResourceNode>

Parameters:

endpoint - the resource endpoint path e.g. /Users or /Groups

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

getResponseType

protected <T1 extends ScimResponse> Class<T1> getResponseType(int responseCode)

a delete-response if a status code of 204 is returned an error response in all other cases

Specified by:

getResponseType in class RequestBuilder<T extends ResourceNode>

Parameters:

responseCode - the response code from the SCIM service

Returns:

the success response type or an ErrorResponse

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