Class OtpConfiguration
-
- All Implemented Interfaces:
public class OtpConfiguration
This class holds all the information for OTP (one time passcode) configuration.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
OtpConfiguration.Builder
This class is used to build a OtpConfiguration object.
-
Field Summary
Fields Modifier and Type Field Description public final String
challengeHeaderName
public final String
challengeHeaderValue
public final String
finishEndpointUrl
public final String
authorizationEndpointUrl
-
Method Summary
Modifier and Type Method Description String
getChallengeHeaderName()
The challenge header is how the OtpInterceptor can detect an OTP challenge. String
getChallengeHeaderValue()
The challenge header is how the OtpInterceptor can detect an OTP challenge. String
getFinishEndpointUrl()
The OtpProcessor knows that OTP authentication has succeeded when the finish endpoint URL is loaded. String
getAuthorizationEndpointUrl()
The OtpProcessor uses the authorization endpoint URL to start the OTP authentication flow. -
-
Method Detail
-
getChallengeHeaderName
@NonNull() String getChallengeHeaderName()
The challenge header is how the OtpInterceptor can detect an OTP challenge. If a response has a header name matching this parameter (and a value matching the challenge header value) then the OtpInterceptor will use its OtpProcessor to authenticate before resending the request.
-
getChallengeHeaderValue
@NonNull() String getChallengeHeaderValue()
The challenge header is how the OtpInterceptor can detect an OTP challenge. If a response has a header value matching this parameter (and a name matching the challenge header name) then the OtpInterceptor will use its OtpProcessor to authenticate before resending the request.
-
getFinishEndpointUrl
@NonNull() String getFinishEndpointUrl()
The OtpProcessor knows that OTP authentication has succeeded when the finish endpoint URL is loaded.
-
getAuthorizationEndpointUrl
@NonNull() String getAuthorizationEndpointUrl()
The OtpProcessor uses the authorization endpoint URL to start the OTP authentication flow.
-
-
-
-