com.laserfiche.api.client.httphandlers

Class UsernamePasswordHandler

java.lang.Object

com.laserfiche.api.client.httphandlers.UsernamePasswordHandler

All Implemented Interfaces:

HttpRequestHandler, AutoCloseable

public class UsernamePasswordHandler
extends Object
implements HttpRequestHandler

Username password HTTP handler for Laserfiche Self-Hosted API Server.

Constructor Summary

Constructors

Constructor and Description
UsernamePasswordHandler(String repositoryId, String username, String password, String baseUrl, TokenClient client) Creates a username and password authorization handler for the Laserfiche Self-Hosted API server

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

UsernamePasswordHandler

public UsernamePasswordHandler(String repositoryId,
                               String username,
                               String password,
                               String baseUrl,
                               TokenClient client)

Creates a username and password authorization handler for the Laserfiche Self-Hosted API server

Parameters:

repositoryId - Repository ID.

username - The username used with "password" grant type.

password - The password used with "password" grant type.

baseUrl - APIServer Base Url e.g. https://{APIServerName}/LFRepositoryAPI.

client - OPTIONAL

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