Package: SimpleMessageSubscriber

SimpleMessageSubscriber

Coverage

1: /*
2: * *********************************************************************************************************************
3: *
4: * TheseFoolishThings: Miscellaneous utilities
5: * http://tidalwave.it/projects/thesefoolishthings
6: *
7: * Copyright (C) 2009 - 2024 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *********************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
12: * the License. You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
23: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.messagebus.annotation;
28:
29: import java.lang.annotation.Documented;
30: import java.lang.annotation.ElementType;
31: import java.lang.annotation.Retention;
32: import java.lang.annotation.RetentionPolicy;
33: import java.lang.annotation.Target;
34: import javax.annotation.Nonnull;
35:
36: /***********************************************************************************************************************
37: *
38: * Designates a class as a simple subscriber of a message bus. This makes it possible to avoid plumbing code for
39: * subscribing to topics and use instead {@link ListensTo} with {@link it.tidalwave.messagebus.MessageBusHelper}.
40: * An optional {@link #source()} parameter can be specified to choose a message bus for systems where more than one are
41: * available.
42: *
43: * @author Fabrizio Giudici
44: *
45: **********************************************************************************************************************/
46: @Retention(RetentionPolicy.RUNTIME)
47: @Target(ElementType.TYPE)
48: @Documented
49: public @interface SimpleMessageSubscriber
50: {
51: public static final String DEFAULT_SOURCE = "applicationMessageBus";
52:
53: /*******************************************************************************************************************
54: *
55: * The name of the source that this annotation refers to.
56: *
57: * @return the source name
58: *
59: ******************************************************************************************************************/
60: @Nonnull
61: String source() default DEFAULT_SOURCE;
62: }