Package com.unboundid.scim2.client.requests

Class RequestBuilder<T extends RequestBuilder>

java.lang.Object

com.unboundid.scim2.client.requests.RequestBuilder<T>

Direct Known Subclasses:

DeleteRequestBuilder, ResourceReturningRequestBuilder

public class RequestBuilder<T extends RequestBuilder>
extends Object

Abstract SCIM request builder.

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.ws.rs.core.MultivaluedMap<String,Object>	headers	Arbitrary request headers.
protected jakarta.ws.rs.core.MultivaluedMap<String,Object>	queryParams	Arbitrary query parameters.

Method Summary

Modifier and Type	Method	Description
T	accept(String... acceptStrings)	Sets the media type(s) that are acceptable as a return from the server.
T	contentType(String contentType)	Sets the media type for any content sent to the server.
protected List<String>	getAccept()	Gets the media type(s) that are acceptable as a return from the server.
protected String	getContentType()	Gets the media type for any content sent to the server.
T	header(String name, Object... value)	Add an arbitrary HTTP header to the request.
T	queryParam(String name, Object... value)	Add an arbitrary query parameter to the request.
protected jakarta.ws.rs.client.WebTarget	target()	Returns the unbuilt WebTarget for the request.

Methods inherited from class java.lang.Object

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

Field Detail

headers

@NotNull
protected final jakarta.ws.rs.core.MultivaluedMap<String,Object> headers

Arbitrary request headers.

queryParams

@NotNull
protected final jakarta.ws.rs.core.MultivaluedMap<String,Object> queryParams

Arbitrary query parameters.

Method Detail

header

@NotNull
public T header(@NotNull
                String name,
                @NotNull
                Object... value)

Add an arbitrary HTTP header to the request.

Parameters:

name - The header name.

value - The header value(s).

Returns:

This builder.

contentType

@NotNull
public T contentType(@Nullable
                     String contentType)

Sets the media type for any content sent to the server. The default value is ApiConstants.MEDIA_TYPE_SCIM ("application/scim+json").

Parameters:

contentType - a string describing the media type of content sent to the server.

Returns:

This builder.

accept

@NotNull
public T accept(@NotNull
                String... acceptStrings)

Sets the media type(s) that are acceptable as a return from the server. The default accepted media types are ApiConstants.MEDIA_TYPE_SCIM ("application/scim+json") and MediaType.APPLICATION_JSON ("application/json")

Parameters:

acceptStrings - a string (or strings) describing the media type that will be accepted from the server. This parameter may not be null.

Returns:

This builder.

queryParam

@NotNull
public T queryParam(@NotNull
                    String name,
                    @NotNull
                    Object... value)

Add an arbitrary query parameter to the request.

Parameters:

name - The query parameter name.

value - The query parameter value(s).

Returns:

This builder.

target

@NotNull
protected jakarta.ws.rs.client.WebTarget target()

Returns the unbuilt WebTarget for the request. In most cases, buildTarget() should be used instead.

Returns:

The WebTarget for the request.

getContentType

@Nullable
protected String getContentType()

Gets the media type for any content sent to the server.

Returns:

the media type for any content sent to the server.

getAccept

@NotNull
protected List<String> getAccept()

Gets the media type(s) that are acceptable as a return from the server.

Returns:

the media type(s) that are acceptable as a return from the server.