Class SamlConfiguration.Builder
-
- All Implemented Interfaces:
public class SamlConfiguration.BuilderUsed to build a SamlConfiguration object.
-
-
Constructor Summary
Constructors Constructor Description SamlConfiguration.Builder()If SettingsProvider is not set,this constructors does not set a default value for the authentication URL, it will have to be set by calling authUrl, otherwise authentication URL is set from get SamlConfiguration.Builder(SettingsParameters settings)Creates a new SamlConfiguration.Builder.
-
Method Summary
Modifier and Type Method Description SamlConfiguration.BuilderchallengeHeaderName(@NonNull() String challengeHeaderName)SamlConfiguration.BuilderchallengeHeaderValue(@NonNull() String challengeHeaderValue)SamlConfiguration.BuilderauthUrl(@NonNull() String authUrl)SamlConfiguration.BuilderfinishUrl(@NonNull() String finishUrl)SamlConfigurationbuild()-
-
Constructor Detail
-
SamlConfiguration.Builder
SamlConfiguration.Builder()
If SettingsProvider is not set,this constructors does not set a default value for the authentication URL, it will have to be set by calling authUrl, otherwise authentication URL is set from get
-
SamlConfiguration.Builder
SamlConfiguration.Builder(SettingsParameters settings)
Creates a new SamlConfiguration.Builder.- Parameters:
settings- The auth URL and the finish URL will be automatically set from this SettingsParameters object.
-
-
Method Detail
-
challengeHeaderName
@NonNull() SamlConfiguration.Builder challengeHeaderName(@NonNull() String challengeHeaderName)
- Parameters:
challengeHeaderName- The challenge header is how the SamlInterceptor can detect a SAML challenge.- Returns:
This SamlConfiguration.Builder, so method calls can be chained.
-
challengeHeaderValue
@NonNull() SamlConfiguration.Builder challengeHeaderValue(@NonNull() String challengeHeaderValue)
- Parameters:
challengeHeaderValue- The challenge header value.- Returns:
The SamlConfiguration.Builder, so method calls can be chained.
-
authUrl
@NonNull() SamlConfiguration.Builder authUrl(@NonNull() String authUrl)
- Parameters:
authUrl- This is the URL that the SamlProcessor will use to authenticate the user (typically by loading the URL in a webview and letting the user authenticate themselves).- Returns:
This SamlConfiguration.Builder, so method calls can be chained.
-
finishUrl
@NonNull() SamlConfiguration.Builder finishUrl(@NonNull() String finishUrl)
- Parameters:
finishUrl- The URL, which when encountered indicates the SAML authentication flow’s end.- Returns:
This SamlConfiguration.Builder, so method calls can be chained.
-
build
@NonNull() SamlConfiguration build()
- Returns:
The SamlConfiguration object.
-
-
-
-