blob: db5830cdb1ed8eb7f6c3275502830a053b7d0cdc (
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
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
|
//-----------------------------------------------------------------------
// <copyright file="MessageBase.cs" company="Andrew Arnott">
// Copyright (c) Andrew Arnott. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace DotNetOAuth.Messages {
using System;
using System.Collections.Generic;
using DotNetOAuth.ChannelElements;
using DotNetOAuth.Messaging;
using DotNetOAuth.Messaging.Bindings;
/// <summary>
/// A base class for all OAuth messages.
/// </summary>
internal abstract class MessageBase : IDirectedProtocolMessage {
/// <summary>
/// A store for extra name/value data pairs that are attached to this message.
/// </summary>
private Dictionary<string, string> extraData = new Dictionary<string, string>();
/// <summary>
/// Gets a value indicating whether signing this message is required.
/// </summary>
private MessageProtection protectionRequired;
/// <summary>
/// Gets a value indicating whether this is a direct or indirect message.
/// </summary>
private MessageTransport transport;
/// <summary>
/// The URI to the remote endpoint to send this message to.
/// </summary>
private Uri recipient;
/// <summary>
/// Initializes a new instance of the <see cref="MessageBase"/> class.
/// </summary>
/// <param name="protectionRequired">The level of protection the message requires.</param>
/// <param name="transport">A value indicating whether this message requires a direct or indirect transport.</param>
protected MessageBase(MessageProtection protectionRequired, MessageTransport transport) {
this.protectionRequired = protectionRequired;
this.transport = transport;
}
/// <summary>
/// Initializes a new instance of the <see cref="MessageBase"/> class.
/// </summary>
/// <param name="protectionRequired">The level of protection the message requires.</param>
/// <param name="transport">A value indicating whether this message requires a direct or indirect transport.</param>
/// <param name="recipient">The URI that a directed message will be delivered to.</param>
protected MessageBase(MessageProtection protectionRequired, MessageTransport transport, Uri recipient) {
if (recipient == null) {
throw new ArgumentNullException("recipient");
}
this.protectionRequired = protectionRequired;
this.transport = transport;
this.recipient = recipient;
}
#region IProtocolMessage Properties
/// <summary>
/// Gets the version of the protocol this message is prepared to implement.
/// </summary>
Version IProtocolMessage.ProtocolVersion {
get { return new Version(1, 0); }
}
/// <summary>
/// Gets the level of protection this message requires.
/// </summary>
MessageProtection IProtocolMessage.RequiredProtection {
get { return this.protectionRequired; }
}
/// <summary>
/// Gets a value indicating whether this is a direct or indirect message.
/// </summary>
MessageTransport IProtocolMessage.Transport {
get { return this.transport; }
}
/// <summary>
/// Gets the dictionary of additional name/value fields tacked on to this message.
/// </summary>
IDictionary<string, string> IProtocolMessage.ExtraData {
get { return this.extraData; }
}
#endregion
#region IDirectedProtocolMessage Members
/// <summary>
/// Gets the URI to the Service Provider endpoint to send this message to.
/// </summary>
Uri IDirectedProtocolMessage.Recipient {
get { return this.recipient; }
}
#endregion
#region IProtocolMessage Methods
/// <summary>
/// Checks the message state for conformity to the protocol specification
/// and throws an exception if the message is invalid.
/// </summary>
void IProtocolMessage.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>
protected virtual void EnsureValidMessage() { }
}
}
|
