ai.nightfall.scan.model

Class NightfallAPIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

ai.nightfall.scan.model.BaseNightfallException

ai.nightfall.scan.model.NightfallAPIException

All Implemented Interfaces:

Serializable

public class NightfallAPIException
extends BaseNightfallException

The exception thrown when the Nightfall API returns an HTTP status code in the range [400, 599]. Embeds the standard Nightfall error object for debugging.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NightfallAPIException(String message) Create a new instance of the exception.
NightfallAPIException(String message, NightfallErrorResponse error, int httpStatusCode) Create a new instance of the exception.

Method Summary

Modifier and Type	Method and Description
NightfallErrorResponse	getError() Get the error object returned by Nightfall.
String	getMessage()
String	toString()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NightfallAPIException

public NightfallAPIException(String message)

Create a new instance of the exception.

Parameters:

message - an error message

NightfallAPIException

public NightfallAPIException(String message,
                             NightfallErrorResponse error,
                             int httpStatusCode)

Create a new instance of the exception.

Parameters:

message - an error message

error - the standardized error object returned by the Nightfall API

httpStatusCode - the HTTP status code

Method Detail

toString

public String toString()

Overrides:

toString in class Throwable

getError

public NightfallErrorResponse getError()

Get the error object returned by Nightfall.

Returns:

the standard error object that was returned by the Nightfall API

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable