com.laserfiche.repository.api

Class RepositoryApiClientImpl

java.lang.Object

com.laserfiche.repository.api.RepositoryApiClientImpl

All Implemented Interfaces:

RepositoryApiClient, AutoCloseable

public class RepositoryApiClientImpl
extends Object
implements RepositoryApiClient, AutoCloseable

The Laserfiche Repository API client.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RepositoryApiClientImpl(String baseUrl, com.laserfiche.api.client.httphandlers.HttpRequestHandler httpHandler)

Method Summary

Modifier and Type	Method and Description
void	close() Release the thread pool held by the underlying HTTP clients.
static RepositoryApiClient	createFromAccessKey(String servicePrincipalKey, com.laserfiche.api.client.model.AccessKey accessKey) Creates a new Laserfiche repository client that will use Laserfiche Cloud OAuth client credentials to get access tokens.
static RepositoryApiClient	createFromAccessKey(String servicePrincipalKey, com.laserfiche.api.client.model.AccessKey accessKey, String scope) Creates a new Laserfiche repository client that will use Laserfiche Cloud OAuth client credentials to get access tokens.
static RepositoryApiClient	createFromAccessKey(String servicePrincipalKey, com.laserfiche.api.client.model.AccessKey accessKey, String scope, String baseUrlDebug) Creates a new Laserfiche repository client that will use Laserfiche Cloud OAuth client credentials to get access tokens.
static RepositoryApiClient	createFromUsernamePassword(String repositoryId, String username, String password, String baseUrl) Creates a new Laserfiche repository client that will use username and password to get access tokens for Laserfiche API.
AttributesClient	getAttributesClient() Returns the Laserfiche Repository Attributes API client.
AuditReasonsClient	getAuditReasonsClient() Returns the Laserfiche Repository Audit Reasons API client.
Map<String,String>	getDefaultRequestHeaders() Returns default request headers that will be used for all requests.
EntriesClient	getEntriesClient() Returns the Laserfiche Repository Entries API client.
FieldDefinitionsClient	getFieldDefinitionsClient() Returns the Laserfiche Repository Field Definitions API client.
LinkDefinitionsClient	getLinkDefinitionsClient() Returns the Laserfiche Repository Link Definitions API client.
RepositoriesClient	getRepositoryClient() Returns the Laserfiche Repository Repositories API client.
SearchesClient	getSearchesClient() Returns the Laserfiche Repository Searches API client.
SimpleSearchesClient	getSimpleSearchesClient() Returns the Laserfiche Repository Simple Searches API client.
TagDefinitionsClient	getTagDefinitionsClient() Returns the Laserfiche Repository Tag Definitions API client.
TasksClient	getTasksClient() Returns the Laserfiche Repository Tasks API client.
TemplateDefinitionsClient	getTemplateDefinitionClient() Returns the Laserfiche Repository Template Definitions API client.
void	setDefaultRequestHeaders(Map<String,String> defaultRequestHeaders) Set default headers that will be used for all requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryApiClientImpl

protected RepositoryApiClientImpl(String baseUrl,
                                  com.laserfiche.api.client.httphandlers.HttpRequestHandler httpHandler)

Method Detail

createFromAccessKey

public static RepositoryApiClient createFromAccessKey(String servicePrincipalKey,
                                                      com.laserfiche.api.client.model.AccessKey accessKey,
                                                      String scope,
                                                      String baseUrlDebug)

Creates a new Laserfiche repository client that will use Laserfiche Cloud OAuth client credentials to get access tokens.

Parameters:

servicePrincipalKey - The service principal key created for the service principal from the Laserfiche Account Administration.

accessKey - The access key exported from the Laserfiche Developer Console.

scope - The requested space-delimited scopes for the access token.

baseUrlDebug - Optional override for the Laserfiche repository API base url.

Returns:

RepositoryApiClient

createFromAccessKey

public static RepositoryApiClient createFromAccessKey(String servicePrincipalKey,
                                                      com.laserfiche.api.client.model.AccessKey accessKey,
                                                      String scope)

Creates a new Laserfiche repository client that will use Laserfiche Cloud OAuth client credentials to get access tokens.

Parameters:

servicePrincipalKey - The service principal key created for the service principal from the Laserfiche Account Administration.

accessKey - The access key exported from the Laserfiche Developer Console.

scope - The requested space-delimited scopes for the access token.

Returns:

RepositoryApiClient

createFromAccessKey

public static RepositoryApiClient createFromAccessKey(String servicePrincipalKey,
                                                      com.laserfiche.api.client.model.AccessKey accessKey)

Creates a new Laserfiche repository client that will use Laserfiche Cloud OAuth client credentials to get access tokens.

Parameters:

servicePrincipalKey - The service principal key created for the service principal from the Laserfiche Account Administration.

accessKey - The access key exported from the Laserfiche Developer Console.

