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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
//-----------------------------------------------------------------------
// <copyright file="MessageBase.cs" company="Outercurve Foundation">
// Copyright (c) Outercurve Foundation. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace DotNetOpenAuth.OAuth2.Messages {
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.Contracts;
using DotNetOpenAuth.Messaging;
/// <summary>
/// A common message base class for OAuth messages.
/// </summary>
[Serializable]
public class MessageBase : IDirectedProtocolMessage, IDirectResponseProtocolMessage {
/// <summary>
/// A dictionary to contain extra message data.
/// </summary>
private Dictionary<string, string> extraData = new Dictionary<string, string>();
/// <summary>
/// The originating request.
/// </summary>
private IDirectedProtocolMessage originatingRequest;
/// <summary>
/// The backing field for the <see cref="IMessage.Version"/> property.
/// </summary>
private Version version;
/// <summary>
/// A value indicating whether this message is a direct or indirect message.
/// </summary>
private MessageTransport messageTransport;
/// <summary>
/// Initializes a new instance of the <see cref="MessageBase"/> class
/// that is used for direct response messages.
/// </summary>
/// <param name="version">The version.</param>
protected MessageBase(Version version) {
Requires.NotNull(version, "version");
this.messageTransport = MessageTransport.Direct;
this.version = version;
this.HttpMethods = HttpDeliveryMethods.GetRequest;
}
/// <summary>
/// Initializes a new instance of the <see cref="MessageBase"/> class.
/// </summary>
/// <param name="request">The originating request.</param>
/// <param name="recipient">The recipient of the directed message. Null if not applicable.</param>
protected MessageBase(IDirectedProtocolMessage request, Uri recipient = null) {
Requires.NotNull(request, "request");
this.originatingRequest = request;
this.messageTransport = request.Transport;
this.version = request.Version;
this.Recipient = recipient;
this.HttpMethods = HttpDeliveryMethods.GetRequest;
}
/// <summary>
/// Initializes a new instance of the <see cref="MessageBase"/> class
/// that is used for directed messages.
/// </summary>
/// <param name="version">The version.</param>
/// <param name="messageTransport">The message transport.</param>
/// <param name="recipient">The recipient.</param>
protected MessageBase(Version version, MessageTransport messageTransport, Uri recipient) {
Requires.NotNull(version, "version");
Requires.NotNull(recipient, "recipient");
this.version = version;
this.messageTransport = messageTransport;
this.Recipient = recipient;
this.HttpMethods = HttpDeliveryMethods.GetRequest | HttpDeliveryMethods.PostRequest;
}
#region IMessage Properties
/// <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 IMessage.Version {
get { return this.Version; }
}
/// <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>
public IDictionary<string, string> ExtraData {
get { return this.extraData; }
}
#endregion
#region IProtocolMessage Members
/// <summary>
/// Gets the level of protection this message requires.
/// </summary>
/// <value><see cref="MessageProtections.None"/></value>
MessageProtections IProtocolMessage.RequiredProtection {
get { return RequiredProtection; }
}
/// <summary>
/// Gets a value indicating whether this is a direct or indirect message.
/// </summary>
/// <value></value>
MessageTransport IProtocolMessage.Transport {
get { return this.Transport; }
}
#endregion
#region IDirectedProtocolMessage Members
/// <summary>
/// Gets the preferred method of transport for the message.
/// </summary>
/// <remarks>
/// For indirect messages this will likely be GET+POST, which both can be simulated in the user agent:
/// the GET with a simple 301 Redirect, and the POST with an HTML form in the response with javascript
/// to automate submission.
/// </remarks>
HttpDeliveryMethods IDirectedProtocolMessage.HttpMethods {
get { return this.HttpMethods; }
}
/// <summary>
/// Gets the URL of the intended receiver of this message.
/// </summary>
Uri IDirectedProtocolMessage.Recipient {
get { return this.Recipient; }
}
#endregion
#region IDirectResponseProtocolMessage Members
/// <summary>
/// Gets the originating request message that caused this response to be formed.
/// </summary>
IDirectedProtocolMessage IDirectResponseProtocolMessage.OriginatingRequest {
get { return this.OriginatingRequest; }
}
#endregion
/// <summary>
/// Gets the level of protection this message requires.
/// </summary>
protected static MessageProtections RequiredProtection {
get { return MessageProtections.None; }
}
/// <summary>
/// Gets a value indicating whether this is a direct or indirect message.
/// </summary>
protected MessageTransport Transport {
get { return this.messageTransport; }
}
/// <summary>
/// Gets the version of the protocol or extension this message is prepared to implement.
/// </summary>
protected Version Version {
get { return this.version; }
}
/// <summary>
/// Gets or sets the preferred method of transport for the message.
/// </summary>
/// <remarks>
/// For indirect messages this will likely be GET+POST, which both can be simulated in the user agent:
/// the GET with a simple 301 Redirect, and the POST with an HTML form in the response with javascript
/// to automate submission.
/// </remarks>
protected HttpDeliveryMethods HttpMethods { get; set; }
/// <summary>
/// Gets the originating request message that caused this response to be formed.
/// </summary>
protected IDirectedProtocolMessage OriginatingRequest {
get { return this.originatingRequest; }
}
/// <summary>
/// Gets the URL of the intended receiver of this message.
/// </summary>
protected Uri Recipient { get; private set; }
#region IMessage Methods
/// <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() {
this.EnsureValidMessage();
}
#endregion
/// <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>
protected virtual void EnsureValidMessage() {
}
}
}
|
