/// <summary>
/// Detects the payload kinds supported by this format for the specified message payload.
/// </summary>
/// <param name="requestMessage">The request message with the payload stream.</param>
/// <param name="detectionInfo">Additional information available for the payload kind detection.</param>
/// <returns>The set of <see cref="ODataPayloadKind"/>s that are supported with the specified payload.</returns>
internal override IEnumerable <ODataPayloadKind> DetectPayloadKind(
IODataRequestMessage requestMessage,
ODataPayloadKindDetectionInfo detectionInfo)
{
ExceptionUtils.CheckArgumentNotNull(requestMessage, "requestMessage");
ExceptionUtils.CheckArgumentNotNull(detectionInfo, "detectionInfo");
return(DetectPayloadKindImplementation(detectionInfo.ContentType));
}
/// <summary>
/// Asynchronously detects the payload kinds supported by this format for the specified message payload.
/// </summary>
/// <param name="requestMessage">The request message with the payload stream.</param>
/// <param name="detectionInfo">Additional information available for the payload kind detection.</param>
/// <returns>A task that when completed returns the set of <see cref="ODataPayloadKind"/>s
/// that are supported with the specified payload.</returns>
internal override Task <IEnumerable <ODataPayloadKind> > DetectPayloadKindAsync(
IODataRequestMessageAsync requestMessage,
ODataPayloadKindDetectionInfo detectionInfo)
{
ExceptionUtils.CheckArgumentNotNull(requestMessage, "requestMessage");
ExceptionUtils.CheckArgumentNotNull(detectionInfo, "detectionInfo");
return(TaskUtils.GetTaskForSynchronousOperation(() => DetectPayloadKindImplementation(detectionInfo.ContentType)));
}
/// <summary>
/// Detects the payload kinds supported by this format for the specified message payload.
/// </summary>
/// <param name="requestMessage">The request message with the payload stream.</param>
/// <param name="detectionInfo">Additional information available for the payload kind detection.</param>
/// <returns>The set of <see cref="ODataPayloadKind"/>s that are supported with the specified payload.</returns>
internal override IEnumerable <ODataPayloadKind> DetectPayloadKind(
IODataRequestMessage requestMessage,
ODataPayloadKindDetectionInfo detectionInfo)
{
ExceptionUtils.CheckArgumentNotNull(requestMessage, "requestMessage");
ExceptionUtils.CheckArgumentNotNull(detectionInfo, "detectionInfo");
// Metadata is not supported in requests!
return(Enumerable.Empty <ODataPayloadKind>());
}
/// <summary>
/// Asynchronously detects the payload kinds supported by this format for the specified message payload.
/// </summary>
/// <param name="requestMessage">The request message with the payload stream.</param>
/// <param name="detectionInfo">Additional information available for the payload kind detection.</param>
/// <returns>A task that when completed returns the set of <see cref="ODataPayloadKind"/>s
/// that are supported with the specified payload.</returns>
internal override Task <IEnumerable <ODataPayloadKind> > DetectPayloadKindAsync(
IODataRequestMessageAsync requestMessage,
ODataPayloadKindDetectionInfo detectionInfo)
{
ExceptionUtils.CheckArgumentNotNull(requestMessage, "requestMessage");
ExceptionUtils.CheckArgumentNotNull(detectionInfo, "detectionInfo");
// Metadata is not supported in requests!
return(TaskUtils.GetCompletedTask(Enumerable.Empty <ODataPayloadKind>()));
}
/// <summary>
/// Detects the payload kinds supported by this format for the specified message payload.
/// </summary>
/// <param name="responseMessage">The response message with the payload stream.</param>
/// <param name="detectionInfo">Additional information available for the payload kind detection.</param>
/// <returns>The set of <see cref="ODataPayloadKind"/>s that are supported with the specified payload.</returns>
internal override IEnumerable <ODataPayloadKind> DetectPayloadKind(
IODataResponseMessage responseMessage,
ODataPayloadKindDetectionInfo detectionInfo)
{
ExceptionUtils.CheckArgumentNotNull(responseMessage, "responseMessage");
ExceptionUtils.CheckArgumentNotNull(detectionInfo, "detectionInfo");
Stream messageStream = ((ODataMessage)responseMessage).GetStream();
return(DetectPayloadKindImplementation(messageStream, detectionInfo));
}
/// <summary>
/// Asynchronously detects the payload kinds supported by this format for the specified message payload.
/// </summary>
/// <param name="responseMessage">The response message with the payload stream.</param>
/// <param name="detectionInfo">Additional information available for the payload kind detection.</param>
/// <returns>A task that when completed returns the set of <see cref="ODataPayloadKind"/>s
/// that are supported with the specified payload.</returns>
internal override Task <IEnumerable <ODataPayloadKind> > DetectPayloadKindAsync(
IODataResponseMessageAsync responseMessage,
ODataPayloadKindDetectionInfo detectionInfo)
{
ExceptionUtils.CheckArgumentNotNull(responseMessage, "responseMessage");
ExceptionUtils.CheckArgumentNotNull(detectionInfo, "detectionInfo");
// NOTE: After getting the message stream we already (asynchronously) buffered the whole stream in memory (in the AsyncBufferedStream).
// Until we get Task-based async stream APIs and retire the AsyncBufferedStream, we call the synchronous method on the buffered stream.
return(((ODataMessage)responseMessage).GetStreamAsync()
.FollowOnSuccessWith(streamTask => DetectPayloadKindImplementation(streamTask.Result, detectionInfo)));
}
/// <summary>
/// Detects the payload kind(s) from the message stream.
/// </summary>
/// <param name="messageStream">The message stream to read from for payload kind detection.</param>
/// <param name="detectionInfo">Additional information available for the payload kind detection.</param>
/// <returns>An enumerable of zero or one payload kinds depending on whether the metadata payload kind was detected or not.</returns>
private static IEnumerable<ODataPayloadKind> DetectPayloadKindImplementation(Stream messageStream, ODataPayloadKindDetectionInfo detectionInfo)
{
try
{
using (XmlReader reader = ODataAtomReaderUtils.CreateXmlReader(messageStream, detectionInfo.GetEncoding(), detectionInfo.MessageReaderSettings))
{
if (reader.TryReadToNextElement()
&& string.CompareOrdinal(EdmConstants.EdmxName, reader.LocalName) == 0
&& reader.NamespaceURI == EdmConstants.EdmxOasisNamespace)
{
return new ODataPayloadKind[] { ODataPayloadKind.MetadataDocument };
}
}
}
catch (XmlException)
{
// If we are not able to read the payload as XML it is not a metadata document.
// Return no detected payload kind below.
}
return Enumerable.Empty<ODataPayloadKind>();
}
/// <summary> /// Asynchronously detects the payload kinds supported by this format for the specified message payload. /// </summary> /// <param name="requestMessage">The request message with the payload stream.</param> /// <param name="detectionInfo">Additional information available for the payload kind detection.</param> /// <returns>A task that when completed returns the set of <see cref="ODataPayloadKind"/>s /// that are supported with the specified payload.</returns> internal abstract Task <IEnumerable <ODataPayloadKind> > DetectPayloadKindAsync(IODataRequestMessageAsync requestMessage, ODataPayloadKindDetectionInfo detectionInfo);
/// <summary> /// Detects the payload kinds supported by this format for the specified message payload. /// </summary> /// <param name="requestMessage">The request message with the payload stream.</param> /// <param name="detectionInfo">Additional information available for the payload kind detection.</param> /// <returns>The set of <see cref="ODataPayloadKind"/>s that are supported with the specified payload.</returns> internal abstract IEnumerable <ODataPayloadKind> DetectPayloadKind(IODataRequestMessage requestMessage, ODataPayloadKindDetectionInfo detectionInfo);
/// <summary>
/// Detects the payload kind(s) from the message stream.
/// </summary>
/// <param name="messageStream">The message stream to read from for payload kind detection.</param>
/// <param name="detectionInfo">Additional information available for the payload kind detection.</param>
/// <returns>An enumerable of zero or one payload kinds depending on whether the metadata payload kind was detected or not.</returns>
private static IEnumerable <ODataPayloadKind> DetectPayloadKindImplementation(Stream messageStream, ODataPayloadKindDetectionInfo detectionInfo)
{
try
{
using (XmlReader reader = ODataAtomReaderUtils.CreateXmlReader(messageStream, detectionInfo.GetEncoding(), detectionInfo.MessageReaderSettings))
{
if (reader.TryReadToNextElement() &&
string.CompareOrdinal(EdmConstants.EdmxName, reader.LocalName) == 0 &&
reader.NamespaceURI == EdmConstants.EdmxOasisNamespace)
{
return(new ODataPayloadKind[] { ODataPayloadKind.MetadataDocument });
}
}
}
catch (XmlException)
{
// If we are not able to read the payload as XML it is not a metadata document.
// Return no detected payload kind below.
}
return(Enumerable.Empty <ODataPayloadKind>());
}