Returns:

RepositoryApiClient

createFromUsernamePassword

public static RepositoryApiClient createFromUsernamePassword(String repositoryId,
                                                             String username,
                                                             String password,
                                                             String baseUrl)

Creates a new Laserfiche repository client that will use username and password to get access tokens for Laserfiche API. Password credentials grant type is implemented by the Laserfiche Self-Hosted API server. Not available in cloud.

Parameters:

repositoryId - The repository ID.

username - The username.

password - The password.

baseUrl - API server base URL e.g., https://{APIServerName}/LFRepositoryAPI.

Returns:

RepositoryApiClient

setDefaultRequestHeaders

public void setDefaultRequestHeaders(Map<String,String> defaultRequestHeaders)

Description copied from interface: RepositoryApiClient

Set default headers that will be used for all requests.

Specified by:

setDefaultRequestHeaders in interface RepositoryApiClient

Parameters:

defaultRequestHeaders - A key value pair of header name and value.

getDefaultRequestHeaders

public Map<String,String> getDefaultRequestHeaders()

Description copied from interface: RepositoryApiClient

Returns default request headers that will be used for all requests.

Specified by:

getDefaultRequestHeaders in interface RepositoryApiClient

Returns:

Default request headers that will be used for all requests.

getAttributesClient

public AttributesClient getAttributesClient()

Description copied from interface: RepositoryApiClient

Returns the Laserfiche Repository Attributes API client.

Specified by:

getAttributesClient in interface RepositoryApiClient

Returns:

The Laserfiche Repository Attributes API client.

getAuditReasonsClient

public AuditReasonsClient getAuditReasonsClient()

Description copied from interface: RepositoryApiClient

Returns the Laserfiche Repository Audit Reasons API client.

Specified by:

getAuditReasonsClient in interface RepositoryApiClient

Returns:

The Laserfiche Repository Audit Reasons API client.

getEntriesClient

public EntriesClient getEntriesClient()

Description copied from interface: RepositoryApiClient

Returns the Laserfiche Repository Entries API client.

Specified by:

getEntriesClient in interface RepositoryApiClient

Returns:

The Laserfiche Repository Entries API client.

getFieldDefinitionsClient

public FieldDefinitionsClient getFieldDefinitionsClient()

Description copied from interface: RepositoryApiClient

Returns the Laserfiche Repository Field Definitions API client.

Specified by:

getFieldDefinitionsClient in interface RepositoryApiClient

Returns:

The Laserfiche Repository Field Definitions API client.

getLinkDefinitionsClient

public LinkDefinitionsClient getLinkDefinitionsClient()

Description copied from interface: RepositoryApiClient

Returns the Laserfiche Repository Link Definitions API client.

Specified by:

getLinkDefinitionsClient in interface RepositoryApiClient

Returns:

The Laserfiche Repository Link Definitions API client.

getRepositoryClient

public RepositoriesClient getRepositoryClient()

Description copied from interface: RepositoryApiClient

Returns the Laserfiche Repository Repositories API client.

Specified by:

getRepositoryClient in interface RepositoryApiClient

Returns:

The Laserfiche Repository Repositories API client.

getSearchesClient

public SearchesClient getSearchesClient()

Description copied from interface: RepositoryApiClient

Returns the Laserfiche Repository Searches API client.

Specified by:

getSearchesClient in interface RepositoryApiClient

Returns:

The Laserfiche Repository Searches API client.

getSimpleSearchesClient

public SimpleSearchesClient getSimpleSearchesClient()

Description copied from interface: RepositoryApiClient

Returns the Laserfiche Repository Simple Searches API client.

Specified by:

getSimpleSearchesClient in interface RepositoryApiClient

Returns:

The Laserfiche Repository Simple Searches API client.

getTagDefinitionsClient

public TagDefinitionsClient getTagDefinitionsClient()

Description copied from interface: RepositoryApiClient

Returns the Laserfiche Repository Tag Definitions API client.

Specified by:

getTagDefinitionsClient in interface RepositoryApiClient

Returns:

The Laserfiche Repository Tag Definitions API client.

getTasksClient

public TasksClient getTasksClient()

Description copied from interface: RepositoryApiClient

Returns the Laserfiche Repository Tasks API client.

Specified by:

getTasksClient in interface RepositoryApiClient

Returns:

The Laserfiche Repository Tasks API client.

getTemplateDefinitionClient

public TemplateDefinitionsClient getTemplateDefinitionClient()

Description copied from interface: RepositoryApiClient

Returns the Laserfiche Repository Template Definitions API client.

Specified by:

getTemplateDefinitionClient in interface RepositoryApiClient

Returns:

The Laserfiche Repository Template Definitions API client.

close

public void close()

Release the thread pool held by the underlying HTTP clients.

Specified by:

close in interface RepositoryApiClient

Specified by:

close in interface AutoCloseable