blob: 1047ec54450aa16f5275b1c34f7e54125aee2e89 (
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
//-----------------------------------------------------------------------
// <copyright file="IChannelBindingElement.cs" company="Outercurve Foundation">
// Copyright (c) Outercurve Foundation. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace DotNetOpenAuth.Messaging {
using System;
using System.Diagnostics.Contracts;
/// <summary>
/// An interface that must be implemented by message transforms/validators in order
/// to be included in the channel stack.
/// </summary>
[ContractClass(typeof(IChannelBindingElementContract))]
public interface IChannelBindingElement {
/// <summary>
/// Gets or sets the channel that this binding element belongs to.
/// </summary>
/// <remarks>
/// This property is set by the channel when it is first constructed.
/// </remarks>
Channel Channel { get; set; }
/// <summary>
/// Gets the protection commonly offered (if any) by this binding element.
/// </summary>
/// <remarks>
/// This value is used to assist in sorting binding elements in the channel stack.
/// </remarks>
MessageProtections Protection { get; }
/// <summary>
/// Prepares a message for sending based on the rules of this channel binding element.
/// </summary>
/// <param name="message">The message to prepare for sending.</param>
/// <returns>
/// The protections (if any) that this binding element applied to the message.
/// Null if this binding element did not even apply to this binding element.
/// </returns>
/// <remarks>
/// Implementations that provide message protection must honor the
/// <see cref="MessagePartAttribute.RequiredProtection"/> properties where applicable.
/// </remarks>
MessageProtections? ProcessOutgoingMessage(IProtocolMessage message);
/// <summary>
/// Performs any transformation on an incoming message that may be necessary and/or
/// validates an incoming message based on the rules of this channel binding element.
/// </summary>
/// <param name="message">The incoming message to process.</param>
/// <returns>
/// The protections (if any) that this binding element applied to the message.
/// Null if this binding element did not even apply to this binding element.
/// </returns>
/// <exception cref="ProtocolException">
/// Thrown when the binding element rules indicate that this message is invalid and should
/// NOT be processed.
/// </exception>
/// <remarks>
/// Implementations that provide message protection must honor the
/// <see cref="MessagePartAttribute.RequiredProtection"/> properties where applicable.
/// </remarks>
MessageProtections? ProcessIncomingMessage(IProtocolMessage message);
}
/// <summary>
/// Code Contract for the <see cref="IChannelBindingElement"/> interface.
/// </summary>
[ContractClassFor(typeof(IChannelBindingElement))]
internal abstract class IChannelBindingElementContract : IChannelBindingElement {
/// <summary>
/// Prevents a default instance of the <see cref="IChannelBindingElementContract"/> class from being created.
/// </summary>
private IChannelBindingElementContract() {
}
#region IChannelBindingElement Members
/// <summary>
/// Gets or sets the channel that this binding element belongs to.
/// </summary>
/// <value></value>
/// <remarks>
/// This property is set by the channel when it is first constructed.
/// </remarks>
Channel IChannelBindingElement.Channel {
get { throw new NotImplementedException(); }
set { throw new NotImplementedException(); }
}
/// <summary>
/// Gets the protection commonly offered (if any) by this binding element.
/// </summary>
/// <value></value>
/// <remarks>
/// This value is used to assist in sorting binding elements in the channel stack.
/// </remarks>
MessageProtections IChannelBindingElement.Protection {
get { throw new NotImplementedException(); }
}
/// <summary>
/// Prepares a message for sending based on the rules of this channel binding element.
/// </summary>
/// <param name="message">The message to prepare for sending.</param>
/// <returns>
/// The protections (if any) that this binding element applied to the message.
/// Null if this binding element did not even apply to this binding element.
/// </returns>
/// <remarks>
/// Implementations that provide message protection must honor the
/// <see cref="MessagePartAttribute.RequiredProtection"/> properties where applicable.
/// </remarks>
MessageProtections? IChannelBindingElement.ProcessOutgoingMessage(IProtocolMessage message) {
Requires.NotNull(message, "message");
Requires.ValidState(((IChannelBindingElement)this).Channel != null);
throw new NotImplementedException();
}
/// <summary>
/// Performs any transformation on an incoming message that may be necessary and/or
/// validates an incoming message based on the rules of this channel binding element.
/// </summary>
/// <param name="message">The incoming message to process.</param>
/// <returns>
/// The protections (if any) that this binding element applied to the message.
/// Null if this binding element did not even apply to this binding element.
/// </returns>
/// <exception cref="ProtocolException">
/// Thrown when the binding element rules indicate that this message is invalid and should
/// NOT be processed.
/// </exception>
/// <remarks>
/// Implementations that provide message protection must honor the
/// <see cref="MessagePartAttribute.RequiredProtection"/> properties where applicable.
/// </remarks>
MessageProtections? IChannelBindingElement.ProcessIncomingMessage(IProtocolMessage message) {
Requires.NotNull(message, "message");
Requires.ValidState(((IChannelBindingElement)this).Channel != null);
throw new NotImplementedException();
}
#endregion
}
}
|
