Package diegosneves.github.conectardoacoes.adapters.rest.exception

Class ExternalApiFailureException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

diegosneves.github.conectardoacoes.adapters.rest.exception.CustomException

diegosneves.github.conectardoacoes.adapters.rest.exception.ExternalApiFailureException

All Implemented Interfaces:

Serializable

public class ExternalApiFailureException
extends CustomException

Classe ExternalApiFailureException se estende da classe CustomException e é utilizada para lidar com os erros de interação com APIs externas.

Quando um método que invoca uma API externa encontra erros, ele gera uma nova instância desta exceção, passando informações relevantes como argumentos para o construtor. Estas informações incluem um código de erro em forma de número inteiro, uma mensagem de erro customizada, e a causa original do erro. Esta exceção é então capturada pela lógica do programa para fins de tratamento de erro e logging.

A chave do erro, representada por um número inteiro, é utilizada para recuperar informações detalhadas da exceção (ExceptionDetails) associadas a tal erro através do método CustomException.obtainExceptionDetails(java.lang.Integer). Note que se nenhum ExceptionDetails é encontrado para a referida chave, uma CustomException poderá ser lançada pelo método CustomException.obtainExceptionDetails(java.lang.Integer).

Portanto, a intenção desta classe é encapsular os detalhes de erros que podem ocorrer durante a interação com APIs externas, permitindo que o restante do código lide com esses erros de uma maneira mais abstrata e controlada.

Since:

1.2.0

Author:

diegoneves

See Also:

• CustomException
• RuntimeException
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExternalApiFailureException(Integer term, String message, Throwable cause)	Construtor para criar uma nova instância de ExternalApiFailureException.

Method Summary

Methods inherited from class diegosneves.github.conectardoacoes.adapters.rest.exception.CustomException

getErrorDetails, obtainExceptionDetails

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

ExternalApiFailureException

public ExternalApiFailureException(Integer term,
 String message,
 Throwable cause)

Construtor para criar uma nova instância de ExternalApiFailureException.

Este construtor é chamado quando há um erro ao tentar recuperar informações da API externa. Ele passa os detalhes do erro na forma de um número inteiro (representando uma chave específica de erro), uma mensagem de erro personalizada e a causa original do erro para o construtor da superclasse CustomException.

Os detalhes da exceção são obtidos chamando o método CustomException.obtainExceptionDetails(java.lang.Integer) com o termo fornecido como argumento. Esta chamada pode resultar em uma CustomException se nenhum ExceptionDetails for encontrado para o termo dado.

Parameters:

term - A chave do erro, representado por um número inteiro. Usado para recuperar o ExceptionDetails associado.

message - A mensagem de erro customizada.

cause - A causa root que levou a esta exceção, habitualmente a exceção jogada pela API externa. Representada como um objeto Throwable. Um valor nulo é permitido e indica que a causa é inexistente ou desconhecida.

Throws:

ExternalApiFailureException - A exceção lançada quando uma chamada para a API externa falha.