com.sap.smp.client.httpc.authflows

Class OTPConfig

java.lang.Object

com.sap.smp.client.httpc.authflows.OTPConfig

public class OTPConfig
extends java.lang.Object

Immutable object for otp configuration. the related mechanism works roughly as follows:

1. The application sends an HTTP request to the backend.
2. The backend detects that authentication is required, so it sends back a OTPRequest via the HTTP POST binding. This response might contain a so-called indicator header to facilitate the detection of this challenge.
3. The client detects the challenge and then opens an embedded browser against the location header value which is subject to the same authentication requirement.
4. The user enters the pin code on the provided form and issues another request with the pin code provided as query parameter
5. When the authentication process successfully completes the server responds with 302 OK and a specific finish query parameter which must match the value of finishEndpointParam.
6. The client detects this response and then retries the original request with the session cookies in hand.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	finishEndpointParam End point URL param used to detect the completion of the flow.
java.lang.String	header Server HTTP response header name used for indicating OTP challenge.
java.lang.String	headerValue Server HTTP response header value used for indicating OTP challenge.
java.lang.String	redirectToOriginalURLParam URL param, used to mark whether the request should be redirected to the original form.

Constructor Summary

Constructors

Constructor and Description
OTPConfig(java.lang.String header, java.lang.String headerValue, java.lang.String finishEndpointParam, java.lang.String redirectToOriginalURLParam)

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

header

public final java.lang.String header

Server HTTP response header name used for indicating OTP challenge. This facilitates the detection of a OTP challenge in case the server supports the sending of this header.

headerValue

public final java.lang.String headerValue

Server HTTP response header value used for indicating OTP challenge. This facilitates the detection of a OTP challenge in case the server supports the sending of this header.

finishEndpointParam

public final java.lang.String finishEndpointParam

End point URL param used to detect the completion of the flow.

redirectToOriginalURLParam

public final java.lang.String redirectToOriginalURLParam

URL param, used to mark whether the request should be redirected to the original form.

Constructor Detail

OTPConfig

public OTPConfig(java.lang.String header,
                 java.lang.String headerValue,
                 java.lang.String finishEndpointParam,
                 java.lang.String redirectToOriginalURLParam)