org.xins.client.InvalidRequestException Maven / Gradle / Ivy
The newest version!
/*
* $Id: InvalidRequestException.java,v 1.34 2012/03/15 21:07:39 agoubard Exp $
*
* See the COPYRIGHT file for redistribution and use restrictions.
*/
package org.xins.client;
import java.util.List;
import org.xins.common.service.TargetDescriptor;
import org.xins.common.text.TextUtils;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import org.xins.common.xml.ElementList;
/**
* Exception thrown to indicate a standard error code was received that
* indicates the request from the client-side is considered invalid by the
* server-side.
*
* @version $Revision: 1.34 $ $Date: 2012/03/15 21:07:39 $
* @author Ernst de Haan
*
* @since XINS 1.2.0
*/
public class InvalidRequestException extends StandardErrorCodeException {
/**
* Constructs a new InvalidRequestException.
*
* @param request
* the original request, guaranteed not to be null.
*
* @param target
* the target on which the request was executed, guaranteed not to be
* null.
*
* @param duration
* the call duration, guaranteed to be >= 0L.
*
* @param resultData
* the data returned from the call, guaranteed to be null
* and must have an error code set.
*
* @throws IllegalArgumentException
* if result == null
* || result.{@link XINSCallResultData#getErrorCode() getErrorCode()} == null.
*/
InvalidRequestException(XINSCallRequest request,
TargetDescriptor target,
long duration,
XINSCallResultData resultData)
throws IllegalArgumentException {
super(request, target, duration, resultData,
determineDetail(resultData));
}
/**
* Delegate for the constructor that determines the detail message based on
* a XINSCallResultData object.
*
* @param result
* the {@link XINSCallResultData} instance, should not be
* null.
*
* @return
* the detail message for the constructor to use, never
* null.
*/
private static String determineDetail(XINSCallResultData result) {
// Result must be unsuccessful
String errorCode = result.getErrorCode();
if (errorCode == null) {
throw new IllegalArgumentException("result.getErrorCode() == null");
}
// Parse the data element
Element element = result.getDataElement();
return createMessage(element);
}
/**
* Creates the message containing the details of the error.
*
* @param element
* the {@link Element} containing the details of the error, can be
* null.
*
* @return
* the message or null if element == null
* or empty.
*/
static String createMessage(Element element) {
// Parse the data element
if (element == null) {
return null;
}
StringBuffer detail = new StringBuffer(250);
// Handle all missing parameters
ElementList missingParamElements = new ElementList(element, "missing-param");
for (Element e : missingParamElements) {
String paramName = e.getAttribute("param");
String elementName = e.getAttribute("element");
if (TextUtils.isEmpty(elementName) && !TextUtils.isEmpty(paramName)) {
detail.append("No value given for required parameter \"" + paramName + "\". ");
} else if (!TextUtils.isEmpty(elementName) && !TextUtils.isEmpty(paramName)) {
detail.append("No value given for required attribute \"" +
paramName + "\" in the element \"" + elementName + "\". ");
}
}
// Handle all invalid parameter values
ElementList invalidValueElements = new ElementList(element, "invalid-value-for-type");
for (Element e : invalidValueElements) {
String paramName = e.getAttribute("param");
String invalidValue = e.getAttribute("value");
String typeName = e.getAttribute("type");
String elementName = e.getAttribute("element");
if (!TextUtils.isEmpty(elementName) && !TextUtils.isEmpty(paramName)) {
detail.append("The value ");
if (!TextUtils.isEmpty(invalidValue)) {
detail.append("\"" + invalidValue + "\" ");
}
detail.append("for the attribute \"" + paramName + "\" in the element \""
+ elementName + "\" is considered invalid for the type \""
+ typeName + "\". ");
} else if (!TextUtils.isEmpty(paramName)) {
detail.append("The value ");
if (!TextUtils.isEmpty(invalidValue)) {
detail.append("\"" + invalidValue + "\" ");
}
detail.append("for the parameter \"" + paramName
+ "\" is considered invalid for the type \"" + typeName + "\". ");
}
}
// Handle all param-combo values
ElementList paramComboElements = new ElementList(element, "param-combo");
for (Element e : paramComboElements) {
// There should be a 'type' attribute
String typeName = e.getAttribute("type");
if (TextUtils.isEmpty(typeName)) {
// TODO: Log?
continue;
}
// There should be at least 2 'param' elements
ElementList paramList = new ElementList(e, "param");
if (paramList.size() < 2) {
// TODO: Log?
continue;
}
// Create detail message
detail.append("Violated param-combo constraint of type \"");
detail.append(typeName);
detail.append("\" on parameters ");
int paramCount = paramList.size();
for (int j = 0; j < paramCount; j++) {
Element e2 = (Element) paramList.get(j);
String paramName = e2.getAttribute("name");
if (TextUtils.isEmpty(paramName)) {
// TODO: Log?
continue;
}
detail.append("\"");
detail.append(paramName);
detail.append("\"");
if (j == (paramCount - 1)) {
detail.append(". ");
} else if (j == (paramCount - 2)) {
detail.append(" and ");
} else {
detail.append(", ");
}
}
}
// Remove the last space from the string, if there is any
if (detail.length() > 0) {
detail.deleteCharAt(detail.length() - 1);
return detail.toString();
} else {
return null;
}
}
}