io.micronaut.http.annotation.RequestAttributes Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-http Show documentation

Natively Cloud Native

The newest version!

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

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * This lets you declare several attributes for a client class and have them always included.
 * Example usage:
 * 
 * {@literal @}RequestAttributes({
 *     {@literal @}RequestAttribute(name = "api-key", value = "my-key-value"),
 *     {@literal @}RequestAttribute(name = "api-name", value = "my-api-name")
 * })
 * 
 *
 * @author Ahmed Lafta
 * @since 1.0
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Inherited
public @interface RequestAttributes {

    /**
     * This allows you to have multiple @RequestAttribute's set at the class level with Java and Groovy.
     * Example usage:
     * 
     * {@literal @}RequestAttributes({
     *     {@literal @}RequestAttribute(name = "api-key", value = "my-key-value"),
     *     {@literal @}RequestAttribute(name = "api-name", value = "my-api-name")
     * })
     * 
     * @return The attributes
     */
    RequestAttribute[] value() default {};
}