Keycloak Required Action ordering

AbstractPrioritizedRequiredAction.java

public abstract class AbstractPrioritizedRequiredAction implements RequiredActionProvider, RequiredActionFactory {

    @Override
    public void requiredActionChallenge(RequiredActionContext context) {
        if (!ActionPriorityUtils.isNext(getId(), context.getUser().getRequiredActions(), context.getAuthenticationSession().getRequiredActions())) {
            context.ignore();
            return;
        }
        requiredActionChallengeImpl(context);
    }

    public abstract void requiredActionChallengeImpl(RequiredActionContext context);
}

ActionPriorityUtils.java

public class ActionPriorityUtils {

    private static final ImmutableMap<String, Integer> priorities = ImmutableMap.<String, Integer>builder()
            .put(CustomAction1.PROVIDER_ID, 0)
            .put(CustomAction2.PROVIDER_ID, 10)
            .put(CustomAction3.PROVIDER_ID, 20)
            .put(CustomAction4.PROVIDER_ID, 30)
            .build();

    public static boolean isNext(String currentAction, Set<String> userRequiredActions, Set<String> clientRequiredActions) {
        Integer priority = getPriority(currentAction);
        if (userRequiredActions.contains(currentAction)) {
            return priority <= getNextPriority(userRequiredActions);
        }
        return priority <= getNextPriority(clientRequiredActions);
    }

    private static Integer getNextPriority(Set<String> actions) {
        return actions.stream()
                .map(ActionPriorityUtils::getPriority)
                .sorted()
                .findFirst()
                .orElse(Integer.MAX_VALUE);
    }

    private static Integer getPriority(String action) {
        Integer priority = priorities.get(action);
        return priority != null ? priority : -1;
    }
}