/// <summary>
/// Checks whether the specified property has already been found before.
/// </summary>
/// <param name="propertiesFoundBitField">
/// The bit field which stores which properties of an error or inner error were found so far.
/// </param>
/// <param name="propertyFoundBitMask">The bit mask for the property to check.</param>
/// <returns>true if the property has not been read before; otherwise false.</returns>
internal static bool ErrorPropertyNotFound(
ref ODataJsonLightReaderUtils.ErrorPropertyBitMask propertiesFoundBitField,
ODataJsonLightReaderUtils.ErrorPropertyBitMask propertyFoundBitMask)
{
Debug.Assert(((int)propertyFoundBitMask & (((int)propertyFoundBitMask) - 1)) == 0, "propertyFoundBitMask is not a power of 2.");
if ((propertiesFoundBitField & propertyFoundBitMask) == propertyFoundBitMask)
{
return(false);
}
propertiesFoundBitField |= propertyFoundBitMask;
return(true);
}
/// <summary>
/// Try to read an inner error property value.
/// </summary>
/// <param name="innerError">An <see cref="ODataInnerError"/> instance that was read from the reader or null if none could be read.</param>
/// <param name="recursionDepth">The number of times this method has been called recursively.</param>
/// <returns>true if an <see cref="ODataInnerError"/> instance that was read; otherwise false.</returns>
private bool TryReadInnerErrorPropertyValue(out ODataInnerError innerError, int recursionDepth)
{
Debug.Assert(this.currentBufferedNode.NodeType == JsonNodeType.Property, "this.currentBufferedNode.NodeType == JsonNodeType.Property");
Debug.Assert(this.parsingInStreamError, "this.parsingInStreamError");
this.AssertBuffering();
ValidationUtils.IncreaseAndValidateRecursionDepth(ref recursionDepth, this.maxInnerErrorDepth);
// move the reader onto the property value
this.ReadInternal();
// we expect a start-object node here
if (this.currentBufferedNode.NodeType != JsonNodeType.StartObject)
{
innerError = null;
return(false);
}
// read the start-object node
this.ReadInternal();
innerError = new ODataInnerError();
// we expect one of the supported properties for the value (or end-object)
ODataJsonLightReaderUtils.ErrorPropertyBitMask propertiesFoundBitmask = ODataJsonLightReaderUtils.ErrorPropertyBitMask.None;
while (this.currentBufferedNode.NodeType == JsonNodeType.Property)
{
// NOTE the Json reader already ensures that the value of a property node is a string
string propertyName = (string)this.currentBufferedNode.Value;
switch (propertyName)
{
case JsonConstants.ODataErrorInnerErrorMessageName:
if (!ODataJsonLightReaderUtils.ErrorPropertyNotFound(ref propertiesFoundBitmask, ODataJsonLightReaderUtils.ErrorPropertyBitMask.MessageValue))
{
return(false);
}
string message;
if (this.TryReadErrorStringPropertyValue(out message))
{
innerError.Message = message;
}
else
{
return(false);
}
break;
case JsonConstants.ODataErrorInnerErrorTypeNameName:
if (!ODataJsonLightReaderUtils.ErrorPropertyNotFound(ref propertiesFoundBitmask, ODataJsonLightReaderUtils.ErrorPropertyBitMask.TypeName))
{
return(false);
}
string typeName;
if (this.TryReadErrorStringPropertyValue(out typeName))
{
innerError.TypeName = typeName;
}
else
{
return(false);
}
break;
case JsonConstants.ODataErrorInnerErrorStackTraceName:
if (!ODataJsonLightReaderUtils.ErrorPropertyNotFound(ref propertiesFoundBitmask, ODataJsonLightReaderUtils.ErrorPropertyBitMask.StackTrace))
{
return(false);
}
string stackTrace;
if (this.TryReadErrorStringPropertyValue(out stackTrace))
{
innerError.StackTrace = stackTrace;
}
else
{
return(false);
}
break;
case JsonConstants.ODataErrorInnerErrorInnerErrorName:
if (!ODataJsonLightReaderUtils.ErrorPropertyNotFound(ref propertiesFoundBitmask, ODataJsonLightReaderUtils.ErrorPropertyBitMask.InnerError))
{
return(false);
}
ODataInnerError nestedInnerError;
if (this.TryReadInnerErrorPropertyValue(out nestedInnerError, recursionDepth))
{
innerError.InnerError = nestedInnerError;
}
else
{
return(false);
}
break;
default:
// if we find a non-supported property in an inner error, we skip it
this.SkipValueInternal();
break;
}
this.ReadInternal();
}
Debug.Assert(this.currentBufferedNode.NodeType == JsonNodeType.EndObject, "this.currentBufferedNode.NodeType == JsonNodeType.EndObject");
return(true);
}
/// <summary>
/// Try to read an error structure from the stream. Return null if no error structure can be read.
/// </summary>
/// <param name="error">An <see cref="ODataError"/> instance that was read from the reader or null if none could be read.</param>
/// <returns>true if an <see cref="ODataError"/> instance that was read; otherwise false.</returns>
private bool TryReadInStreamErrorPropertyValue(out ODataError error)
{
Debug.Assert(this.parsingInStreamError, "this.parsingInStreamError");
this.AssertBuffering();
error = null;
// we expect a start-object node here
if (this.currentBufferedNode.NodeType != JsonNodeType.StartObject)
{
return(false);
}
// read the start-object node
this.ReadInternal();
error = new ODataError();
// we expect one of the supported properties for the value (or end-object)
ODataJsonLightReaderUtils.ErrorPropertyBitMask propertiesFoundBitmask = ODataJsonLightReaderUtils.ErrorPropertyBitMask.None;
while (this.currentBufferedNode.NodeType == JsonNodeType.Property)
{
// NOTE the Json reader already ensures that the value of a property node is a string
string propertyName = (string)this.currentBufferedNode.Value;
switch (propertyName)
{
case JsonConstants.ODataErrorCodeName:
if (!ODataJsonLightReaderUtils.ErrorPropertyNotFound(ref propertiesFoundBitmask, ODataJsonLightReaderUtils.ErrorPropertyBitMask.Code))
{
return(false);
}
string errorCode;
if (this.TryReadErrorStringPropertyValue(out errorCode))
{
error.ErrorCode = errorCode;
}
else
{
return(false);
}
break;
case JsonConstants.ODataErrorMessageName:
if (!ODataJsonLightReaderUtils.ErrorPropertyNotFound(ref propertiesFoundBitmask, ODataJsonLightReaderUtils.ErrorPropertyBitMask.Message))
{
return(false);
}
string errorMessage;
if (this.TryReadErrorStringPropertyValue(out errorMessage))
{
error.Message = errorMessage;
}
else
{
return(false);
}
break;
case JsonConstants.ODataErrorTargetName:
if (!ODataJsonLightReaderUtils.ErrorPropertyNotFound(
ref propertiesFoundBitmask,
ODataJsonLightReaderUtils.ErrorPropertyBitMask.Target))
{
return(false);
}
string errorTarget;
if (this.TryReadErrorStringPropertyValue(out errorTarget))
{
error.Target = errorTarget;
}
else
{
return(false);
}
break;
case JsonConstants.ODataErrorDetailsName:
if (!ODataJsonLightReaderUtils.ErrorPropertyNotFound(
ref propertiesFoundBitmask,
ODataJsonLightReaderUtils.ErrorPropertyBitMask.Details))
{
return(false);
}
ICollection <ODataErrorDetail> details;
if (!this.TryReadErrorDetailsPropertyValue(out details))
{
return(false);
}
error.Details = details;
break;
case JsonConstants.ODataErrorInnerErrorName:
if (!ODataJsonLightReaderUtils.ErrorPropertyNotFound(ref propertiesFoundBitmask, ODataJsonLightReaderUtils.ErrorPropertyBitMask.InnerError))
{
return(false);
}
ODataInnerError innerError;
if (!this.TryReadInnerErrorPropertyValue(out innerError, 0 /*recursionDepth */))
{
return(false);
}
error.InnerError = innerError;
break;
default:
// if we find a non-supported property we don't treat this as an error
return(false);
}
this.ReadInternal();
}
// read the end object
Debug.Assert(this.currentBufferedNode.NodeType == JsonNodeType.EndObject, "this.currentBufferedNode.NodeType == JsonNodeType.EndObject");
this.ReadInternal();
// if we don't find any properties it is not a valid error object
return(propertiesFoundBitmask != ODataJsonLightReaderUtils.ErrorPropertyBitMask.None);
}
