org.wso2.charon3.core.exceptions

Class AbstractCharonException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.wso2.charon3.core.exceptions.AbstractCharonException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BadRequestException, CharonException, ConflictException, ForbiddenException, FormatNotSupportedException, InternalErrorException, NotFoundException, NotImplementedException, PayloadTooLargeException, PermanentRedirectException, PreConditionFailedException, TemporyRedirectException, UnauthorizedException

public class AbstractCharonException
extends Exception

If an error occurs in SCIM operation,in addition to returning the HTTP response code, an human readable explanation should also be returned in the body. This class abstract out the Exceptions that should be thrown at a failure of SCIM operation and implementers can use code property to decide which HTTP code needs to be set in header of the response.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	detail A detailed human-readable message.
protected String	schemas Error responses are identified using the following "schema" uri
protected String	scimType the scim type for scim errors as defined in RFC7644 3.12
protected int	status The HTTP status code

Constructor Summary

Constructors

Constructor and Description
AbstractCharonException()
AbstractCharonException(int status, String detail, String scimType)
AbstractCharonException(String message)
AbstractCharonException(String message, Throwable cause) Constructs a new exception with the specified detail message and cause.

Method Summary

Modifier and Type	Method and Description
String	getDetail()
String	getSchemas()
String	getScimType()
int	getStatus()
void	setDetail(String detail)
void	setSchemas(String schemas)
void	setScimType(String scimType)
void	setStatus(int status)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

schemas

protected String schemas

Error responses are identified using the following "schema" uri

detail

protected String detail

A detailed human-readable message.

status

protected int status

The HTTP status code

scimType

protected String scimType

the scim type for scim errors as defined in RFC7644 3.12

Constructor Detail

AbstractCharonException

public AbstractCharonException(int status,
                               String detail,
                               String scimType)

AbstractCharonException

public AbstractCharonException()

AbstractCharonException

public AbstractCharonException(String message,
                               Throwable cause)

Constructs a new exception with the specified detail message and cause. Note that the detail message associated with causeis not automatically incorporated in this exception's detail message.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

AbstractCharonException

public AbstractCharonException(String message)

Method Detail

getSchemas

public String getSchemas()

setSchemas

public void setSchemas(String schemas)

getDetail

public String getDetail()

setDetail

public void setDetail(String detail)

getStatus

public int getStatus()

setStatus

public void setStatus(int status)

getScimType

public String getScimType()

setScimType

public void setScimType(String scimType)