io.micronaut.messaging.annotation.MessageHeader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-messaging Show documentation
Show all versions of micronaut-messaging Show documentation
Core components supporting the Micronaut Framework
/*
* 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.messaging.annotation;
import io.micronaut.core.bind.annotation.Bindable;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* An annotation that can be applied to method argument to indicate that the method argument is bound from a message header.
*
* @author Graeme Rocher
* @since 2.4.0
*/
@Documented
@Retention(RUNTIME)
@Target({ElementType.PARAMETER, ElementType.TYPE, ElementType.METHOD}) // this can be either type or param
@Repeatable(value = MessageHeaders.class)
@Bindable
@Inherited
public @interface MessageHeader {
/**
* If used as a bound parameter, this is the header name. If used on a class level this is value and not the header name.
*
* @return The name of the header, otherwise it is inferred from the parameter name
*/
String value() default "";
/**
* If used on a class level with @Headers this is the header name and value is the value.
*
* @return name of header when using with @Headers
*/
String name() default "";
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy