com.identityx.auth.def.IHttpRequestBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of daon-http-digest-auth Show documentation

Client library used for adding authentication to http messages as required by IdentityX Rest Services

There is a newer version: 5.6.0.2

Show newest version

/*
* Copyright Daon.
*
* 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 com.identityx.auth.def;

import java.util.Map;

public interface IHttpRequestBuilder {

    /**
     * Sets the HTTP Headers that will be present in the resulting request instance.
     *
     * @param headers the HTTP Headers that will be present in the resulting built request instance.
     * @return the builder instance for method chaining.
     * @throws IllegalArgumentException if the method argument is {@code null}.
     */
    public IHttpRequestBuilder headers(Map headers) throws IllegalArgumentException;

    /**
     * Sets the request parameters that will be present in the resulting request instance.
     *
     * @param parameters the request parameters that will be present in the resulting request instance.
     * @return the builder instance for method chaining.
     */
    public IHttpRequestBuilder parameters(Map parameters);

    /**
     * Sets the query parameters that will be present in the resulting request instance.
     *
     * @param queryParameters the query parameters that will be present in the resulting request instance.
     * @return the builder instance for method chaining.
     */
    public IHttpRequestBuilder queryParameters(String queryParameters);

    /**
     * Returns a new {@code HttpRequest} instance reflecting the current builder state.
     *
     * @return a new {@code HttpRequest} instance reflecting the current builder state.
     */
    public IHttpRequest build();
}