com.laserfiche.api.client.oauth

Class TokenClientImpl

java.lang.Object

com.laserfiche.api.client.tokenclients.BaseTokenClient

com.laserfiche.api.client.oauth.TokenClientImpl

All Implemented Interfaces:

TokenClient, AutoCloseable

public class TokenClientImpl
extends BaseTokenClient
implements TokenClient

The Laserfiche Cloud token route API client.

Field Summary

Fields inherited from class com.laserfiche.api.client.tokenclients.BaseTokenClient

httpClient, objectMapper

Constructor Summary

Constructors

Constructor and Description
TokenClientImpl(String regionalDomain) Creates a new Laserfiche Cloud token route API client.

Method Summary

Modifier and Type	Method and Description
GetAccessTokenResponse	getAccessTokenFromServicePrincipal(String servicePrincipalKey, AccessKey accessKey) Gets an OAuth access token given a Laserfiche Cloud service principal key and an OAuth service application access key.
GetAccessTokenResponse	getAccessTokenFromServicePrincipal(String servicePrincipalKey, AccessKey accessKey, String scope) Gets an OAuth access token given a Laserfiche Cloud service principal key and an OAuth service application access key.

Methods inherited from class com.laserfiche.api.client.tokenclients.BaseTokenClient

close

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.laserfiche.api.client.oauth.TokenClient

close

Constructor Detail

TokenClientImpl

public TokenClientImpl(String regionalDomain)

Creates a new Laserfiche Cloud token route API client.

Parameters:

regionalDomain - Laserfiche Cloud domain associated with the access key, e.g. laserfiche.com.

Method Detail

getAccessTokenFromServicePrincipal

public GetAccessTokenResponse getAccessTokenFromServicePrincipal(String servicePrincipalKey,
                                                                 AccessKey accessKey)

Description copied from interface: TokenClient

Gets an OAuth access token given a Laserfiche Cloud service principal key and an OAuth service application access key. These values can be exported from the Laserfiche Developer Console. This is the client credentials flow that applies to service applications.

Specified by:

getAccessTokenFromServicePrincipal in interface TokenClient

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:

A response that contains an access token

getAccessTokenFromServicePrincipal

public GetAccessTokenResponse getAccessTokenFromServicePrincipal(String servicePrincipalKey,
                                                                 AccessKey accessKey,
                                                                 String scope)

Description copied from interface: TokenClient

Gets an OAuth access token given a Laserfiche Cloud service principal key and an OAuth service application access key. These values can be exported from the Laserfiche Developer Console. This is the client credentials flow that applies to service applications.

Specified by:

getAccessTokenFromServicePrincipal in interface TokenClient

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:

A response that contains an access token