/// <summary>
/// Reads an inner error payload.
/// </summary>
/// <param name="recursionDepth">The number of times this method has been called recursively.</param>
/// <returns>An <see cref="ODataInnerError"/> representing the read inner error.</returns>
/// <remarks>
/// Pre-Condition: any - will throw if not StartObject
/// Post-Condition: JsonNodeType.Property - The next property in the error value
/// JsonNodeType.EndObject - The end of the error value
/// </remarks>
private ODataInnerError ReadInnerError(int recursionDepth)
{
Debug.Assert(this.JsonReader.DisableInStreamErrorDetection, "JsonReader.DisableInStreamErrorDetection");
this.JsonReader.AssertNotBuffering();
ValidationUtils.IncreaseAndValidateRecursionDepth(ref recursionDepth, this.MessageReaderSettings.MessageQuotas.MaxNestingDepth);
this.JsonReader.ReadStartObject();
ODataInnerError innerError = new ODataInnerError();
ODataVerboseJsonReaderUtils.ErrorPropertyBitMask propertiesFoundBitField = ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.None;
while (this.JsonReader.NodeType == JsonNodeType.Property)
{
string propertyName = this.JsonReader.ReadPropertyName();
switch (propertyName)
{
case JsonConstants.ODataErrorInnerErrorMessageName:
ODataVerboseJsonReaderUtils.VerifyErrorPropertyNotFound(
ref propertiesFoundBitField,
ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.MessageValue,
JsonConstants.ODataErrorInnerErrorMessageName);
innerError.Message = this.JsonReader.ReadStringValue(JsonConstants.ODataErrorInnerErrorMessageName);
break;
case JsonConstants.ODataErrorInnerErrorTypeNameName:
ODataVerboseJsonReaderUtils.VerifyErrorPropertyNotFound(
ref propertiesFoundBitField,
ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.TypeName,
JsonConstants.ODataErrorInnerErrorTypeNameName);
innerError.TypeName = this.JsonReader.ReadStringValue(JsonConstants.ODataErrorInnerErrorTypeNameName);
break;
case JsonConstants.ODataErrorInnerErrorStackTraceName:
ODataVerboseJsonReaderUtils.VerifyErrorPropertyNotFound(
ref propertiesFoundBitField,
ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.StackTrace,
JsonConstants.ODataErrorInnerErrorStackTraceName);
innerError.StackTrace = this.JsonReader.ReadStringValue(JsonConstants.ODataErrorInnerErrorStackTraceName);
break;
case JsonConstants.ODataErrorInnerErrorInnerErrorName:
ODataVerboseJsonReaderUtils.VerifyErrorPropertyNotFound(
ref propertiesFoundBitField,
ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.InnerError,
JsonConstants.ODataErrorInnerErrorInnerErrorName);
innerError.InnerError = this.ReadInnerError(recursionDepth);
break;
default:
// skip any unsupported properties in the inner error
this.JsonReader.SkipValue();
break;
}
}
this.JsonReader.ReadEndObject();
this.JsonReader.AssertNotBuffering();
return(innerError);
}
/// <summary>
/// Read a top-level error.
/// </summary>
/// <returns>An <see cref="ODataError"/> representing the read error.</returns>
internal ODataError ReadTopLevelError()
{
DebugUtils.CheckNoExternalCallers();
Debug.Assert(this.JsonReader.NodeType == JsonNodeType.None, "Pre-Condition: expected JsonNodeType.None, the reader must not have been used yet.");
Debug.Assert(!this.JsonReader.DisableInStreamErrorDetection, "!JsonReader.DisableInStreamErrorDetection");
this.JsonReader.AssertNotBuffering();
// prevent the buffering JSON reader from detecting in-stream errors - we read the error ourselves
// to throw proper exceptions
this.JsonReader.DisableInStreamErrorDetection = true;
ODataError error = new ODataError();
try
{
// Read the start of the payload (no "d" wrapper for top-level errors)
this.ReadPayloadStart(/*isReadingNestedPayload*/ false, /*expectResponseWrapper*/ false);
// Read the start of the error object
this.JsonReader.ReadStartObject();
ODataVerboseJsonReaderUtils.ErrorPropertyBitMask propertiesFoundBitField = ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.None;
while (this.JsonReader.NodeType == JsonNodeType.Property)
{
string propertyName = this.JsonReader.ReadPropertyName();
if (string.CompareOrdinal(JsonConstants.ODataErrorName, propertyName) != 0)
{
// we only allow a single 'error' property for a top-level error object
throw new ODataException(Strings.ODataJsonErrorDeserializer_TopLevelErrorWithInvalidProperty(propertyName));
}
ODataVerboseJsonReaderUtils.VerifyErrorPropertyNotFound(ref propertiesFoundBitField, ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.Error, JsonConstants.ODataErrorName);
this.JsonReader.ReadStartObject();
while (this.JsonReader.NodeType == JsonNodeType.Property)
{
propertyName = this.JsonReader.ReadPropertyName();
switch (propertyName)
{
case JsonConstants.ODataErrorCodeName:
ODataVerboseJsonReaderUtils.VerifyErrorPropertyNotFound(ref propertiesFoundBitField, ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.Code, JsonConstants.ODataErrorCodeName);
error.ErrorCode = this.JsonReader.ReadStringValue(JsonConstants.ODataErrorCodeName);
break;
case JsonConstants.ODataErrorMessageName:
ODataVerboseJsonReaderUtils.VerifyErrorPropertyNotFound(ref propertiesFoundBitField, ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.Message, JsonConstants.ODataErrorMessageName);
this.JsonReader.ReadStartObject();
while (this.JsonReader.NodeType == JsonNodeType.Property)
{
propertyName = this.JsonReader.ReadPropertyName();
switch (propertyName)
{
case JsonConstants.ODataErrorMessageLanguageName:
ODataVerboseJsonReaderUtils.VerifyErrorPropertyNotFound(ref propertiesFoundBitField, ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.MessageLanguage, JsonConstants.ODataErrorMessageLanguageName);
error.MessageLanguage = this.JsonReader.ReadStringValue(JsonConstants.ODataErrorMessageLanguageName);
break;
case JsonConstants.ODataErrorMessageValueName:
ODataVerboseJsonReaderUtils.VerifyErrorPropertyNotFound(ref propertiesFoundBitField, ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.MessageValue, JsonConstants.ODataErrorMessageValueName);
error.Message = this.JsonReader.ReadStringValue(JsonConstants.ODataErrorMessageValueName);
break;
default:
// we only allow a 'lang' and 'value' properties in the value of the 'message' property
throw new ODataException(Strings.ODataJsonErrorDeserializer_TopLevelErrorMessageValueWithInvalidProperty(propertyName));
}
}
this.JsonReader.ReadEndObject();
break;
case JsonConstants.ODataErrorInnerErrorName:
ODataVerboseJsonReaderUtils.VerifyErrorPropertyNotFound(ref propertiesFoundBitField, ODataVerboseJsonReaderUtils.ErrorPropertyBitMask.InnerError, JsonConstants.ODataErrorInnerErrorName);
error.InnerError = this.ReadInnerError(0 /* recursionDepth */);
break;
default:
// we only allow a 'code', 'message' and 'innererror' properties in the value of the 'error' property
throw new ODataException(Strings.ODataVerboseJsonErrorDeserializer_TopLevelErrorValueWithInvalidProperty(propertyName));
}
}
this.JsonReader.ReadEndObject();
}
// Read the end of the error object
this.JsonReader.ReadEndObject();
// Read the end of the response (no "d" wrapper for top-level errors)
this.ReadPayloadEnd(/*isReadingNestedPayload*/ false, /*expectResponseWrapper*/ false);
}
finally
{
this.JsonReader.DisableInStreamErrorDetection = false;
}
Debug.Assert(this.JsonReader.NodeType == JsonNodeType.EndOfInput, "Post-Condition: JsonNodeType.EndOfInput");
this.JsonReader.AssertNotBuffering();
return(error);
}