You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/reference/asciidoc/endpoint.adoc
+13-4Lines changed: 13 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -664,6 +664,17 @@ See the http://docs.spring.io/spring-framework/docs/current/spring-framework-ref
664
664
Starting with version 4.2, endpoints can be assigned to roles.
665
665
Roles let endpoints be started and stopped as a group.
666
666
This is particularly useful when using leadership election, where a set of endpoints can be started or stopped when leadership is granted or revoked, respectively.
667
+
For this purpose the framework registers a `SmartLifecycleRoleController` bean in the application context with the name `IntegrationContextUtils.INTEGRATION_LIFECYCLE_ROLE_CONTROLLER`.
668
+
Whenever it is necessary to control lifecycles, this bean can be injected or `@Autowired`:
You can assign endpoints to roles using XML, Java configuration, or programmatically.
669
680
The following example shows how to configure endpoint roles with XML:
@@ -734,11 +745,9 @@ Invoking `roleController.startLifecyclesInRole("cluster")` and the corresponding
734
745
735
746
NOTE: Any object that implements `SmartLifecycle` can be programmatically added -- not just endpoints.
736
747
737
-
The `SmartLifecycleRoleController` implements `ApplicationListener<AbstractLeaderEvent>` and it automatically
738
-
starts and stops its configured `SmartLifecycle` objects when leadership is granted or revoked (when some bean publishes
739
-
`OnGrantedEvent` or `OnRevokedEvent`, respectively).
748
+
The `SmartLifecycleRoleController` implements `ApplicationListener<AbstractLeaderEvent>` and it automatically starts and stops its configured `SmartLifecycle` objects when leadership is granted or revoked (when some bean publishes `OnGrantedEvent` or `OnRevokedEvent`, respectively).
740
749
741
-
IMPORTANT: When using leadership election to start and stop components, it is important to set the `auto-startup` XML attribute (`autoStartup` bean property) to `false` so taht the application context does not start the components during context initialization.
750
+
IMPORTANT: When using leadership election to start and stop components, it is important to set the `auto-startup` XML attribute (`autoStartup` bean property) to `false` so that the application context does not start the components during context initialization.
742
751
743
752
Starting with version 4.3.8, the `SmartLifecycleRoleController` provides several status methods:
0 commit comments