/// <summary>
/// Converts a <see cref="ODataCollectionValue"/> to a string for use in a Url.
/// </summary>
/// <param name="collectionValue">Instance to convert.</param>
/// <param name="model">Model to be used for validation. User model is optional. The EdmLib core model is expected as a minimum.</param>
/// <param name="version">Version to be compliant with. Collection requires >= V3.</param>
/// <returns>A string representation of <paramref name="collectionValue"/> to be added to a Url.</returns>
internal static string ConvertToUriCollectionLiteral(ODataCollectionValue collectionValue, IEdmModel model, ODataVersion version)
{
ExceptionUtils.CheckArgumentNotNull(collectionValue, "collectionValue");
ExceptionUtils.CheckArgumentNotNull(model, "model");
StringBuilder builder = new StringBuilder();
using (TextWriter textWriter = new StringWriter(builder, CultureInfo.InvariantCulture))
{
ODataMessageWriterSettings messageWriterSettings = new ODataMessageWriterSettings()
{
Version = version,
Validations = ~ValidationKinds.ThrowOnUndeclaredPropertyForNonOpenType,
// TBD: Should write instance annotations for the literal???
ShouldIncludeAnnotation = ODataUtils.CreateAnnotationFilter("*")
};
WriteJsonLightLiteral(
model,
messageWriterSettings,
textWriter,
(serializer) => serializer.WriteCollectionValue(
collectionValue,
null /*metadataTypeReference*/,
null /*valueTypeReference*/,
false /*isTopLevelProperty*/,
true /*isInUri*/,
false /*isOpenPropertyType*/));
}
return(builder.ToString());
}
/// <summary>
/// Converts a <see cref="ODataResourceValue"/> to a string.
/// </summary>
/// <param name="resourceValue">Instance to convert.</param>
/// <param name="model">Model to be used for validation. User model is optional. The EdmLib core model is expected as a minimum.</param>
/// <param name="version">Version to be compliant with.</param>
/// <returns>A string representation of <paramref name="resourceValue"/> to be added.</returns>
internal static string ConvertToResourceLiteral(ODataResourceValue resourceValue, IEdmModel model, ODataVersion version)
{
ExceptionUtils.CheckArgumentNotNull(resourceValue, "resourceValue");
ExceptionUtils.CheckArgumentNotNull(model, "model");
StringBuilder builder = new StringBuilder();
using (TextWriter textWriter = new StringWriter(builder, CultureInfo.InvariantCulture))
{
ODataMessageWriterSettings messageWriterSettings = new ODataMessageWriterSettings()
{
Version = version,
Validations = ~ValidationKinds.ThrowOnUndeclaredPropertyForNonOpenType,
// Should write instance annotations for the literal
ShouldIncludeAnnotation = ODataUtils.CreateAnnotationFilter("*")
};
WriteJsonLightLiteral(
model,
messageWriterSettings,
textWriter,
(serializer) => serializer.WriteResourceValue(
resourceValue, /* resourceValue */
null, /* metadataTypeReference */
true, /* isOpenPropertyType */
serializer.CreateDuplicatePropertyNameChecker()));
}
return(builder.ToString());
}
/// <summary>
/// Reads the OData-Version header from the <paramref name="message"/> and parses it.
/// If no OData-Version header is found it sets the default version to be used for reading.
/// </summary>
/// <param name="message">The message to get the OData-Version header from.</param>
/// <param name="defaultVersion">The default version to use if the header was not specified.</param>
/// <returns>
/// The <see cref="ODataVersion"/> retrieved from the OData-Version header of the message.
/// The default version if none is specified in the header.
/// </returns>
internal static ODataVersion GetODataVersion(ODataMessage message, ODataVersion defaultVersion)
{
Debug.Assert(message != null, "message != null");
string headerValue = message.GetHeader(ODataConstants.ODataVersionHeader);
return(string.IsNullOrEmpty(headerValue)
? defaultVersion
: ODataUtils.StringToODataVersion(headerValue));
}
/// <summary>
/// Sets the 'OData-Version' HTTP header on the message based on the protocol version specified in the settings.
/// </summary>
/// <param name="message">The message to set the OData-Version header on.</param>
/// <param name="settings">The <see cref="ODataMessageWriterSettings"/> determining the protocol version to use.</param>
internal static void SetODataVersion(ODataMessage message, ODataMessageWriterSettings settings)
{
Debug.Assert(message != null, "message != null");
Debug.Assert(settings != null, "settings != null");
Debug.Assert(settings.Version.HasValue, "settings.Version.HasValue");
string odataVersionString = ODataUtils.ODataVersionToString(settings.Version.Value);
message.SetHeader(ODataConstants.ODataVersionHeader, odataVersionString);
}
