Package org.labkey.remoteapi

Class ApiKeyCredentialsProvider

java.lang.Object

org.labkey.remoteapi.ApiKeyCredentialsProvider

All Implemented Interfaces:

CredentialsProvider

public class ApiKeyCredentialsProvider
extends Object
implements CredentialsProvider

Constructor Summary

Constructors

Constructor	Description
ApiKeyCredentialsProvider(String apiKey)

Method Summary

Modifier and Type	Method	Description
void	configureClientBuilder(URI baseURI, org.apache.hc.client5.http.impl.classic.HttpClientBuilder builder)
void	configureRequest(URI baseURI, org.apache.hc.client5.http.classic.methods.HttpUriRequest request, org.apache.hc.client5.http.protocol.HttpClientContext httpClientContext)
void	initializeConnection(Connection connection)	Initialize the connection before its first request.
boolean	shouldRetryRequest(CommandException exception, org.apache.hc.client5.http.classic.methods.HttpUriRequest request)	Should the Command attempt to retry the request?

Methods inherited from class java.lang.Object

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

Constructor Details

ApiKeyCredentialsProvider

public ApiKeyCredentialsProvider(String apiKey)

Method Details

configureClientBuilder

public void configureClientBuilder(URI baseURI,
 org.apache.hc.client5.http.impl.classic.HttpClientBuilder builder)

Specified by:

configureClientBuilder in interface CredentialsProvider

configureRequest

public void configureRequest(URI baseURI,
 org.apache.hc.client5.http.classic.methods.HttpUriRequest request,
 org.apache.hc.client5.http.protocol.HttpClientContext httpClientContext)

Specified by:

configureRequest in interface CredentialsProvider

initializeConnection

public void initializeConnection(Connection connection)
                          throws IOException,
CommandException

Description copied from interface: CredentialsProvider

Initialize the connection before its first request. For example, make a request to retrieve CSRF token & session ID and/or ensure the user is logged in.

Specified by:

initializeConnection in interface CredentialsProvider

Throws:

IOException

CommandException

shouldRetryRequest

public boolean shouldRetryRequest(CommandException exception,
 org.apache.hc.client5.http.classic.methods.HttpUriRequest request)

Description copied from interface: CredentialsProvider

Should the Command attempt to retry the request?

Specified by:

shouldRetryRequest in interface CredentialsProvider