de.captaingoldfish.scim.sdk.client.builder

Class RequestBuilder<T extends ResourceNode>

java.lang.Object

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

Direct Known Subclasses:

CreateBuilder, ETagRequestBuilder, ListBuilder.GetRequestBuilder, ListBuilder.PostRequestBuilder

public abstract class RequestBuilder<T extends ResourceNode>
extends Object

author Pascal Knueppel
created at: 07.12.2019 - 23:15

an abstract request builder implementation

Constructor Summary

Constructors

Constructor and Description
RequestBuilder(String baseUrl, ScimClientConfig scimClientConfig, Class<T> responseEntityType)

Method Summary

Modifier and Type	Method and Description
protected abstract org.apache.http.client.methods.HttpUriRequest	getHttpUriRequest() builds the request for the server
protected abstract <T extends ScimResponse> Class<T>	getResponseType(int responseCode) each SCIM endpoint must respond with specific response codes in order to acknowledge a request as successful
ScimServerResponse<T>	sendRequest() sends the defined request to the service provider
protected RequestBuilder<T>	setEndpoint(String endpoint)
protected RequestBuilder<T>	setResource(com.fasterxml.jackson.databind.JsonNode resource)
protected RequestBuilder<T>	setResource(String resource)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestBuilder

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

Method Detail

setEndpoint

protected RequestBuilder<T> setEndpoint(String endpoint)

Parameters:

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

setResource

protected RequestBuilder<T> setResource(String resource)

Parameters:

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

setResource

protected RequestBuilder<T> setResource(com.fasterxml.jackson.databind.JsonNode resource)

Parameters:

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

getResponseType

protected abstract <T extends ScimResponse> Class<T> getResponseType(int responseCode)

each SCIM endpoint must respond with specific response codes in order to acknowledge a request as successful

Parameters:

responseCode - the response code from the SCIM service

Returns:

the success response type or an ErrorResponse

sendRequest

public ScimServerResponse<T> sendRequest()

sends the defined request to the service provider

Returns:

the response from the given request. A response must not be returned in any case from the service provider so the returned type is still optional

getHttpUriRequest

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

builds the request for the server