org.apache.nifi.web.client.api.WebClientService Maven / Gradle / Ivy

Go to download

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

Abstracts standard HTTP client operations without depending on a specific HTTP library

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.nifi.web.client.api;

/**
 * Service abstraction for HTTP client operations
 */
public interface WebClientService {
    /**
     * Create HTTP Request builder starting with specified HTTP Request Method
     *
     * @param requestMethod HTTP Request Method
     * @return HTTP Request URI Specification builder
     */
    HttpRequestUriSpec method(HttpRequestMethod requestMethod);

    /**
     * Create HTTP Request builder starting with HTTP DELETE
     *
     * @return HTTP Request URI Specification builder
     */
    HttpRequestUriSpec delete();

    /**
     * Create HTTP Request builder starting with HTTP GET
     *
     * @return HTTP Request URI Specification builder
     */
    HttpRequestUriSpec get();

    /**
     * Create HTTP Request builder starting with HTTP PATCH
     *
     * @return HTTP Request URI Specification builder
     */
    HttpRequestUriSpec patch();

    /**
     * Create HTTP Request builder starting with HTTP POST
     *
     * @return HTTP Request URI Specification builder
     */
    HttpRequestUriSpec post();

    /**
     * Create HTTP Request builder starting with HTTP PUT
     *
     * @return HTTP Request URI Specification builder
     */
    HttpRequestUriSpec put();
}