io.helidon.webclient.api.HttpClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-webclient-api Show documentation
The newest version!
/*
 * Copyright (c) 2022, 2023 Oracle and/or its affiliates.
 *
 * 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 io.helidon.webclient.api;

import io.helidon.http.Method;

/**
 * HTTP client.
 *
 * @param  type of the client request
 */
public interface HttpClient> extends ReleasableResource {
    /**
     * Create a request for a method.
     *
     * @param method HTTP method
     * @return a new request (not thread safe)
     */
    REQ method(Method method);

    /**
     * Gracefully close all opened client specific connections.
     */
    default void closeResource() {
        // Do nothing by default
    }

    /**
     * Shortcut for get method with a path.
     *
     * @param uri path to resolve against base URI, or full URI
     * @return a new request (not thread safe)
     */
    default REQ get(String uri) {
        return (REQ) method(Method.GET).uri(uri);
    }

    /**
     * Shortcut for get method with default path.
     *
     * @return a new request (not thread safe)
     */
    default REQ get() {
        return method(Method.GET);
    }

    /**
     * Shortcut for post method with a path.
     *
     * @param uri path to resolve against base URI, or full URI
     * @return a new request (not thread safe)
     */
    default REQ post(String uri) {
        return (REQ) method(Method.POST).uri(uri);
    }

    /**
     * Shortcut for post method with default path.
     *
     * @return a new request (not thread safe)
     */
    default REQ post() {
        return method(Method.POST);
    }

    /**
     * Shortcut for put method with a path.
     *
     * @param uri path to resolve against base URI, or full URI
     * @return a new request (not thread safe)
     */
    default REQ put(String uri) {
        return (REQ) method(Method.PUT).uri(uri);
    }

    /**
     * Shortcut for put method with default path.
     *
     * @return a new request (not thread safe)
     */
    default REQ put() {
        return method(Method.PUT);
    }

    /**
     * Shortcut for delete method with a path.
     *
     * @param uri path to resolve against base URI, or full URI
     * @return a new request (not thread safe)
     */
    default REQ delete(String uri) {
        return (REQ) method(Method.DELETE).uri(uri);
    }

    /**
     * Shortcut for delete method with default path.
     *
     * @return a new request (not thread safe)
     */
    default REQ delete() {
        return method(Method.DELETE);
    }

    /**
     * Shortcut for head method with a path.
     *
     * @param uri path to resolve against base URI, or full URI
     * @return a new request (not thread safe)
     */
    default REQ head(String uri) {
        return (REQ) method(Method.HEAD).uri(uri);
    }

    /**
     * Shortcut for head method with default path.
     *
     * @return a new request (not thread safe)
     */
    default REQ head() {
        return method(Method.HEAD);
    }

    /**
     * Shortcut for options method with a path.
     *
     * @param uri path to resolve against base URI, or full URI
     * @return a new request (not thread safe)
     */
    default REQ options(String uri) {
        return (REQ) method(Method.OPTIONS).uri(uri);
    }

    /**
     * Shortcut for options method with default path.
     *
     * @return a new request (not thread safe)
     */
    default REQ options() {
        return method(Method.OPTIONS);
    }

    /**
     * Shortcut for trace method with a path.
     *
     * @param uri path to resolve against base URI, or full URI
     * @return a new request (not thread safe)
     */
    default REQ trace(String uri) {
        return (REQ) method(Method.TRACE).uri(uri);
    }

    /**
     * Shortcut for trace method with default path.
     *
     * @return a new request (not thread safe)
     */
    default REQ trace() {
        return method(Method.TRACE);
    }

    /**
     * Shortcut for patch method with a path.
     *
     * @param uri path to resolve against base URI, or full URI
     * @return a new request (not thread safe)
     */
    default REQ patch(String uri) {
        return (REQ) method(Method.PATCH).uri(uri);
    }

    /**
     * Shortcut for patch method with default path.
     *
     * @return a new request (not thread safe)
     */
    default REQ patch() {
        return method(Method.PATCH);
    }
}