ExceptionHandler (DataONE Java Client Library 2.4.0-SNAPSHOT API)

java.lang.Object
- org.dataone.service.util.ExceptionHandler

```
public class ExceptionHandler
extends Object
```
uniform deserialization of DataONE Exceptions that may be rethrown

Author:

waltz, rnahf

Field Summary

Fields
Modifier and Type Field and Description

protected static org.apache.commons.logging.Log log

Fields
Modifier and Type	Field and Description
`protected static org.apache.commons.logging.Log`	`log`

Constructor Summary

Constructors
Constructor and Description

ExceptionHandler()

Constructors
Constructor and Description
`ExceptionHandler()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`deserializeAndThrowException(org.apache.http.HttpResponse response)`
`static void`	`deserializeAndThrowException(InputStream errorStream, String contentType, Integer statusCode, String reason)` Throw the exception that is contained in an HTTP response A response from an HTTP call may be determined to have an error.
`static void`	`deserializeHeadersAndThrowException(int code, org.apache.http.Header[] headers)`
`protected static <T> T`	`deserializeServiceType(Class<T> domainClass, InputStream is)` Wrapper for Marshalling method that recasts exceptions to ServiceFailure;
`static <T> BaseException`	`deserializeXml(InputStream errorStream, String defaultMessage)`
`static InputStream`	`filterErrors(org.apache.http.HttpResponse res)`
`static InputStream`	`filterErrors(org.apache.http.HttpResponse response, boolean allowRedirects)` This method maps an HttpResponse onto an InputStream by consuming the response headers and throwing an exception when appropriate.
`static InputStream`	`filterErrors(InputStream is, boolean isException, String contentType)`
`static org.apache.http.Header[]`	`filterErrorsHeader(org.apache.http.HttpResponse response, String httpMethod)` will filter serialized errors coming from the HEAD request by deserializing them and putting on the exception thread(?).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.apache.commons.logging.Log log

Constructor Detail
- ExceptionHandler
```
public ExceptionHandler()
```

Method Detail

filterErrors

public static InputStream filterErrors(org.apache.http.HttpResponse res)
                                throws AuthenticationTimeout,
                                       IdentifierNotUnique,
                                       InsufficientResources,
                                       InvalidCredentials,
                                       InvalidRequest,
                                       InvalidSystemMetadata,
                                       InvalidToken,
                                       NotAuthorized,
                                       NotFound,
                                       NotImplemented,
                                       ServiceFailure,
                                       UnsupportedMetadataType,
                                       UnsupportedType,
                                       VersionMismatch,
                                       IllegalStateException,
                                       IOException,
                                       org.apache.http.HttpException,
                                       SynchronizationFailed

Throws:: AuthenticationTimeout; IdentifierNotUnique; InsufficientResources; InvalidCredentials; InvalidRequest; InvalidSystemMetadata; InvalidToken; NotAuthorized; NotFound; NotImplemented; ServiceFailure; UnsupportedMetadataType; UnsupportedType; VersionMismatch; IllegalStateException; IOException; org.apache.http.HttpException; SynchronizationFailed

filterErrors

public static InputStream filterErrors(org.apache.http.HttpResponse response,
                                       boolean allowRedirects)
                                throws AuthenticationTimeout,
                                       IdentifierNotUnique,
                                       InsufficientResources,
                                       InvalidCredentials,
                                       InvalidRequest,
                                       InvalidSystemMetadata,
                                       InvalidToken,
                                       NotAuthorized,
                                       NotFound,
                                       NotImplemented,
                                       ServiceFailure,
                                       UnsupportedMetadataType,
                                       UnsupportedType,
                                       VersionMismatch,
                                       IllegalStateException,
                                       IOException,
                                       org.apache.http.HttpException,
                                       SynchronizationFailed

This method maps an HttpResponse onto an InputStream by consuming the response headers and throwing an exception when appropriate.

Parameters:: response -; allowRedirects - - if true, does not throw exceptions for status codes of 3xx
Returns:: the inputstream of the response content.
Throws:: AuthenticationTimeout; IdentifierNotUnique; InsufficientResources; InvalidCredentials; InvalidRequest; InvalidSystemMetadata; InvalidToken; NotAuthorized; NotFound; NotImplemented; ServiceFailure; UnsupportedMetadataType; UnsupportedType; VersionMismatch; IllegalStateException; IOException; org.apache.http.HttpException; SynchronizationFailed

filterErrorsHeader

public static org.apache.http.Header[] filterErrorsHeader(org.apache.http.HttpResponse response,
                                                          String httpMethod)
                                                   throws AuthenticationTimeout,
                                                          IdentifierNotUnique,
                                                          InsufficientResources,
                                                          InvalidCredentials,
                                                          InvalidRequest,
                                                          InvalidSystemMetadata,
                                                          InvalidToken,
                                                          NotAuthorized,
                                                          NotFound,
                                                          NotImplemented,
                                                          ServiceFailure,
                                                          UnsupportedMetadataType,
                                                          UnsupportedType,
                                                          VersionMismatch,
                                                          IllegalStateException,
                                                          IOException,
                                                          org.apache.http.HttpException,
                                                          SynchronizationFailed

will filter serialized errors coming from the HEAD request by deserializing them and putting on the exception thread(?). Exception state is triggered if http status code is not 200 (OK) or 204 (NO_CONTENT). Where possible, assembles a dataone exception from header entries corresponding to the standard base exception parts. Because this method functions (like filterErrors) as an adapter method, returning just the headers from the response, it consumes the entity contained in the response that is passed in, for proper release of connection resources.

Parameters:: response - - the http response
Returns:: - Header[] from the http response
Throws:: AuthenticationTimeout; IdentifierNotUnique; InsufficientResources; InvalidCredentials; InvalidRequest; InvalidSystemMetadata; InvalidToken; NotAuthorized; NotFound; NotImplemented; ServiceFailure; UnsupportedMetadataType; UnsupportedQueryType; UnsupportedType; VersionMismatch; IllegalStateException; IOException; org.apache.http.HttpException; SynchronizationFailed

deserializeHeadersAndThrowException

public static void deserializeHeadersAndThrowException(int code,
                                                       org.apache.http.Header[] headers)
                                                throws AuthenticationTimeout,
                                                       IdentifierNotUnique,
                                                       InsufficientResources,
                                                       InvalidCredentials,
                                                       InvalidRequest,
                                                       InvalidSystemMetadata,
                                                       InvalidToken,
                                                       NotAuthorized,
                                                       NotFound,
                                                       NotImplemented,
                                                       ServiceFailure,
                                                       UnsupportedMetadataType,
                                                       UnsupportedType,
                                                       VersionMismatch,
                                                       IllegalStateException,
                                                       IOException,
                                                       org.apache.http.HttpException,
                                                       SynchronizationFailed

Throws:: AuthenticationTimeout; IdentifierNotUnique; InsufficientResources; InvalidCredentials; InvalidRequest; InvalidSystemMetadata; InvalidToken; NotAuthorized; NotFound; NotImplemented; ServiceFailure; UnsupportedMetadataType; UnsupportedType; VersionMismatch; IllegalStateException; IOException; org.apache.http.HttpException; SynchronizationFailed

filterErrors

public static InputStream filterErrors(InputStream is,
                                       boolean isException,
                                       String contentType)
                                throws AuthenticationTimeout,
                                       IdentifierNotUnique,
                                       InsufficientResources,
                                       InvalidCredentials,
                                       InvalidRequest,
                                       InvalidSystemMetadata,
                                       InvalidToken,
                                       NotAuthorized,
                                       NotFound,
                                       NotImplemented,
                                       ServiceFailure,
                                       UnsupportedMetadataType,
                                       UnsupportedType,
                                       VersionMismatch,
                                       IllegalStateException,
                                       IOException,
                                       SynchronizationFailed

Throws:: AuthenticationTimeout; IdentifierNotUnique; InsufficientResources; InvalidCredentials; InvalidRequest; InvalidSystemMetadata; InvalidToken; NotAuthorized; NotFound; NotImplemented; ServiceFailure; UnsupportedMetadataType; UnsupportedType; VersionMismatch; IllegalStateException; IOException; SynchronizationFailed

deserializeAndThrowException

public static void deserializeAndThrowException(org.apache.http.HttpResponse response)
                                         throws NotFound,
                                                InvalidToken,
                                                ServiceFailure,
                                                NotAuthorized,
                                                NotFound,
                                                IdentifierNotUnique,
                                                UnsupportedType,
                                                InsufficientResources,
                                                InvalidSystemMetadata,
                                                NotImplemented,
                                                InvalidCredentials,
                                                InvalidRequest,
                                                IOException,
                                                AuthenticationTimeout,
                                                UnsupportedMetadataType,
                                                VersionMismatch,
                                                org.apache.http.HttpException,
                                                SynchronizationFailed

Parameters:: response -
Throws:: NotFound; InvalidToken; ServiceFailure; NotAuthorized; NotFound; IdentifierNotUnique; UnsupportedType; InsufficientResources; InvalidSystemMetadata; NotImplemented; InvalidCredentials; InvalidRequest; IOException; AuthenticationTimeout; UnsupportedMetadataType; VersionMismatch; org.apache.http.HttpException; SynchronizationFailed

deserializeAndThrowException

public static void deserializeAndThrowException(InputStream errorStream,
                                                String contentType,
                                                Integer statusCode,
                                                String reason)
                                         throws AuthenticationTimeout,
                                                IdentifierNotUnique,
                                                InsufficientResources,
                                                InvalidCredentials,
                                                InvalidRequest,
                                                InvalidSystemMetadata,
                                                InvalidToken,
                                                NotAuthorized,
                                                NotFound,
                                                NotImplemented,
                                                ServiceFailure,
                                                UnsupportedMetadataType,
                                                UnsupportedType,
                                                SynchronizationFailed,
                                                VersionMismatch

Throw the exception that is contained in an HTTP response A response from an HTTP call may be determined to have an error. The reponse is wrapped in an InputStream and its content type is determined.

Parameters:: errorStream -; contentType -
Throws:: NotFound; InvalidToken; ServiceFailure; NotAuthorized; NotFound; IdentifierNotUnique; UnsupportedType; InsufficientResources; InvalidSystemMetadata; NotImplemented; InvalidCredentials; InvalidRequest; IOException; AuthenticationTimeout; UnsupportedMetadataType; UnsupportedQueryType; VersionMismatch; org.apache.http.HttpException; SynchronizationFailed

deserializeXml

public static <T> BaseException deserializeXml(InputStream errorStream,
                                               String defaultMessage)
                                        throws ParserConfigurationException,
                                               SAXException,
                                               IOException

Throws:: ParserConfigurationException; SAXException; IOException

deserializeServiceType

protected static <T> T deserializeServiceType(Class<T> domainClass,
                                              InputStream is)
                                       throws ServiceFailure

Wrapper for Marshalling method that recasts exceptions to ServiceFailure;

Parameters:: type - the class of the object to serialize (i.e. SystemMetadata.class); is - the stream to deserialize from
Throws:: ServiceFailure

Class ExceptionHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

Constructor Detail

ExceptionHandler

Method Detail

filterErrors

filterErrors

filterErrorsHeader

deserializeHeadersAndThrowException

filterErrors

deserializeAndThrowException

deserializeAndThrowException

deserializeXml

deserializeServiceType