blob: 62673ef64b04cd3f4bc240d80bd35f3b8b36f1df (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
//-----------------------------------------------------------------------
// <copyright file="IMessage.cs" company="Outercurve Foundation">
// Copyright (c) Outercurve Foundation. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace DotNetOpenAuth.Messaging {
using System;
using System.Collections.Generic;
using System.Diagnostics.Contracts;
using System.Text;
/// <summary>
/// The interface that classes must implement to be serialized/deserialized
/// as protocol or extension messages.
/// </summary>
[ContractClass(typeof(IMessageContract))]
public interface IMessage {
/// <summary>
/// Gets the version of the protocol or extension this message is prepared to implement.
/// </summary>
/// <remarks>
/// Implementations of this interface should ensure that this property never returns null.
/// </remarks>
Version Version { get; }
/// <summary>
/// Gets the extra, non-standard Protocol parameters included in the message.
/// </summary>
/// <remarks>
/// Implementations of this interface should ensure that this property never returns null.
/// </remarks>
IDictionary<string, string> ExtraData { get; }
/// <summary>
/// Checks the message state for conformity to the protocol specification
/// and throws an exception if the message is invalid.
/// </summary>
/// <remarks>
/// <para>Some messages have required fields, or combinations of fields that must relate to each other
/// in specialized ways. After deserializing a message, this method checks the state of the
/// message to see if it conforms to the protocol.</para>
/// <para>Note that this property should <i>not</i> check signatures or perform any state checks
/// outside this scope of this particular message.</para>
/// </remarks>
/// <exception cref="ProtocolException">Thrown if the message is invalid.</exception>
void EnsureValidMessage();
}
/// <summary>
/// Code contract for the <see cref="IMessage"/> interface.
/// </summary>
[ContractClassFor(typeof(IMessage))]
internal abstract class IMessageContract : IMessage {
/// <summary>
/// Prevents a default instance of the <see cref="IMessageContract"/> class from being created.
/// </summary>
private IMessageContract() {
}
/// <summary>
/// Gets the version of the protocol or extension this message is prepared to implement.
/// </summary>
Version IMessage.Version {
get {
Contract.Ensures(Contract.Result<Version>() != null);
return default(Version); // dummy return
}
}
/// <summary>
/// Gets the extra, non-standard Protocol parameters included in the message.
/// </summary>
/// <value></value>
/// <remarks>
/// Implementations of this interface should ensure that this property never returns null.
/// </remarks>
IDictionary<string, string> IMessage.ExtraData {
get {
Contract.Ensures(Contract.Result<IDictionary<string, string>>() != null);
return default(IDictionary<string, string>);
}
}
/// <summary>
/// Checks the message state for conformity to the protocol specification
/// and throws an exception if the message is invalid.
/// </summary>
/// <remarks>
/// <para>Some messages have required fields, or combinations of fields that must relate to each other
/// in specialized ways. After deserializing a message, this method checks the state of the
/// message to see if it conforms to the protocol.</para>
/// <para>Note that this property should <i>not</i> check signatures or perform any state checks
/// outside this scope of this particular message.</para>
/// </remarks>
/// <exception cref="ProtocolException">Thrown if the message is invalid.</exception>
void IMessage.EnsureValidMessage() {
}
}
}
|
