Package com.pingidentity.sdk.captchaprovider

Class CaptchaContext

java.lang.Object

com.pingidentity.sdk.captchaprovider.CaptchaContext

public class CaptchaContext
extends Object

A wrapper class for contextual information used by CaptchaProvider methods.

Since:

11.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CaptchaContext.Builder	A helper to create CaptchaContext instance.

Method Summary

Modifier and Type	Method	Description
String	getAction()	Get the 'action' of the request.
Map<String,Object>	getInParameters()	Get the map that contains a set of input parameters.
javax.servlet.http.HttpServletRequest	getRequest()	Get the HttpServletRequest.
javax.servlet.http.HttpServletResponse	getResponse()	Get the HttpServletResponse instance

Methods inherited from class java.lang.Object

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

Method Details

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Get the HttpServletRequest.

Returns:

HttpServletRequest, or null.

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Get the HttpServletResponse instance

Returns:

HttpServletResponse or null,

Since:

11.3

getAction

public String getAction()

Get the 'action' of the request. See CaptchaProvider for 'actions'.

Returns:

the action, or null.

getInParameters

public Map<String,Object> getInParameters()

Get the map that contains a set of input parameters.

Current available parameters are: IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_TRACKING_ID IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_REQUEST_ID IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_TRANSACTION_ID IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_USERID IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_USERID_AUTHENTICATED IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_PARTNER_ENTITYID IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_OAUTH_CLIENT_ID IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_SP_ADAPTER_ID IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_CHAINED_ATTRIBUTES IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_DEVICE_SHARING_TYPE IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_RESUME_PATH IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_APPLICATION_NAME IdpAuthenticationAdapterV2.IN_PARAMETER_NAME_APPLICATION_ICON_URL

Returns:

a map that contains a set of input parameters, or empty map

Since:

11.3