summaryrefslogtreecommitdiffstats
path: root/src/DotNetOpenAuth.OpenId.Provider/OpenId/Provider/IErrorReporting.cs
diff options
context:
space:
mode:
authorAndrew Arnott <andrewarnott@gmail.com>2012-01-29 14:32:45 -0800
committerAndrew Arnott <andrewarnott@gmail.com>2012-01-29 14:32:45 -0800
commit5fec515095ee10b522f414a03e78f282aaf520dc (patch)
tree204c75486639c23cdda2ef38b34d7e5050a1a2e3 /src/DotNetOpenAuth.OpenId.Provider/OpenId/Provider/IErrorReporting.cs
parentf1a4155398635a4fd9f485eec817152627682704 (diff)
parent8f4165ee515728aca3faaa26e8354a40612e85e4 (diff)
downloadDotNetOpenAuth-5fec515095ee10b522f414a03e78f282aaf520dc.zip
DotNetOpenAuth-5fec515095ee10b522f414a03e78f282aaf520dc.tar.gz
DotNetOpenAuth-5fec515095ee10b522f414a03e78f282aaf520dc.tar.bz2
Merge branch 'splitDlls'.
DNOA now builds and (in some cases) ships as many distinct assemblies.
Diffstat (limited to 'src/DotNetOpenAuth.OpenId.Provider/OpenId/Provider/IErrorReporting.cs')
-rw-r--r--src/DotNetOpenAuth.OpenId.Provider/OpenId/Provider/IErrorReporting.cs43
1 files changed, 43 insertions, 0 deletions
diff --git a/src/DotNetOpenAuth.OpenId.Provider/OpenId/Provider/IErrorReporting.cs b/src/DotNetOpenAuth.OpenId.Provider/OpenId/Provider/IErrorReporting.cs
new file mode 100644
index 0000000..1c73595
--- /dev/null
+++ b/src/DotNetOpenAuth.OpenId.Provider/OpenId/Provider/IErrorReporting.cs
@@ -0,0 +1,43 @@
+//-----------------------------------------------------------------------
+// <copyright file="IErrorReporting.cs" company="Andrew Arnott">
+// Copyright (c) Andrew Arnott. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace DotNetOpenAuth.OpenId.Provider {
+ using System;
+ using DotNetOpenAuth.Messaging;
+
+ /// <summary>
+ /// An interface that a Provider site may implement in order to better
+ /// control error reporting.
+ /// </summary>
+ public interface IErrorReporting {
+ /// <summary>
+ /// Gets the message that can be sent in an error response
+ /// with information on who the remote party can contact
+ /// for help resolving the error.
+ /// </summary>
+ /// <value>
+ /// The contact address may take any form, as it is intended to be displayed to a person.
+ /// </value>
+ string Contact { get; }
+
+ /// <summary>
+ /// Logs the details of an exception for later reference in diagnosing the problem.
+ /// </summary>
+ /// <param name="exception">The exception that was generated from the error.</param>
+ /// <returns>
+ /// A unique identifier for this particular error that the remote party can
+ /// reference when contacting <see cref="Contact"/> for help with this error.
+ /// May be null.
+ /// </returns>
+ /// <remarks>
+ /// The implementation of this method should never throw an unhandled exception
+ /// as that would preclude the ability to send the error response to the remote
+ /// party. When this method is not implemented, it should return null rather
+ /// than throwing <see cref="NotImplementedException"/>.
+ /// </remarks>
+ string LogError(ProtocolException exception);
+ }
+}