com.google.gdata.util

Class ServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.google.gdata.util.ServiceException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AppsForYourDomainException, AuthenticationException, BatchInterruptedException, ContentCreationException, ContentModelException, ContentValidationException, EntityTooLargeException, InvalidEntryException, Kind.AdaptorException, NoLongerAvailableException, NotAcceptableException, NotImplementedException, NotModifiedException, OAuthProxyException, ParseException, PreconditionFailedException, RateLimitExceededException, RedirectRequiredException, ResourceNotFoundException, ResumableUploadException, ServiceConfigurationException, ServiceForbiddenException, ServiceUnavailableException, UnprocessableEntityException, UnsupportedMediaTypeException, VersionConflictException

public class ServiceException
extends Exception

The ServiceException class is the base exception class used to indicate an error while processing a GDataRequest.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ServiceException(ErrorContent errorCode) Initializes the ServiceException using an ErrorContent object that encapsulates most of the information about the error.
ServiceException(ErrorContent errorCode, Throwable cause) Initializes the ServiceException using an ErrorContent object that encapsulates most of the information about the error, and an embedded exception.
ServiceException(HttpURLConnection httpConn) Initializes the ServiceException using the error response data from an HTTP connection.
ServiceException(String message)
ServiceException(String message, Throwable cause)
ServiceException(Throwable cause)

Method Summary

Methods

Modifier and Type	Method and Description
ServiceException	addSibling(ServiceException newbie) Make and siblings, returning .
String	getCodeName() Return error code.
String	getDebugInfo() Return debugging information.
String	getDomainName() Return error domain.
String	getExtendedHelp() Return URI for extended help
int	getHttpErrorCodeOverride()
List<String>	getHttpHeader(String header) Return the value for requested internal HTTP header or null if the header is not present.
Map<String,List<String>>	getHttpHeaders() Return the internal HTTP headers in modifiable form.
String	getInternalReason() Return error internal reason.
String	getLocation() Return error location.
ErrorContent.LocationType	getLocationType() Return error location type.
String	getMessage() Return message: same as getInternalReason.
OAuthProxyResponse	getOAuthProxyResponse() Returns the headers related to the OAuth Proxy.
String	getResponseBody()
ContentType	getResponseContentType()
String	getSendReport() Return URI to send report to.
List<ServiceException>	getSiblings() Return an unmodifiable copy of the sibling list.
boolean	hasOAuthProxyResponse() Returns whether or not the request has OAuth Proxy-related headers.
Throwable	initCause(Throwable cause)
boolean	matches(ErrorContent code) Return true if this ServiceException matches the specified ErrorContent in domain name and code name.
boolean	matchesAny(ErrorContent errorCode) Return true if this ServiceException or any of its sibling exceptions matches the specified ErrorContent in domain name and code name.
void	setCode(String code) Set error code.
void	setDebugInfo(String debugInfo) Set debugging information.
void	setDomain(String domain) Set error domain.
void	setExtendedHelp(String extendedHelp) Set URI for extended help.
void	setHeaderLocation(String location) Set header name for an error in a header.
void	setHttpErrorCodeOverride(int v)
void	setInternalReason(String internalReason) Sets the internal reason of the error.
void	setLocation(String location) Set generic error location.
void	setResponse(ContentType contentType, String body) Set HTTP response type and body simultaneously.
void	setResponseBody(String body)
void	setResponseContentType(ContentType v)
void	setSendReport(String sendReport) Set URI to send report to.
void	setXpathLocation(String location) Set XPath-based error location.
String	toString()
String	toXmlErrorMessage() Converts the exception into a well-formated XML error message suitable for external uses.
String	toXmlErrorMessage(boolean includeDebugInfo) Converts the exception into a well-formated XML error message suitable for external uses.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceException

public ServiceException(String message)

ServiceException

public ServiceException(String message,
                Throwable cause)

ServiceException

public ServiceException(Throwable cause)

ServiceException

public ServiceException(HttpURLConnection httpConn)
                 throws IOException

Initializes the ServiceException using the error response data from an HTTP connection. This constructor is used in the client library to approximately reconstitute the constructor as it appeared in the server.

This constructor uses a ServiceExceptionInitializer to do the work of parsing the connection and calling our setters to initialize our fields. The initializer object may also create sibling ServiceExceptions.

Parameters:

httpConn - is the http connection from which the error message (structured or simple) is read

Throws:

IOException - if network error receiving the error response

ServiceException

public ServiceException(ErrorContent errorCode)

Initializes the ServiceException using an ErrorContent object that encapsulates most of the information about the error. Most ErrorContent instances are declared in a subclass of ErrorDomain containing all the errors for a GData domain (service or portion of service).

ServiceException

public ServiceException(ErrorContent errorCode,
                Throwable cause)

Initializes the ServiceException using an ErrorContent object that encapsulates most of the information about the error, and an embedded exception. Most ErrorContent instances are declared in a subclass of ErrorDomain containing all the errors for this GData domain (service or portion of service).

