Package org.forgerock.openig.ping.protect

Class PingOneProtectEvaluationContext

java.lang.Object

org.forgerock.services.context.AbstractContext

org.forgerock.openig.ping.protect.PingOneProtectEvaluationContext

All Implemented Interfaces:

Context

public final class PingOneProtectEvaluationContext
extends AbstractContext

Context supporting risk analysis with PingOne Protect, capturing the evaluation result. This captures the evaluation id, risk level and score, and client IP address.

If a context is marked pending completion then the result of actions associated with the evaluation have not yet been reported back to Protect (and should be when possible) - see isPendingCompletion.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The PingOneProtectEvaluationContext's name.

Fields inherited from class org.forgerock.services.context.AbstractContext

data

Method Summary

Modifier and Type	Method	Description
String	getClientIpAddress()	Get the evaluation client IP address.
String	getEvaluationId()	Get the evaluation identifier.
String	getLevel()	Get the evaluation result level.
int	getScore()	Get the evaluation result score.
boolean	isPendingCompletion()	Indicate if this context represents an evaluation result that is pending completion with Protect.
void	setComplete()	Set that this context represents an evaluation result that has been marked complete with Protect.

Methods inherited from class org.forgerock.services.context.AbstractContext

as, asContext, containsContext, containsContext, get, getContext, getContextName, getId, getParent, getRootId, isRootContext, toJsonValue, toString

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

The PingOneProtectEvaluationContext's name.

See Also:

• Constant Field Values

Method Details

getEvaluationId

public String getEvaluationId()

Get the evaluation identifier.

Returns:

the evaluation identifier

getLevel

public String getLevel()

Get the evaluation result level.

Returns:

the evaluation result level

getScore

public int getScore()

Get the evaluation result score.

Returns:

the evaluation score

getClientIpAddress

public String getClientIpAddress()

Get the evaluation client IP address.

Returns:

the client IP address

isPendingCompletion

public boolean isPendingCompletion()

Indicate if this context represents an evaluation result that is pending completion with Protect. An evaluation is pending complete if the result of post-evaluation actions (e.g. MFA) has not yet been reported back to Protect (and updated local session state). It is important only to feedback the status if Protect originally provided the result (i.e. the evaluation was not based on cached session state).

Returns:

true if the evaluation is pending completion, otherwise false

setComplete

public void setComplete()

Set that this context represents an evaluation result that has been marked complete with Protect.

See Also:

• isPendingCompletion