org.labkey.remoteapi.CredentialsProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of labkey-client-api Show documentation

The client-side library for Java developers is a separate JAR from the LabKey Server code base. It can be used by any Java program, including another Java web application.

The newest version!

/*
 * Copyright (c) 2016 LabKey Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.labkey.remoteapi;

import org.apache.hc.client5.http.auth.AuthenticationException;
import org.apache.hc.client5.http.classic.methods.HttpUriRequest;
import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;
import org.apache.hc.client5.http.protocol.HttpClientContext;

import java.io.IOException;
import java.net.URI;

public interface CredentialsProvider
{
    void configureClientBuilder(URI baseURI, HttpClientBuilder builder);
    void configureRequest(URI baseURI, HttpUriRequest request, HttpClientContext httpClientContext) throws AuthenticationException;

    /**
     * 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.
     */
    void initializeConnection(Connection connection) throws IOException, CommandException;

    /**
     * Should the Command attempt to retry the request?
     */
    default boolean shouldRetryRequest(CommandException exception, HttpUriRequest request)
    {
        return false;
    }
}