edu.byu.hbll.symwsclient

Class SymwsClientException

java.lang.Object

java.lang.Throwable

java.lang.Exception

edu.byu.hbll.symwsclient.SymwsClientException

All Implemented Interfaces:

Serializable

public class SymwsClientException
extends Exception

Thrown when a Symphony Web Service request reaches the desired host server, but subsequently fails. Such failures could include:

• 404 Not Found error
• Calling a privileged service without a valid session
• Attempting to retrieve data that does not exist

In the case of a general HTTP error (such as a 404) there may be no additional explanation. However, in most cases, a SymwsFault object will be attached to the exception instance, providing additional detail as to the failure and its cause.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SymwsClientException() Constructs a new instance with no information.
SymwsClientException(String message) Constructs a new instance with only a message string to provide information
SymwsClientException(URI uri, int responseStatus, String responseBody) Constructs a new instance with basic information about the HTTP request and response
SymwsClientException(URI uri, int responseStatus, String responseBody, String message) Constructs a new instance with basic information about the HTTP request and response
SymwsClientException(URI uri, int responseStatus, String responseBody, SymwsFault fault) Constructs a new instance with information about the HTTP request and response, along with a SymwsFault
SymwsClientException(URI uri, javax.ws.rs.core.Response response) Constructs a new instance with basic information about the HTTP request and response
SymwsClientException(URI uri, javax.ws.rs.core.Response response, String message) Constructs a new instance with basic information about the HTTP request and response

Method Summary

Modifier and Type	Method and Description
SymwsFault	getFault()
String	getResponseBody()
int	getResponseStatus()
URI	getUri()
boolean	hasFault() Indicates whether this instance has an attached SymwsFault

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 Detail

SymwsClientException

public SymwsClientException()

Constructs a new instance with no information.

SymwsClientException

public SymwsClientException(String message)

Constructs a new instance with only a message string to provide information

Parameters:

message - The message to attach to this exception

SymwsClientException

public SymwsClientException(URI uri,
                            javax.ws.rs.core.Response response)

Constructs a new instance with basic information about the HTTP request and response

Parameters:

uri - The URI of the service endpoint that was called

response - The Response object returned by the service. This Response entity will be buffered during exception creation

SymwsClientException

public SymwsClientException(URI uri,
                            javax.ws.rs.core.Response response,
                            String message)

Constructs a new instance with basic information about the HTTP request and response

Parameters:

uri - The URI of the service endpoint that was called

response - The Response object returned by the service. This Response entity will be buffered during exception creation

message - The message to attach to this exception

SymwsClientException

public SymwsClientException(URI uri,
                            int responseStatus,
                            String responseBody)

Constructs a new instance with basic information about the HTTP request and response

Parameters:

uri - The URI of the service endpoint that was called

responseStatus - The HTTP status code returned in the Response object

responseBody - The reponse body/entity returned in the Response object

SymwsClientException

public SymwsClientException(URI uri,
                            int responseStatus,
                            String responseBody,
                            String message)

Constructs a new instance with basic information about the HTTP request and response

Parameters:

uri - The URI of the service endpoint that was called

responseStatus - The HTTP status code returned in the Response object

responseBody - The reponse body/entity returned in the Response object

message - The message to attach to this exception

SymwsClientException

public SymwsClientException(URI uri,
                            int responseStatus,
                            String responseBody,
                            SymwsFault fault)

Constructs a new instance with information about the HTTP request and response, along with a SymwsFault

Parameters:

uri - The URI of the service endpoint that was called

responseStatus - The HTTP status code returned in the Response object

responseBody - The reponse body/entity returned in the Response object

fault - The SymwsFault returned with the Response body/entity

Method Detail

hasFault

public boolean hasFault()

Indicates whether this instance has an attached SymwsFault

Returns:

true if this instance has a SymwsFault, false otherwise

getUri

public URI getUri()

Returns:

the uri

getResponseStatus

public int getResponseStatus()

Returns:

the responseStatus

getResponseBody

public String getResponseBody()

Returns:

the responseBody

getFault

public SymwsFault getFault()

Returns:

the fault