com.xero.api.exception

Class XeroExceptionHandler

java.lang.Object

com.xero.api.exception.XeroExceptionHandler

public class XeroExceptionHandler
extends Object

This class is to handle Xero API exceptions with the help of the XeroJAXBMarshaller

Constructor Summary

Constructors

Constructor and Description
XeroExceptionHandler()

Method Summary

Modifier and Type	Method and Description
XeroApiException	convertException(IOException ioe) For backwards comparability with xero-java-sdk version 0.6.0 keep the old way of handling exceptions
XeroApiException	handleBadRequest(com.google.api.client.http.HttpResponseException httpResponseException) Handle a HTTP 400 Bad Request from Xero.
XeroApiException	handleBadRequest(String content)
XeroApiException	handleBadRequest(String content, int code)
XeroApiException	handleBadRequest(String content, int code, boolean isJson)
XeroApiException	newApiException(com.google.api.client.http.HttpResponseException httpResponseException) For backwards comparability with xero-java-sdk version 0.6.0 keep the old way of handling exceptions
XeroApiException	newApiException(String content, int code)

Methods inherited from class java.lang.Object

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

Constructor Detail

XeroExceptionHandler

public XeroExceptionHandler()

Method Detail

handleBadRequest

public XeroApiException handleBadRequest(com.google.api.client.http.HttpResponseException httpResponseException)

Handle a HTTP 400 Bad Request from Xero. This method will build a XeroApiException containing ApiException element with a useful summary of the reason for the error. Use ApiException to get a list of the errors pertaining to the call in question.

For example: if you use XeroClient.createPayments(List) and this fails with a XeroApiException, you can extract details from the exception with the following code example.

 List<Elements> elements = xeroApiException.getApiException().getElements();
 Elements element = elements.get(0);
 List<Object> dataContractBase = element.getDataContractBase();
 for (Object dataContract : dataContractBase) {
      Payment failedPayment = (Payment) dataContract;
      ArrayOfValidationError validationErrors = failedPayment.getValidationErrors();
      ...
 }
 

Or if you use XeroClient.createInvoices(List) and this fails with a XeroApiException, you can extract details from the exception with the following code example.

 List<Elements> elements = xeroApiException.getApiException().getElements();
 Elements element = elements.get(0);
 List<Object> dataContractBase = element.getDataContractBase();
 for (Object dataContract : dataContractBase) {
      Invoice failedInvoice = (Invoice) dataContract;
      ArrayOfValidationError validationErrors = failedInvoice.getValidationErrors();
      ...
 }
 

Parameters:

httpResponseException - the exception to handle

Returns:

XeroApiException containing ApiException with a useful summary of the reason for the error.

handleBadRequest

public XeroApiException handleBadRequest(String content)

handleBadRequest

public XeroApiException handleBadRequest(String content,
                                         int code,
                                         boolean isJson)

handleBadRequest

public XeroApiException handleBadRequest(String content,
                                         int code)

convertException

public XeroApiException convertException(IOException ioe)

For backwards comparability with xero-java-sdk version 0.6.0 keep the old way of handling exceptions

Parameters:

ioe - exception to convert

Returns:

the converted exception

newApiException

public XeroApiException newApiException(com.google.api.client.http.HttpResponseException httpResponseException)

For backwards comparability with xero-java-sdk version 0.6.0 keep the old way of handling exceptions

Parameters:

httpResponseException - exception to handle

Returns:

XeroApiException

newApiException

public XeroApiException newApiException(String content,
                                        int code)