Constructor Detail

• OtpConfiguration.Builder

  OtpConfiguration.Builder()

  Without the SettingsParameters parameter, if SettingsProvider is not set, there are no default values for finishEndpointUrl or authorizationEndpointUrl, otherwise finishEndpointUrl and authorizationEndpointUrl are set from get

• OtpConfiguration.Builder

  OtpConfiguration.Builder(SettingsParameters settings)

  Builder for OtpConfiguration.

  Parameters:

  settings - Used to automatically set the finish endpoint URL and the authorization endpoint URL.

Method Detail

• challengeHeaderName

  @NonNull() OtpConfiguration.Builder challengeHeaderName(@NonNull() String challengeHeaderName)

  Parameters:

  challengeHeaderName - The header name indicating there is an OTP challenge.

  Returns:

  This OtpConfiguration.Builder so method calls can be chained.

• challengeHeaderValue

  @NonNull() OtpConfiguration.Builder challengeHeaderValue(@NonNull() String challengeHeaderValue)

  Parameters:

  challengeHeaderValue - The header value indicating there is an OTP challange.

  Returns:

  This OtpConfiguration.Builder so method calls can be chained.

• finishEndpointUrl

  @NonNull() OtpConfiguration.Builder finishEndpointUrl(@NonNull() String finishEndpointUrl)

  Must be called with a non-empty value before the configuration is built, since this parameter is required and there is no usable default.

  Parameters:

  finishEndpointUrl - The finish endpoint URL, which indicates OTP authentication was successful.

  Returns:

  This OtpConfiguration.Builder so method calls can be chained.

• authorizationEndpointUrl

  @NonNull() OtpConfiguration.Builder authorizationEndpointUrl(@NonNull() String authorizationEndpointUrl)

  Must be called with a non-empty value before the configuration is built, since this parameter is required and there is no usable default.

  Parameters:

  authorizationEndpointUrl - The authorization endpoint URL which is used for OTP authentication.

  Returns:

  This OtpConfiguration.Builder so method calls can be chained.

• build

  @NonNull() OtpConfiguration build()

  The finish endpoint URL and the authorization endpoint URL must both be set to non-empty values before this method is called.

  Returns:

  A new OtpConfiguration.