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

Class CreateBuilder<T extends ResourceNode>

java.lang.Object

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

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

public class CreateBuilder<T extends ResourceNode>
extends RequestBuilder<T>

author Pascal Knueppel
created at: 07.12.2019 - 23:13

Constructor Summary

Constructors

Constructor	Description
CreateBuilder(String fullUrl, Class<T> responseEntityType, ScimHttpClient scimHttpClient)	if the resource should be retrieved by using the fully qualified url
CreateBuilder(String baseUrl, String endpoint, 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
ServerResponse<T>	sendRequest()	sends the defined request to the service provider
CreateBuilder<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
CreateBuilder<T>	setResource(com.fasterxml.jackson.databind.JsonNode resource)
CreateBuilder<T>	setResource(String resource)

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

CreateBuilder

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

CreateBuilder

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

Method Details

setExpectedResponseHeaders

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

sendRequest

public ServerResponse<T> sendRequest()

sends the defined request to the service provider

Overrides:

sendRequest in class RequestBuilder<T extends ResourceNode>

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

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()

builds the request for the server

Specified by:

getHttpUriRequest in class RequestBuilder<T extends ResourceNode>