Package ai.webscraping.exception

Class ApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

ai.webscraping.exception.WebScrapingAIException

ai.webscraping.exception.ApiException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthenticationException, BadRequestException, GatewayTimeoutException, PaymentRequiredException, RateLimitException, ServerException

public class ApiException
extends WebScrapingAIException

Thrown when the API returns a non-2xx HTTP response. Carries the HTTP status plus the API's documented error envelope (message, status_code, status_message, body). The last three are populated when the API surfaces a target-page error as a 5xx. Catch this to handle any HTTP response error; catch a per-status subclass (BadRequestException, RateLimitException, etc.) to handle a specific status code.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ApiException(int httpStatus, String message, Integer statusCode, String statusMessage, String body, String responseBody)

Method Summary

Modifier and Type	Method	Description
static ApiException	forStatus(int httpStatus, String message, Integer statusCode, String statusMessage, String body, String responseBody)	Maps an HTTP status to the matching per-status subclass; falls back to ApiException.
String	getBody()	body field from the error envelope (target-page error body), or null.
int	getHttpStatus()
String	getResponseBody()	Raw HTTP response body.
Integer	getStatusCode()	Application-level status code from the API error envelope, or null.
String	getStatusMessage()	Application-level status message from the API error envelope, or null.

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

Constructor Details

ApiException

public ApiException(int httpStatus,
 String message,
 Integer statusCode,
 String statusMessage,
 String body,
 String responseBody)

Method Details

forStatus

public static ApiException forStatus(int httpStatus,
 String message,
 Integer statusCode,
 String statusMessage,
 String body,
 String responseBody)

Maps an HTTP status to the matching per-status subclass; falls back to ApiException.

getHttpStatus

public int getHttpStatus()

getStatusCode

public Integer getStatusCode()

Application-level status code from the API error envelope, or null.

getStatusMessage

public String getStatusMessage()

Application-level status message from the API error envelope, or null.

getBody

public String getBody()

body field from the error envelope (target-page error body), or null.

getResponseBody

public String getResponseBody()

Raw HTTP response body.