org.eclipse.edc.http.spi.ControlApiHttpClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http-spi Show documentation

edc :: http-spi

There is a newer version: 0.9.1

/*
 *  Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
 *
 *  This program and the accompanying materials are made available under the
 *  terms of the Apache License, Version 2.0 which is available at
 *  https://www.apache.org/licenses/LICENSE-2.0
 *
 *  SPDX-License-Identifier: Apache-2.0
 *
 *  Contributors:
 *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - initial API and implementation
 *
 */

package org.eclipse.edc.http.spi;

import okhttp3.Request;
import org.eclipse.edc.spi.result.ServiceResult;

/**
 * Http client that provides a way to communicate over the "control" api
 */
public interface ControlApiHttpClient {

    /**
     * Execute a http request without returning the response body.
     *
     * @param requestBuilder the request builder.
     * @return a service result.
     */
    ServiceResult execute(Request.Builder requestBuilder);

    /**
     * Execute a http request and return the response body.
     *
     * @param requestBuilder the request builder.
     * @return a service result.
     */
    ServiceResult request(Request.Builder requestBuilder);

}