de.captaingoldfish.scim.sdk.client.builder.DeleteBuilder Maven / Gradle / Ivy
// Generated by delombok at Sat Sep 14 21:26:51 CEST 2024
package de.captaingoldfish.scim.sdk.client.builder;
import java.util.HashMap;
import java.util.Map;
import org.apache.commons.lang3.StringUtils;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.entity.StringEntity;
import com.fasterxml.jackson.databind.JsonNode;
import de.captaingoldfish.scim.sdk.client.http.HttpDelete;
import de.captaingoldfish.scim.sdk.client.http.ScimHttpClient;
import de.captaingoldfish.scim.sdk.common.constants.HttpHeader;
import de.captaingoldfish.scim.sdk.common.constants.HttpStatus;
import de.captaingoldfish.scim.sdk.common.etag.ETag;
import de.captaingoldfish.scim.sdk.common.resources.ResourceNode;
/**
* author Pascal Knueppel
* created at: 16.12.2019 - 11:35
*
*/
public class DeleteBuilder extends ETagRequestBuilder
{
/**
* the fully qualified url to the required resource
*/
private final String fullUrl;
/**
* if the resource should be retrieved by using the fully qualified url
*
* @param fullUrl the fully qualified url to the required resource
* @param responseEntityType the type of the resource that should be returned
* @param scimHttpClient the http client instance
*/
public DeleteBuilder(String fullUrl, Class responseEntityType, ScimHttpClient scimHttpClient)
{
super(responseEntityType, scimHttpClient);
this.fullUrl = fullUrl;
}
public DeleteBuilder(String baseUrl,
String endpoint,
String resourceId,
Class responseEntityType,
ScimHttpClient scimHttpClient)
{
super(baseUrl, endpoint + (StringUtils.isBlank(resourceId) ? "" : "/" + resourceId), responseEntityType,
scimHttpClient);
this.fullUrl = null;
}
/**
* @param resource sets the resource that should be sent to the service provider
*/
public RequestBuilder setResource(String resource)
{
return super.setResource(resource);
}
/**
* @param resource sets the resource that should be sent to the service provider
*/
public RequestBuilder setResource(JsonNode resource)
{
return super.setResource(resource);
}
/**
* 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
*/
@Override
protected DeleteBuilder setExpectedResponseHeaders(Map requiredResponseHeaders)
{
return (DeleteBuilder)super.setExpectedResponseHeaders(requiredResponseHeaders);
}
/**
* {@inheritDoc}
*/
@Override
protected boolean isExpectedResponseCode(int httpStatus)
{
return HttpStatus.NO_CONTENT == httpStatus;
}
/**
* {@inheritDoc}
*/
@Override
public DeleteBuilder setETagForIfMatch(String version)
{
return (DeleteBuilder)super.setETagForIfMatch(version);
}
/**
* {@inheritDoc}
*/
@Override
public DeleteBuilder setETagForIfNoneMatch(String version)
{
return (DeleteBuilder)super.setETagForIfNoneMatch(version);
}
/**
* {@inheritDoc}
*/
@Override
public DeleteBuilder setETagForIfMatch(ETag version)
{
return (DeleteBuilder)super.setETagForIfMatch(version);
}
/**
* {@inheritDoc}
*/
@Override
public DeleteBuilder setETagForIfNoneMatch(ETag version)
{
return (DeleteBuilder)super.setETagForIfNoneMatch(version);
}
/**
* @return a delete request to the desired resource
*/
@Override
protected HttpUriRequest getHttpUriRequest()
{
try
{
HttpDelete httpDelete;
if (StringUtils.isBlank(fullUrl))
{
httpDelete = new HttpDelete(getBaseUrl() + getEndpoint());
}
else
{
httpDelete = new HttpDelete(fullUrl);
}
if (StringUtils.isNotBlank(getResource()))
{
httpDelete.setEntity(new StringEntity(getResource()));
}
if (isUseIfMatch())
{
httpDelete.setHeader(HttpHeader.IF_MATCH_HEADER, getVersion().toString());
}
if (isUseIfNoneMatch())
{
httpDelete.setHeader(HttpHeader.IF_NONE_MATCH_HEADER, getVersion().toString());
}
return httpDelete;
}
catch (final java.lang.Throwable $ex)
{
throw lombok.Lombok.sneakyThrow($ex);
}
}
/**
* a delete response does not require any response headers
*/
@Override
protected Map getRequiredResponseHeaders()
{
return new HashMap<>();
}
}