public interface IdpResult
IdpException
.
In OOB API, it is used as a base class for the OOB server responses.Modifier and Type | Method and Description |
---|---|
int |
getCode()
Retrieves the Idp result code.
|
int |
getDomain()
Retrieves the Idp result domain.
|
java.lang.Exception |
getException()
Retrieves the exception from lower level which is a cause for the failure result.
|
java.lang.String |
getMessage()
Retrieves the message text.
|
java.lang.Object |
getUserInfo(java.lang.String key)
Retrieves the additional data from the result object for the specified
key.
|
java.util.Set<java.lang.String> |
getUserInfoKeys()
Retrieves the complete set of keys of user data carried by this result object.
|
boolean |
isFailed()
Utility method for easily checking whether this result means success or failure.
|
boolean |
isSucceeded()
Utility method for easily checking whether this result means success or failure.
|
boolean isSucceeded()
true
else false
.boolean isFailed()
true
else false
.int getCode()
int getDomain()
java.lang.String getMessage()
java.lang.Exception getException()
null
, please check getCode()
functions - when the failure
was not caused by any exception.null
.java.lang.Object getUserInfo(java.lang.String key)
key
- The key from which to retrieve the user specified data. The
key values depend on the result code/domain.null
if no such
key exists. If the key exists then the data is never null
.java.util.Set<java.lang.String> getUserInfoKeys()
null
.