com.pingidentity.sdk.oobauth

Class OOBAuthResultContext

java.lang.Object

com.pingidentity.sdk.oobauth.OOBAuthResultContext

public class OOBAuthResultContext
extends Object

Information about the state of an out-of-band authentication/authorization transaction returned from OOBAuthPlugin.check(String, Map).

Since:

9.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OOBAuthResultContext.Status

Constructor Summary

Constructors

Constructor and Description
OOBAuthResultContext()

Method Summary

Modifier and Type	Method and Description
Set<String>	getApprovedScope() Gets the approved scope as a set of scope value strings.
OOBAuthResultContext.Status	getStatus() Gets the status of the given out-of-band authentication/authorization transaction.
String	getStatusMessage() Gets a status message, which will be propagated in the protocol response (if applicable to the outer protocol).
void	setApprovedScope(Set<String> approvedScope) Sets the approved scope as a set of scope value strings.
void	setStatus(OOBAuthResultContext.Status status) Sets the status of the given out-of-band authentication/authorization transaction.
void	setStatusMessage(String statusMessage) Sets a status message, which will be propagated in the protocol response (if applicable to the outer protocol).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OOBAuthResultContext

public OOBAuthResultContext()

Method Detail

getStatus

public OOBAuthResultContext.Status getStatus()

Gets the status of the given out-of-band authentication/authorization transaction.

Returns:

the status

setStatus

public void setStatus(OOBAuthResultContext.Status status)

Sets the status of the given out-of-band authentication/authorization transaction.

Parameters:

status - the status

getStatusMessage

public String getStatusMessage()

Gets a status message, which will be propagated in the protocol response (if applicable to the outer protocol).

Returns:

the message

setStatusMessage

public void setStatusMessage(String statusMessage)

Sets a status message, which will be propagated in the protocol response (if applicable to the outer protocol).

Parameters:

statusMessage - the message

getApprovedScope

public Set<String> getApprovedScope()

Gets the approved scope as a set of scope value strings. If the approved scope is the same as the requested scope, this can be null.

Returns:

the approved scope as a set of scope value strings or null if the approved scope is the same as the requested scope

setApprovedScope

public void setApprovedScope(Set<String> approvedScope)

Sets the approved scope as a set of scope value strings.

Parameters:

approvedScope - the approved scope as a set of scope value strings or null if the approved scope is the same as the requested scope

toString

public String toString()

Overrides:

toString in class Object