io.micronaut.http.client.bind.ClientArgumentRequestBinder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2020 original authors
 *
 * 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
 *
 * https://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.micronaut.http.client.bind;

import io.micronaut.context.annotation.BootstrapContextCompatible;
import io.micronaut.core.annotation.Indexed;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.convert.ArgumentConversionContext;
import io.micronaut.http.MutableHttpRequest;

/**
 * A binder that binds to a {@link MutableHttpRequest}. Argument binders
 * are not able to modify the URI of the request.
 *
 * @param  A type
 * @author James Kleeh
 * @since 2.1.0
 */
@BootstrapContextCompatible
@Indexed(ClientArgumentRequestBinder.class)
public interface ClientArgumentRequestBinder extends ClientRequestBinder {

    /**
     * Bind the given argument to the request. Argument binders
     * are not able to modify the URI of the request.
     *
     * @param context The argument context
     * @param uriContext The URI context
     * @param value   The argument value
     * @param request The request
     */
    void bind(@NonNull ArgumentConversionContext context,
              @NonNull ClientRequestUriContext uriContext,
              @NonNull T value,
              @NonNull MutableHttpRequest request);

}