io.rxmicro.rest.client.ClientRequest Maven / Gradle / Ivy

/*
 * Copyright (c) 2020. https://rxmicro.io
 *
 * 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.rxmicro.rest.client;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.CLASS;

/**
 * Marks annotated class as a client request.
 *
 * 
 * This annotation is useful for library modules.
 * Because the RxMicro framework can resolve client requests for non-library modules successfully without this annotation.
 *
 * @author nedis
 * @since 0.10
 */
@Documented
@Retention(CLASS)
@Target(TYPE)
public @interface ClientRequest {

    /**
     * Returns the http body support mode.
     *
     * @return the http body support mode
     */
    HttpBodySupport value();

    /**
     * Provides http body support.
     *
     * @author nedis
     * @since 0.10
     */
    enum HttpBodySupport {

        /**
         * This mode means that the client request must be used by http handlers that require http body.
         */
        WITH_HTTP_BODY,

        /**
         * This mode means that the client request must be used by http handlers that do not require http body.
         */
        WITHOUT_HTTP_BODY
    }
}