/// <summary>
/// Write an error message.
/// </summary>
/// <param name="writer">The Xml writer to write to.</param>
/// <param name="error">The error instance to write.</param>
/// <param name="includeDebugInformation">A flag indicating whether error details should be written (in debug mode only) or not.</param>
/// <param name="maxInnerErrorDepth">The maximumum number of nested inner errors to allow.</param>
internal static void WriteXmlError(XmlWriter writer, ODataError error, bool includeDebugInformation, int maxInnerErrorDepth)
{
Debug.Assert(writer != null, "writer != null");
Debug.Assert(error != null, "error != null");
string code, message;
ErrorUtils.GetErrorDetails(error, out code, out message);
ODataInnerError innerError = includeDebugInformation ? error.InnerError : null;
WriteXmlError(writer, code, message, innerError, maxInnerErrorDepth);
}
/// <summary>
/// Writes the inner exception information in debug mode.
/// </summary>
/// <param name="writer">The Xml writer to write to.</param>
/// <param name="innerError">The inner error to write.</param>
/// <param name="innerErrorElementName">The local name of the element representing the inner error.</param>
/// <param name="recursionDepth">The number of times this method has been called recursively.</param>
/// <param name="maxInnerErrorDepth">The maximumum number of nested inner errors to allow.</param>
private static void WriteXmlInnerError(XmlWriter writer, ODataInnerError innerError, string innerErrorElementName, int recursionDepth, int maxInnerErrorDepth)
{
Debug.Assert(writer != null, "writer != null");
recursionDepth++;
if (recursionDepth > maxInnerErrorDepth)
{
#if ODATA_CORE
throw new ODataException(Strings.ValidationUtils_RecursionDepthLimitReached(maxInnerErrorDepth));
#else
throw new ODataException(Microsoft.OData.Service.Strings.BadRequest_DeepRecursion(maxInnerErrorDepth));
#endif
}
// <m:innererror> or <m:internalexception>
writer.WriteStartElement(ODataMetadataConstants.ODataMetadataNamespacePrefix, innerErrorElementName, ODataMetadataConstants.ODataMetadataNamespace);
//// NOTE: we add empty elements if no information is provided for the message, error type and stack trace
//// to stay compatible with Astoria.
// <m:message>...</m:message>
string errorMessage = innerError.Message ?? String.Empty;
writer.WriteStartElement(ODataMetadataConstants.ODataInnerErrorMessageElementName, ODataMetadataConstants.ODataMetadataNamespace);
writer.WriteString(errorMessage);
writer.WriteEndElement();
// <m:type>...</m:type>
string errorType = innerError.TypeName ?? string.Empty;
writer.WriteStartElement(ODataMetadataConstants.ODataInnerErrorTypeElementName, ODataMetadataConstants.ODataMetadataNamespace);
writer.WriteString(errorType);
writer.WriteEndElement();
// <m:stacktrace>...</m:stacktrace>
string errorStackTrace = innerError.StackTrace ?? String.Empty;
writer.WriteStartElement(ODataMetadataConstants.ODataInnerErrorStackTraceElementName, ODataMetadataConstants.ODataMetadataNamespace);
writer.WriteString(errorStackTrace);
writer.WriteEndElement();
if (innerError.InnerError != null)
{
WriteXmlInnerError(writer, innerError.InnerError, ODataMetadataConstants.ODataInnerErrorInnerErrorElementName, recursionDepth, maxInnerErrorDepth);
}
// </m:innererror> or </m:internalexception>
writer.WriteEndElement();
}
/// <summary>
/// Write an error message.
/// </summary>
/// <param name="writer">The Xml writer to write to.</param>
/// <param name="code">The code of the error.</param>
/// <param name="message">The message of the error.</param>
/// <param name="innerError">Inner error details that will be included in debug mode (if present).</param>
/// <param name="maxInnerErrorDepth">The maximumum number of nested inner errors to allow.</param>
private static void WriteXmlError(XmlWriter writer, string code, string message, ODataInnerError innerError, int maxInnerErrorDepth)
{
Debug.Assert(writer != null, "writer != null");
Debug.Assert(code != null, "code != null");
Debug.Assert(message != null, "message != null");
// <m:error>
writer.WriteStartElement(ODataMetadataConstants.ODataMetadataNamespacePrefix, ODataMetadataConstants.ODataErrorElementName, ODataMetadataConstants.ODataMetadataNamespace);
// <m:code>code</m:code>
writer.WriteElementString(ODataMetadataConstants.ODataMetadataNamespacePrefix, ODataMetadataConstants.ODataErrorCodeElementName, ODataMetadataConstants.ODataMetadataNamespace, code);
// <m:message>error message</m:message>
writer.WriteElementString(ODataMetadataConstants.ODataMetadataNamespacePrefix, ODataMetadataConstants.ODataErrorMessageElementName, ODataMetadataConstants.ODataMetadataNamespace, message);
if (innerError != null)
{
WriteXmlInnerError(writer, innerError, ODataMetadataConstants.ODataInnerErrorElementName, /* recursionDepth */ 0, maxInnerErrorDepth);
}
// </m:error>
writer.WriteEndElement();
}
