Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation of composite provider flag. #6597

Merged
merged 3 commits into from
Apr 13, 2023
Merged

Update documentation of composite provider flag. #6597

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
29b8abb
Update documentation of composite provider flag.
tomas-langer Apr 12, 2023
f40b62e
typo fix
tomas-langer Apr 12, 2023
4ccd469
parenthesis fix
tomas-langer Apr 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion security/security/src/main/java/io/helidon/security/CompositeProviderFlag.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018, 2021 Oracle and/or its affiliates.
* Copyright (c) 2018, 2023 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -27,12 +27,23 @@
public enum CompositeProviderFlag {
/**
* Provider may fail, nothing happens if it does.
* <p>
* If succeeds, continues to the next provider.
* To create a provider that may fail, yet that is sufficient,
* please configure the flag to be {@link #SUFFICIENT}, and set the provider itself to be optional
* (most Helidon providers support {@code optional} configuration option), so the provider abstains instead of fails
* when user cannot be authenticated using it.
*/
MAY_FAIL(EnumSet.of(SecurityResponse.SecurityStatus.SUCCESS,
SecurityResponse.SecurityStatus.ABSTAIN,
SecurityResponse.SecurityStatus.FAILURE)),
/**
* If succeeds, no further providers are called, otherwise same as optional.
* <p>
* To create a provider that may fail, yet that is sufficient,
* use this flag, and set the provider itself to be optional
* (most Helidon providers support {@code optional} configuration option), so the provider abstains instead of fails
* when user cannot be authenticated using it.
*/
SUFFICIENT(EnumSet.of(SecurityResponse.SecurityStatus.SUCCESS, SecurityResponse.SecurityStatus.ABSTAIN)),
/**
Expand Down