com.okta.sdk.impl.error

Class DefaultError

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.error.DefaultError

All Implemented Interfaces:

Error, PropertyRetriever, Resource

public class DefaultError
extends AbstractResource
implements Error

Since:

0.5.0

Field Summary

Fields

Modifier and Type	Field and Description
static StringProperty	ERROR_ID

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

properties

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
DefaultError()
DefaultError(Map<String,Object> body)

Method Summary

Modifier and Type	Method and Description
List<ErrorCause>	getCauses() Returns the list of causes of this error.
String	getCode() Returns the Okta specific error code.
Map<String,List<String>>	getHeaders() Returns the HTTP headers associated with this error response.
String	getId() Returns the error ID of this error.
String	getMessage() Returns the detail message string of this error.
Map<String,Property>	getPropertyDescriptors()
int	getStatus() Returns this error's HTTP status code.
DefaultError	setCauses(Map<String,String> causes)
DefaultError	setCode(String code)
DefaultError	setHeaders(Map<String,List<String>> headers)
DefaultError	setId(String requestId)
DefaultError	setMessage(String message)
DefaultError	setStatus(int status)

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ERROR_ID

public static final StringProperty ERROR_ID

Constructor Detail

DefaultError

public DefaultError(Map<String,Object> body)

DefaultError

public DefaultError()

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getStatus

public int getStatus()

Description copied from interface: Error

Returns this error's HTTP status code.

Specified by:

getStatus in interface Error

Returns:

the status code of this Error

setStatus

public DefaultError setStatus(int status)

getCode

public String getCode()

Description copied from interface: Error

Returns the Okta specific error code.

Specified by:

getCode in interface Error

Returns:

an Okta specific error code

setCode

public DefaultError setCode(String code)

getMessage

public String getMessage()

Description copied from interface: Error

Returns the detail message string of this error.

Specified by:

getMessage in interface Error

Returns:

message string of this error.

setMessage

public DefaultError setMessage(String message)

getId

public String getId()

Description copied from interface: Error

Returns the error ID of this error. This maybe used when opening a support case and troubleshooting.

Specified by:

getId in interface Error

Returns:

error ID of this error

setId

public DefaultError setId(String requestId)

getCauses

public List<ErrorCause> getCauses()

Description copied from interface: Error

Returns the list of causes of this error. When validating a resource (for example a User) multiple validation errors could occur.

Specified by:

getCauses in interface Error

Returns:

A list of causes, which could be {code}null{code} or empty

setCauses

public DefaultError setCauses(Map<String,String> causes)

getHeaders

public Map<String,List<String>> getHeaders()

Description copied from interface: Error

Returns the HTTP headers associated with this error response.

Specified by:

getHeaders in interface Error

Returns:

A list headers, which could be {code}null{code} or empty

setHeaders

public DefaultError setHeaders(Map<String,List<String>> headers)