Annotation Type PollableBean
@Target({METHOD,ANNOTATION_TYPE})
@Retention(RUNTIME)
@Bean
@Documented
public @interface PollableBean
A marker and qualifier annotation to signal that
annotated functional factory method is a bean (e.g., Supplier, Function or Consumer)
that also needs to be polled periodically.
This has special significance to the reactive suppliers (e.g.,
NOTE: The spring-cloud-function framework provides no default post processing behavior for this annotation. This means that annotating a factory method with this annotation will not have any effect without some application/framework specific post processing (see spring-cloud-stream as an example).
This has special significance to the reactive suppliers (e.g.,
Supplier<Flux<?>>
),
since by default they are treated as producers of an infinite stream.
However if such suppliers produce a finite stream they may need to be triggered again.
NOTE: The spring-cloud-function framework provides no default post processing behavior for this annotation. This means that annotating a factory method with this annotation will not have any effect without some application/framework specific post processing (see spring-cloud-stream as an example).
- Since:
- 3.0
- Author:
- Oleg Zhurakousky
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionboolean
Signals to the post processors of this annotation that the result produced by the annotatedSupplier
has to be split.
-
Element Details
-
splittable
boolean splittableSignals to the post processors of this annotation that the result produced by the annotatedSupplier
has to be split. Specifics on how to split and what to split are left to the underlying framework.- Returns:
- true if the resulting stream produced by the
annotated
Supplier
has to be split.
- Default:
- true
-