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

Class ListBuilder.GetRequestBuilder<T extends ResourceNode>

java.lang.Object

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

de.captaingoldfish.scim.sdk.client.builder.ListBuilder.GetRequestBuilder<T>

Enclosing class:

ListBuilder<T extends ResourceNode>

public static class ListBuilder.GetRequestBuilder<T extends ResourceNode>
extends RequestBuilder<ListResponse<T>>

a request builder that builds the list-request as a http-get request

Field Summary

Fields

Modifier and Type	Field	Description
protected ListBuilder<T>	listBuilder	the original list builder instance

Constructor Summary

Constructors

Constructor	Description
GetRequestBuilder(ListBuilder<T> listBuilder)

Method Summary

Modifier and Type	Method	Description
ServerResponse<ListResponse<T>>	getAll()	this method can be used to retrieve all resources from the given startIndex of the given endpoint
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
protected Function<HttpResponse,Boolean>	isResponseParseable()	checks if the response contains a schema-uri that matches the value of SchemaUris.LIST_RESPONSE_URI
ListBuilder.GetRequestBuilder<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
protected ServerResponse<ListResponse<T>>	toResponse(HttpResponse response)	uses a custom response type that overrides the translation of the returned resource

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

addHeaderToRequest, getBaseUrl, getEndpoint, getRequiredHttpHeaders, getRequiredResponseHeaders, getResource, getResponseEntityType, getScimHttpClient, sendRequest, sendRequest, sendRequestWithMultiHeaders, setResource, setResource

Methods inherited from class java.lang.Object

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

Field Details

listBuilder

protected ListBuilder<T extends ResourceNode> listBuilder

the original list builder instance

Constructor Details

GetRequestBuilder

public GetRequestBuilder(ListBuilder<T> listBuilder)

Method Details

setExpectedResponseHeaders

public ListBuilder.GetRequestBuilder<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<ListResponse<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<ListResponse<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<ListResponse<T extends ResourceNode>>

isResponseParseable

protected Function<HttpResponse,Boolean> isResponseParseable()

checks if the response contains a schema-uri that matches the value of SchemaUris.LIST_RESPONSE_URI

Overrides:

isResponseParseable in class RequestBuilder<ListResponse<T extends ResourceNode>>

toResponse

protected ServerResponse<ListResponse<T>> toResponse(HttpResponse response)

uses a custom response type that overrides the translation of the returned resource

Overrides:

toResponse in class RequestBuilder<ListResponse<T extends ResourceNode>>

getAll

public ServerResponse<ListResponse<T>> getAll()

this method can be used to retrieve all resources from the given startIndex of the given endpoint