com.unboundid.scim2.client.requests

Class ResourceReturningRequestBuilder<T extends ResourceReturningRequestBuilder>

java.lang.Object

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

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

Direct Known Subclasses:

CreateRequestBuilder, ModifyRequestBuilder, ReplaceRequestBuilder, RetrieveRequestBuilder, SearchRequestBuilder

public abstract class ResourceReturningRequestBuilder<T extends ResourceReturningRequestBuilder>
extends RequestBuilder<T>

Abstract SCIM request builder for resource returning requests.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	attributes The attribute list of include or exclude.
protected boolean	excluded Whether the attribute list is for excluded attributes.

Fields inherited from class com.unboundid.scim2.client.requests.RequestBuilder

headers, queryParams

Method Summary

Modifier and Type	Method and Description
T	attributes(String... attributes) Specifies a multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default.
T	excludedAttributes(String... excludedAttributes) Specifies a multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return.

Methods inherited from class com.unboundid.scim2.client.requests.RequestBuilder

accept, contentType, getAccept, getContentType, header, queryParam, target

Methods inherited from class java.lang.Object

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

Field Detail

excluded

protected boolean excluded

Whether the attribute list is for excluded attributes.

attributes

protected Set<String> attributes

The attribute list of include or exclude.

Method Detail

attributes

public T attributes(String... attributes)

Specifies a multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Any existing excluded attributes will be removed.

Parameters:

attributes - the names of resource attributes to return

Returns:

This builder.

excludedAttributes

public T excludedAttributes(String... excludedAttributes)

Specifies a multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. Any existing attributes to return will be removed.

Parameters:

excludedAttributes - names of resource attributes to be removed from the default set of attributes to return.

Returns:

This builder.