com.laserfiche.api.client.httphandlers

Class OAuthClientCredentialsHandler

java.lang.Object

com.laserfiche.api.client.httphandlers.OAuthClientCredentialsHandler

All Implemented Interfaces:

HttpRequestHandler, AutoCloseable

public class OAuthClientCredentialsHandler
extends Object
implements HttpRequestHandler

Laserfiche Cloud OAuth client credentials HTTP handler.

Constructor Summary

Constructors

Constructor and Description
OAuthClientCredentialsHandler(String servicePrincipalKey, AccessKey accessKey) Creates a new Laserfiche Cloud OAuth client credentials HTTP handler.
OAuthClientCredentialsHandler(String servicePrincipalKey, AccessKey accessKey, String scope) Creates a new Laserfiche Cloud OAuth client credentials HTTP handler.

Method Summary

Modifier and Type	Method and Description
boolean	afterSend(Response response) Invoked after an HTTP response is received and will determine if a new access token should be retrieved.
BeforeSendResult	beforeSend(Request request) Invoked before an HTTP request is sent.
void	close() An implementation of AutoCloseable that does not throw any checked exceptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthClientCredentialsHandler

public OAuthClientCredentialsHandler(String servicePrincipalKey,
                                     AccessKey accessKey)

Creates a new Laserfiche Cloud OAuth client credentials HTTP handler.

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.

OAuthClientCredentialsHandler

public OAuthClientCredentialsHandler(String servicePrincipalKey,
                                     AccessKey accessKey,
                                     String scope)

Creates a new Laserfiche Cloud OAuth client credentials HTTP handler.

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.

Method Detail

beforeSend

public BeforeSendResult beforeSend(Request request)

Description copied from interface: HttpRequestHandler

Invoked before an HTTP request is sent. The authorization header containing an access token will be added to the request.

Specified by:

beforeSend in interface HttpRequestHandler

Parameters:

request - The HTTP request.

Returns:

BeforeSendResult

afterSend

public boolean afterSend(Response response)

Description copied from interface: HttpRequestHandler

Invoked after an HTTP response is received and will determine if a new access token should be retrieved.

Specified by:

afterSend in interface HttpRequestHandler

Parameters:

response - The HTTP response.

Returns:

True, if the request should be retried.

close

public void close()

Description copied from interface: HttpRequestHandler

An implementation of AutoCloseable that does not throw any checked exceptions.

Specified by:

close in interface HttpRequestHandler

Specified by:

close in interface AutoCloseable