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

Class GetBuilder<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.GetBuilder<T>

public class GetBuilder<T extends ResourceNode>
extends ETagRequestBuilder<T>

author Pascal Knueppel
created at: 13.12.2019 - 08:21

Constructor Summary

Constructors

Constructor	Description
GetBuilder(String fullUrl, Class<T> responseEntityType, ScimHttpClient scimHttpClient)	if the resource should be retrieved by using the fully qualified url
GetBuilder(String baseUrl, String endpoint, String resourceId, 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
GetBuilder<T>	setETagForIfMatch(ETag version)	uses the given version with a If-Match header in the request
GetBuilder<T>	setETagForIfMatch(String version)	uses the given version with a If-Match header in the request
GetBuilder<T>	setETagForIfNoneMatch(ETag version)	uses the given version with a If-Match header in the request
GetBuilder<T>	setETagForIfNoneMatch(String version)	uses the given version with a If-Match header in the request

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

getVersion, isUseIfMatch, isUseIfNoneMatch

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

addHeaderToRequest, getBaseUrl, getEndpoint, getResource, getResponseEntityType, getScimHttpClient, isResponseParseable, sendRequest, sendRequest, sendRequestWithMultiHeaders, setResource, setResource, toResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

GetBuilder

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

GetBuilder

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

Method Detail

setETagForIfMatch

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

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

Description copied from class: RequestBuilder

builds the request for the server

Specified by:

getHttpUriRequest in class RequestBuilder<T extends ResourceNode>

Returns:

a get request to the desired resource