Method Detail

initCause

public Throwable initCause(Throwable cause)

If cause is a ServiceException, it is added to the list of siblings so that the original exception appears when using XML error output.

Overrides:

initCause in class Throwable

getHttpErrorCodeOverride

public int getHttpErrorCodeOverride()

setHttpErrorCodeOverride

public void setHttpErrorCodeOverride(int v)

getResponseContentType

public ContentType getResponseContentType()

setResponseContentType

public void setResponseContentType(ContentType v)

getResponseBody

public String getResponseBody()

setResponseBody

public void setResponseBody(String body)

setResponse

public void setResponse(ContentType contentType,
               String body)

Set HTTP response type and body simultaneously. They are inherently coupled together: a body without a content type is meaningless; a content type without a body is useless.

toXmlErrorMessage

public String toXmlErrorMessage()

Converts the exception into a well-formated XML error message suitable for external uses.

toXmlErrorMessage

public String toXmlErrorMessage(boolean includeDebugInfo)

Converts the exception into a well-formated XML error message suitable for external uses.

Parameters:

includeDebugInfo - if true, include debug information. Such error message should only be returned to internal clients.

getHttpHeaders

public Map<String,List<String>> getHttpHeaders()

Return the internal HTTP headers in modifiable form.

getHttpHeader

public List<String> getHttpHeader(String header)

Return the value for requested internal HTTP header or null if the header is not present.

Parameters:

header - requested header name

Returns:

list of string values for the specified header or null if requested header is not found.

toString

public String toString()

Overrides:

toString in class Throwable

getDomainName

public String getDomainName()

Return error domain.

Defaults to "GData", indicating an error that has not yet been upgraded to the new architecture.

setDomain

public void setDomain(String domain)

Set error domain.

Throws:

NullPointerException - if domain is null.

getCodeName

public String getCodeName()

Return error code.

Defaults to the class name of this.

setCode

public void setCode(String code)

Set error code.

Throws:

NullPointerException - if code is null.

getLocation

public String getLocation()

Return error location.

getLocationType

public ErrorContent.LocationType getLocationType()

Return error location type.

setXpathLocation

public void setXpathLocation(String location)

Set XPath-based error location. This must be a valid XPath expression sibling to the atom:entry element (or the atom:feed element if we are not in an entry).

Throws:

NullPointerException - if location is null.

setHeaderLocation

public void setHeaderLocation(String location)

Set header name for an error in a header.

Throws:

NullPointerException - if location is null.

setLocation

public void setLocation(String location)

Set generic error location.

Throws:

NullPointerException - if location is null.

getInternalReason

public String getInternalReason()

Return error internal reason.

Defaults to the message set at construction time.

getMessage

public String getMessage()

Return message: same as getInternalReason.

Overrides:

getMessage in class Throwable

setInternalReason

public void setInternalReason(String internalReason)

Sets the internal reason of the error.

Throws:

NullPointerException - if internalReason is null.

getExtendedHelp

public String getExtendedHelp()

Return URI for extended help

setExtendedHelp

public void setExtendedHelp(String extendedHelp)

Set URI for extended help.

Throws:

NullPointerException - if extendedHelp is null.

getSendReport

public String getSendReport()

Return URI to send report to.

setSendReport

public void setSendReport(String sendReport)

Set URI to send report to.

Throws:

NullPointerException - if sendReport is null.

getDebugInfo

public String getDebugInfo()

Return debugging information. Defaults to the stack trace.

setDebugInfo

public void setDebugInfo(String debugInfo)

Set debugging information.

Throws:

NullPointerException - if debugInfo is null.

getSiblings

public List<ServiceException> getSiblings()

Return an unmodifiable copy of the sibling list.

addSibling

public ServiceException addSibling(ServiceException newbie)

Make and siblings, returning . All sibling exceptions are jointly converted to an error message when any of them are thrown.

matches

public boolean matches(ErrorContent code)

Return true if this ServiceException matches the specified ErrorContent in domain name and code name. Sibling exceptions are not checked.

matchesAny

public boolean matchesAny(ErrorContent errorCode)

Return true if this ServiceException or any of its sibling exceptions matches the specified ErrorContent in domain name and code name. If you want to know which particular ServiceException matched, call getSiblings() and examine the individual ServiceExceptions with matches(com.google.gdata.util.ErrorContent).

hasOAuthProxyResponse

public boolean hasOAuthProxyResponse()

Returns whether or not the request has OAuth Proxy-related headers.

getOAuthProxyResponse

public OAuthProxyResponse getOAuthProxyResponse()

Returns the headers related to the OAuth Proxy. If there are no OAuth Proxy related headers on the request, this method will return an OAuthProxyResponse object with null values for the headers. Use hasOAuthProxyResponse() to determine whether the request has OAuth Proxy information.