mcs/class/referencesource/System/net/System/Net/ICredentialsByHost.cs

   1 //------------------------------------------------------------------------------
   2 // <copyright file="ICredentials.cs" company="Microsoft">
   3 //     Copyright (c) Microsoft Corporation.  All rights reserved.
   4 // </copyright>
   5 //------------------------------------------------------------------------------
   6
   7
   8 namespace System.Net {
   9
  10     //using System;
  11     //using System.Net;
  12     using System.Runtime.InteropServices;
  13
  14     //
  15     // This is an extensible interface that authenticators
  16     // must implement to support credential lookup.
  17     // During execution of the protocol, if authentication
  18     // information is needed the GetCredential function will
  19     // be called with the host and realm information.
  20     //
  21
  22     /// <devdoc>
  23     ///    <para>Provides the base authentication interface for Web client authentication.</para>
  24     /// </devdoc>
  25     public interface ICredentialsByHost {
  26         /// <devdoc>
  27         ///    <para>
  28         ///       Returns a NetworkCredential object that
  29         ///       is associated with the supplied host, realm, and authentication type.
  30         ///    </para>
  31         /// </devdoc>
  32
  33         //
  34         // CONVENTION:
  35         // returns null if no information is available
  36         // for the specified host&realm
  37         //
  38         NetworkCredential GetCredential(string host, int port, string authenticationType);
  39
  40     } // interface ICredentials
  41
  42
  43 } // namespace System.Net