io.rxmicro.rest.RequestId Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rxmicro-rest Show documentation

The basic module that defines basic RxMicro annotations, required when using the REST architecture of building program systems.

There is a newer version: 0.11

Show newest version

/*
 * 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;

import io.rxmicro.common.meta.ReadMore;
import io.rxmicro.common.meta.SupportedTypes;

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

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.SOURCE;

/**
 * Returns value of HTTP header with name = {@value io.rxmicro.http.HttpStandardHeaderNames#REQUEST_ID} or
 * auto generated unique request id if HTTP header is absent.
 *
 * 
 * Request id is used to trace an user request which can be resend via multiple REST-based micro services.
 *
 * @author nedis
 * @see RemoteAddress
 * @see RequestBody
 * @see RequestMethod
 * @see RequestUrlPath
 * @see io.rxmicro.http.HttpStandardHeaderNames
 * @since 0.1
 */
@Documented
@Retention(SOURCE)
@Target({FIELD, METHOD, PARAMETER})
@SupportedTypes(
        String.class
)
@ReadMore(
        caption = "What is request id?",
        link = "https://docs.rxmicro.io/latest/user-guide/rest-controller.html#rest-controller-rqeuest-id-section"
)
public @interface RequestId {

    /**
     * Request id value example.
     */
    String REQUEST_ID_EXAMPLE = "62jJeu8x1310662";
}