|
1 | 1 | /* |
2 | | - * Copyright 2014-2022 the original author or authors. |
| 2 | + * Copyright 2014-2023 the original author or authors. |
3 | 3 | * |
4 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
5 | 5 | * you may not use this file except in compliance with the License. |
|
34 | 34 | * to scan interfaces annotated with {@link MessagingGateway}, because the |
35 | 35 | * standard {@link org.springframework.context.annotation.ComponentScan} |
36 | 36 | * ignores interfaces. |
| 37 | + * <p> |
| 38 | + * The {@link Gateway} annotation can be used for the per interface method configuration. |
37 | 39 | * |
38 | 40 | * @author Artem Bilan |
39 | 41 | * @author Gary Russell |
|
42 | 44 | * |
43 | 45 | * @see IntegrationComponentScan |
44 | 46 | * @see MessageEndpoint |
| 47 | + * @see Gateway |
45 | 48 | */ |
46 | 49 | @Target(ElementType.TYPE) |
47 | 50 | @Retention(RetentionPolicy.RUNTIME) |
|
68 | 71 | /** |
69 | 72 | * Identifies the default channel to which messages will be sent upon invocation |
70 | 73 | * of methods of the gateway proxy. |
| 74 | + * See {@link Gateway#requestChannel()} for per-method configuration. |
71 | 75 | * @return the suggested channel name, if any |
72 | 76 | */ |
73 | 77 | String defaultRequestChannel() default ""; |
|
76 | 80 | * Identifies the default channel the gateway proxy will subscribe to, to receive reply |
77 | 81 | * {@code Message}s, the payloads of |
78 | 82 | * which will be converted to the return type of the method signature. |
| 83 | + * See {@link Gateway#replyChannel()} for per-method configuration. |
79 | 84 | * @return the suggested channel name, if any |
80 | 85 | */ |
81 | 86 | String defaultReplyChannel() default ""; |
|
95 | 100 | * example if this gateway is hooked up to a {@code QueueChannel}. Value is specified |
96 | 101 | * in milliseconds; it can be a simple long value or a SpEL expression; array variable |
97 | 102 | * #args is available. |
| 103 | + * See {@link Gateway#requestTimeout()} for per-method configuration. |
98 | 104 | * @return the suggested timeout in milliseconds, if any |
99 | 105 | */ |
100 | 106 | String defaultRequestTimeout() default "-9223372036854775808"; |
|
104 | 110 | * before returning. By default, it will wait indefinitely. {@code null} is returned if |
105 | 111 | * the gateway times out. Value is specified in milliseconds; it can be a simple long |
106 | 112 | * value or a SpEL expression; array variable #args is available. |
| 113 | + * See {@link Gateway#replyTimeout()} for per-method configuration. |
107 | 114 | * @return the suggested timeout in milliseconds, if any |
108 | 115 | */ |
109 | 116 | String defaultReplyTimeout() default "-9223372036854775808"; |
|
124 | 131 | * unless explicitly overridden by a method declaration. Variables include {@code #args}, {@code #methodName}, |
125 | 132 | * {@code #methodString} and {@code #methodObject}; |
126 | 133 | * a bean resolver is also available, enabling expressions like {@code @someBean(#args)}. |
| 134 | + * See {@link Gateway#payloadExpression()} for per-method configuration. |
127 | 135 | * @return the suggested payload expression, if any |
128 | 136 | */ |
129 | 137 | String defaultPayloadExpression() default ""; |
130 | 138 |
|
131 | 139 | /** |
132 | 140 | * Provides custom message headers. These default headers are created for |
133 | 141 | * all methods on the service-interface (unless overridden by a specific method). |
| 142 | + * See {@link Gateway#headers()} for per-method configuration. |
134 | 143 | * @return the suggested payload expression, if any |
135 | 144 | */ |
136 | 145 | GatewayHeader[] defaultHeaders() default {}; |
|
0 commit comments