org.springframework.amqp.rabbit.annotation.QueueBinding.java Source code

Introduction

Here is the source code for org.springframework.amqp.rabbit.annotation.QueueBinding.java

Source

/*
 * Copyright 2015-2019 the original author or 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 org.springframework.amqp.rabbit.annotation;

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

/**
 * Defines a queue, the exchange it is to be bound to, and an optional binding key; used
 * with {@code @RabbitListener}.
 *
 * @author Gary Russell
 * @author Alex Panchenko
 * @since 1.5
 *
 */
@Target({})
@Retention(RetentionPolicy.RUNTIME)
public @interface QueueBinding {

    /**
     * @return the queue.
     */
    Queue value();

    /**
     * @return the exchange.
     */
    Exchange exchange();

    /**
     * @return the routing key or pattern for the binding.
     * Multiple elements will result in multiple bindings.
     */
    String[] key() default {};

    /**
     * @return true if the declaration exceptions should be ignored.
     * @since 1.6
     */
    String ignoreDeclarationExceptions() default "false";

    /**
     * @return the arguments to apply when declaring this binding
     * @since 1.6
     */
    Argument[] arguments() default {};

    /**
     * @return true if the admin(s), if present, should declare this component.
     * @since 2.1
     */
    String declare() default "true";

    /**
     * Return a list of admin bean names that should declare this component.
     * By default all admins will declare it
     * @return the bean names
     * @since 2.1
     */
    String[] admins() default {};

}