/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.transform;
import static com.amazonaws.util.XpathUtils.asString;
import static com.amazonaws.util.XpathUtils.xpath;
import javax.xml.xpath.XPath;
import org.w3c.dom.Node;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.AmazonServiceException.ErrorType;
/**
* Error unmarshaller that knows how to interpret a standard AWS error message
* (i.e. where to find the AWS error code, the error message, etc.) and turn it
* into an AmazonServiceException.
*
* @see LegacyErrorUnmarshaller
*/
public class StandardErrorUnmarshaller extends AbstractErrorUnmarshaller<Node> {
/**
* Constructs a new unmarshaller that will unmarshall a standard AWS error
* message as a generic AmazonServiceException object.
*/
public StandardErrorUnmarshaller() {}
/**
* Constructor allowing subclasses to specify a specific type of
* AmazonServiceException to instantiating when populating the exception
* object with data from the error message.
*
* @param exceptionClass
* The class of AmazonServiceException to create and populate
* when unmarshalling the error message.
*/
protected StandardErrorUnmarshaller(Class<? extends AmazonServiceException> exceptionClass) {
super(exceptionClass);
}
/**
* @see com.amazonaws.transform.Unmarshaller#unmarshall(java.lang.Object)
*/
public AmazonServiceException unmarshall(Node in) throws Exception {
XPath xpath = xpath();
String errorCode = parseErrorCode(in, xpath);
String errorType = asString("ErrorResponse/Error/Type", in, xpath);
String requestId = asString("ErrorResponse/RequestId", in, xpath);
String message = asString("ErrorResponse/Error/Message", in, xpath);
AmazonServiceException ase = newException(message);
ase.setErrorCode(errorCode);
ase.setRequestId(requestId);
if (errorType == null) {
ase.setErrorType(ErrorType.Unknown);
} else if (errorType.equalsIgnoreCase("Receiver")) {
ase.setErrorType(ErrorType.Service);
} else if (errorType.equalsIgnoreCase("Sender")) {
ase.setErrorType(ErrorType.Client);
}
return ase;
}
/**
* Returns the AWS error code for the specified error response.
*
* @param in
* The DOM tree node containing the error response.
*
* @return The AWS error code contained in the specified error response.
*
* @throws Exception
* If any problems were encountered pulling out the AWS error
* code.
*/
public String parseErrorCode(Node in) throws Exception {
return asString("ErrorResponse/Error/Code", in);
}
public String parseErrorCode(Node in, XPath xpath) throws Exception {
return asString("ErrorResponse/Error/Code", in, xpath);
}
/**
* Returns the path to the specified property within an error response.
*
* @param property
* The name of the desired property.
*
* @return The path to the specified property within an error message.
*/
public String getErrorPropertyPath(String property) {
return "ErrorResponse/Error/" + property;
}
}