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

The Laserfiche Repository Attributes API client.

Field Summary

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

baseUrl, httpClient, httpRequestHandler, objectMapper

Constructor Summary

Constructors

Constructor and Description
AttributesClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient, com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Summary

Modifier and Type	Method and Description
Attribute	getAttribute(ParametersForGetAttribute parameters) - Returns the attribute associated with the key.
AttributeCollectionResponse	listAttributes(ParametersForListAttributes parameters) - Returns the attribute key value pairs associated with the authenticated user.
void	listAttributesForEach(Function<AttributeCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListAttributes parameters) Provides the functionality to iteratively (i.e.
AttributeCollectionResponse	listAttributesNextLink(String nextLink, int maxPageSize) Returns the next subset of the requested collection, using a nextlink url.

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

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,
                            com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Detail

listAttributes

public AttributeCollectionResponse listAttributes(ParametersForListAttributes parameters)

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.
- 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.
- Default page size: 100. Allowed OData query options: Select, Count, OrderBy, Skip, Top, SkipToken, Prefer.
- Required OAuth scope: repository.Read

Specified by:

listAttributes in interface AttributesClient

Parameters:

parameters - An object of type ParametersForListAttributes which encapsulates the parameters of listAttributes method.

Returns:

AttributeCollectionResponse The return value

listAttributesNextLink

public AttributeCollectionResponse listAttributesNextLink(String nextLink,
                                                          int maxPageSize)

Description copied from interface: AttributesClient

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

Specified by:

listAttributesNextLink 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:

AttributeCollectionResponse The return value

listAttributesForEach

public void listAttributesForEach(Function<AttributeCollectionResponse,Boolean> callback,
                                  Integer maxPageSize,
                                  ParametersForListAttributes parameters)

Description copied from interface: AttributesClient

Provides the functionality to iteratively (i.e. through paging) call listAttributes, and apply a function on the response of each iteration.

Specified by:

listAttributesForEach 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.

parameters - An object of type ParametersForListAttributes which encapsulates the parameters of listAttributes method.

getAttribute

public Attribute getAttribute(ParametersForGetAttribute parameters)

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.
- Required OAuth scope: repository.Read

Specified by:

getAttribute in interface AttributesClient

Parameters:

parameters - An object of type ParametersForGetAttribute which encapsulates the parameters of getAttribute method.

Returns:

Attribute The return value