com.laserfiche.repository.api.clients.impl

Class AttributesClientImpl

java.lang.Object

com.laserfiche.repository.api.clients.impl.ApiClient

com.laserfiche.repository.api.clients.impl.AttributesClientImpl

All Implemented Interfaces:

AttributesClient

public class AttributesClientImpl
extends ApiClient
implements AttributesClient

Field Summary

Fields inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

baseUrl, httpClient, objectMapper

Constructor Summary

Constructors

Constructor and Description
AttributesClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<ODataValueContextOfListOfAttribute>	getTrusteeAttributeKeyValuePairs(String repoId, Boolean everyone, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count) - Returns the attribute key value pairs associated with the authenticated user.
CompletableFuture<Void>	getTrusteeAttributeKeyValuePairsForEach(Function<CompletableFuture<ODataValueContextOfListOfAttribute>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, Boolean everyone, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count) Provides the functionality to iteratively (i.e.
CompletableFuture<ODataValueContextOfListOfAttribute>	getTrusteeAttributeKeyValuePairsNextLink(String nextLink, Integer maxPageSize) Returns the next subset of the requested collection, using a nextlink url.
CompletableFuture<Attribute>	getTrusteeAttributeValueByKey(String repoId, String attributeKey, Boolean everyone) - Returns the attribute associated with the key.

Methods inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

decideErrorMessage, deserializeToProblemDetails, getHeadersMap, getNonNullParameters, mergeMaxSizeIntoPrefer, toJson

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributesClientImpl

public AttributesClientImpl(String baseUrl,
                            kong.unirest.UnirestInstance httpClient)

Method Detail

getTrusteeAttributeValueByKey

public CompletableFuture<Attribute> getTrusteeAttributeValueByKey(String repoId,
                                                                  String attributeKey,
                                                                  Boolean everyone)

Description copied from interface: AttributesClient

- Returns the attribute associated with the key. Alternatively, return the attribute associated with the key within "Everyone" group. - Optional query parameters: everyone (bool, default false). When true, the server only searches for the attribute value with the given key upon the authenticated users attributes. If false, only the authenticated users attributes will be queried.

Specified by:

getTrusteeAttributeValueByKey in interface AttributesClient

Parameters:

repoId - The requested repository ID.

attributeKey - The requested attribute key.

everyone - Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user.

Returns:

CompletableFuture<Attribute> The return value

getTrusteeAttributeKeyValuePairs

public CompletableFuture<ODataValueContextOfListOfAttribute> getTrusteeAttributeKeyValuePairs(String repoId,
                                                                                              Boolean everyone,
                                                                                              String prefer,
                                                                                              String select,
                                                                                              String orderby,
                                                                                              Integer top,
                                                                                              Integer skip,
                                                                                              Boolean count)

Description copied from interface: AttributesClient

- Returns the attribute key value pairs associated with the authenticated user. Alternatively, return only the attribute key value pairs that are associated with the "Everyone" group. - Attribute keys can be used with subsequent calls to get specific attribute values. - Default page size: 100. Allowed OData query options: Select, Count, OrderBy, Skip, Top, SkipToken, Prefer. Optional query parameters: everyone (bool, default false). When true, this route does not return the attributes that are tied to the currently authenticated user, but rather the attributes assigned to the "Everyone" group. Note when this is true, the response does not include both the "Everyone" groups attribute and the currently authenticated user, but only the "Everyone" groups.

Specified by:

getTrusteeAttributeKeyValuePairs in interface AttributesClient

Parameters:

repoId - The requested repository ID.

everyone - Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user.

prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

select - Limits the properties returned in the result.

orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.

top - Limits the number of items returned from a collection.

skip - Excludes the specified number of items of the queried collection from the result.

count - Indicates whether the total count of items within a collection are returned in the result.

Returns:

CompletableFuture<ODataValueContextOfListOfAttribute> The return value

getTrusteeAttributeKeyValuePairsNextLink

public CompletableFuture<ODataValueContextOfListOfAttribute> getTrusteeAttributeKeyValuePairsNextLink(String nextLink,
                                                                                                      Integer maxPageSize)

Description copied from interface: AttributesClient

Returns the next subset of the requested collection, using a nextlink url.

Specified by:

getTrusteeAttributeKeyValuePairsNextLink in interface AttributesClient

Parameters:

nextLink - A url that allows retrieving the next subset of the requested collection.

maxPageSize - Optionally specify the maximum number of items to retrieve.

Returns:

CompletableFuture<ODataValueContextOfListOfAttribute> The return value

getTrusteeAttributeKeyValuePairsForEach

public CompletableFuture<Void> getTrusteeAttributeKeyValuePairsForEach(Function<CompletableFuture<ODataValueContextOfListOfAttribute>,CompletableFuture<Boolean>> callback,
                                                                       Integer maxPageSize,
                                                                       String repoId,
                                                                       Boolean everyone,
                                                                       String prefer,
                                                                       String select,
                                                                       String orderby,
                                                                       Integer top,
                                                                       Integer skip,
                                                                       Boolean count)

Description copied from interface: AttributesClient

Provides the functionality to iteratively (i.e. through paging) call <b>getTrusteeAttributeKeyValuePairs</b>, and apply a function on the response of each iteration.

Specified by:

getTrusteeAttributeKeyValuePairsForEach in interface AttributesClient

Parameters:

callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.

maxPageSize - Optionally specify the maximum number of items to retrieve.

repoId - The requested repository ID.

everyone - Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user.

prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

select - Limits the properties returned in the result.

orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.

top - Limits the number of items returned from a collection.

skip - Excludes the specified number of items of the queried collection from the result.

count - Indicates whether the total count of items within a collection are returned in the result.

Returns:

CompletableFuture<Void> The return value