blob: 0e297922cb802411e01e3ecf54b41e71e3085fea (
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
147
148
149
|
//-----------------------------------------------------------------------
// <copyright file="IRequest.cs" company="Outercurve Foundation">
// Copyright (c) Outercurve Foundation. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace DotNetOpenAuth.OpenId.Provider {
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.Contracts;
using System.Text;
using DotNetOpenAuth.Messaging;
using DotNetOpenAuth.OpenId.Messages;
/// <summary>
/// Represents an incoming OpenId authentication request.
/// </summary>
/// <remarks>
/// Requests may be infrastructural to OpenID and allow auto-responses, or they may
/// be authentication requests where the Provider site has to make decisions based
/// on its own user database and policies.
/// </remarks>
[ContractClass(typeof(IRequestContract))]
public interface IRequest {
/// <summary>
/// Gets a value indicating whether the response is ready to be sent to the user agent.
/// </summary>
/// <remarks>
/// This property returns false if there are properties that must be set on this
/// request instance before the response can be sent.
/// </remarks>
bool IsResponseReady { get; }
/// <summary>
/// Gets or sets the security settings that apply to this request.
/// </summary>
/// <value>Defaults to the OpenIdProvider.SecuritySettings on the OpenIdProvider.</value>
ProviderSecuritySettings SecuritySettings { get; set; }
/// <summary>
/// Adds an extension to the response to send to the relying party.
/// </summary>
/// <param name="extension">The extension to add to the response message.</param>
void AddResponseExtension(IOpenIdMessageExtension extension);
/// <summary>
/// Removes any response extensions previously added using <see cref="IRequest.AddResponseExtension"/>.
/// </summary>
/// <remarks>
/// This should be called before sending a negative response back to the relying party
/// if extensions were already added, since negative responses cannot carry extensions.
/// </remarks>
void ClearResponseExtensions();
/// <summary>
/// Gets an extension sent from the relying party.
/// </summary>
/// <typeparam name="T">The type of the extension.</typeparam>
/// <returns>An instance of the extension initialized with values passed in with the request.</returns>
[SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter", Justification = "No parameter to make of type T.")]
T GetExtension<T>() where T : IOpenIdMessageExtension, new();
/// <summary>
/// Gets an extension sent from the relying party.
/// </summary>
/// <param name="extensionType">The type of the extension.</param>
/// <returns>An instance of the extension initialized with values passed in with the request.</returns>
IOpenIdMessageExtension GetExtension(Type extensionType);
}
/// <summary>
/// Code contract for the <see cref="IRequest"/> interface.
/// </summary>
[ContractClassFor(typeof(IRequest))]
internal abstract class IRequestContract : IRequest {
/// <summary>
/// Prevents a default instance of the <see cref="IRequestContract"/> class from being created.
/// </summary>
private IRequestContract() {
}
#region IRequest Members
/// <summary>
/// Gets or sets the security settings that apply to this request.
/// </summary>
/// <value>Defaults to the OpenIdProvider.SecuritySettings on the OpenIdProvider.</value>
ProviderSecuritySettings IRequest.SecuritySettings {
get { throw new NotImplementedException(); }
set { throw new NotImplementedException(); }
}
/// <summary>
/// Gets a value indicating whether the response is ready to be sent to the user agent.
/// </summary>
/// <remarks>
/// This property returns false if there are properties that must be set on this
/// request instance before the response can be sent.
/// </remarks>
bool IRequest.IsResponseReady {
get { throw new NotImplementedException(); }
}
/// <summary>
/// Adds an extension to the response to send to the relying party.
/// </summary>
/// <param name="extension">The extension to add to the response message.</param>
void IRequest.AddResponseExtension(IOpenIdMessageExtension extension) {
Requires.NotNull(extension, "extension");
throw new NotImplementedException();
}
/// <summary>
/// Removes any response extensions previously added using <see cref="IRequest.AddResponseExtension"/>.
/// </summary>
/// <remarks>
/// This should be called before sending a negative response back to the relying party
/// if extensions were already added, since negative responses cannot carry extensions.
/// </remarks>
void IRequest.ClearResponseExtensions() {
}
/// <summary>
/// Gets an extension sent from the relying party.
/// </summary>
/// <typeparam name="T">The type of the extension.</typeparam>
/// <returns>
/// An instance of the extension initialized with values passed in with the request.
/// </returns>
T IRequest.GetExtension<T>() {
throw new NotImplementedException();
}
/// <summary>
/// Gets an extension sent from the relying party.
/// </summary>
/// <param name="extensionType">The type of the extension.</param>
/// <returns>
/// An instance of the extension initialized with values passed in with the request.
/// </returns>
IOpenIdMessageExtension IRequest.GetExtension(Type extensionType) {
Requires.NotNull(extensionType, "extensionType");
throw new NotImplementedException();
}
#endregion
}
}
|
