net.degreedays.api

Class TransportException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.degreedays.api.DegreeDaysApiException

net.degreedays.api.TransportException

All Implemented Interfaces:

java.io.Serializable

public final class TransportException
extends DegreeDaysApiException

Indicates an error transporting a request to the API servers or transporting a response back. Typically some sort of network or connection issue.

The Throwable.getCause() method will typically return an exception that indicates the root cause of the issue. Do be prepared for it to be null if you are inspecting it, but most likely it will be an IOException of some sort. However it could be anything, depending on the type and configuration of the RequestProcessor that the exception originated from.

If an instance of this exception contains a message, please use it for debugging purposes only. The format and content of the string messages is undocumented and subject to change.

Constructor Summary

Constructors

Constructor and Description
TransportException() Constructs a new TransportException with null for its message and cause.
TransportException(java.lang.String message) Constructs a new TransportException with the specified message and null for the cause.
TransportException(java.lang.String message, java.lang.Throwable cause) Constructs a new TransportException with the specified message and cause.
TransportException(java.lang.Throwable cause) Constructs a new TransportException with the specified cause and a detail message of cause.toString() or null if cause is null.

Method Summary

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TransportException

public TransportException(java.lang.String message,
                          java.lang.Throwable cause)

Constructs a new TransportException with the specified message and cause.

Parameters:

message - a description of what went wrong.

cause - the underlying exception that the TransportException should wrap. This can be null if there is no underlying exception.

TransportException

public TransportException(java.lang.String message)

Constructs a new TransportException with the specified message and null for the cause.

Parameters:

message - a description of what went wrong.

TransportException

public TransportException()

Constructs a new TransportException with null for its message and cause.

Generally it would be better to use one of the other more descriptive constructors, to help the user to determine what exactly has gone wrong.

TransportException

public TransportException(java.lang.Throwable cause)

Constructs a new TransportException with the specified cause and a detail message of cause.toString() or null if cause is null.

Parameters:

cause - the underlying exception that the TransportException should wrap. This can be null if there is no underlying exception.