Package org.apache.ignite.maintenance
Interface MaintenanceWorkflowCallback
-
public interface MaintenanceWorkflowCallbackAbstraction to decouple interaction betweenMaintenanceRegistryand components that may require maintenance. If a component may cause node to enter maintenance mode, it should register this callback inMaintenanceRegistryusing methodMaintenanceRegistry.registerWorkflowCallback(String, MaintenanceWorkflowCallback)MaintenanceRegistryduring its workflow will collect necessary information about maintenance for components without knowing implementation details of the components.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull List<MaintenanceAction<?>>allActions()Supplies list ofMaintenanceActions that user can call to fix maintenance situation for the component or get information about ongoing actions.@Nullable MaintenanceAction<?>automaticAction()Component can provide optionalMaintenanceActionthat will be executed automatically byMaintenanceRegistrywhen node enters maintenance mode.booleanshouldProceedWithMaintenance()Called byMaintenanceRegistryand enables it to check if maintenance is still needed for component that provided this callback.
-
-
-
Method Detail
-
shouldProceedWithMaintenance
boolean shouldProceedWithMaintenance()
Called byMaintenanceRegistryand enables it to check if maintenance is still needed for component that provided this callback. User may fix maintenance situation by hand when node was down thus before going to maintenance mode we should be able to check if it is still necessary.- Returns:
Trueif maintenance is still needed for the component.
-
allActions
@NotNull @NotNull List<MaintenanceAction<?>> allActions()
Supplies list ofMaintenanceActions that user can call to fix maintenance situation for the component or get information about ongoing actions. Should not be null or empty.- Returns:
- Not null and non-empty
ListofMaintenanceAction.
-
automaticAction
@Nullable @Nullable MaintenanceAction<?> automaticAction()
Component can provide optionalMaintenanceActionthat will be executed automatically byMaintenanceRegistrywhen node enters maintenance mode. If no automatic actions are providedMaintenanceRegistrywill wait for user to triggerMaintenanceActionwith logic to fix the maintenance situation.- Returns:
MaintenanceActionfor automatic execution or null if maintenance situation should not be fixed automatically.
-
-