CredentialCache.GetCredential Method

Definition

Namespace:

System.Net

Assembly:

System.Net.Primitives.dll

Returns a NetworkCredential instance associated with a specified Uniform Resource Identifier (URI) or host, and authentication type.

Overloads

GetCredential(Uri, String)	Returns the NetworkCredential instance associated with the specified Uniform Resource Identifier (URI) and authentication type.
GetCredential(String, Int32, String)	Returns the NetworkCredential instance associated with the specified host, port, and authentication protocol.

GetCredential(Uri, String)

Source:

CredentialCache.cs

Returns the NetworkCredential instance associated with the specified Uniform Resource Identifier (URI) and authentication type.

public:
 virtual System::Net::NetworkCredential ^ GetCredential(Uri ^ uriPrefix, System::String ^ authType);

public System.Net.NetworkCredential? GetCredential (Uri uriPrefix, string authType);

abstract member GetCredential : Uri * string -> System.Net.NetworkCredential
override this.GetCredential : Uri * string -> System.Net.NetworkCredential

Public Function GetCredential (uriPrefix As Uri, authType As String) As NetworkCredential

Parameters

uriPrefix

Uri

A Uri that specifies the URI prefix of the resources that the credential grants access to.

authType

String

The authentication scheme used by the resource named in uriPrefix.

Returns

NetworkCredential

A NetworkCredential or, if there is no matching credential in the cache, null.

Implements

GetCredential(Uri, String)

Exceptions

ArgumentNullException

uriPrefix or authType is null.

Examples

The following code example uses the GetCredential(Uri, String) method to return the NetworkCredential instance associated with the specified URI and authentication type.

void Display( NetworkCredential^ credential )
{
   Console::WriteLine( "\nThe credentials are:" );
   Console::WriteLine( "\nUsername : {0} , Password : {1} , Domain : {2}", credential->UserName, credential->Password, credential->Domain );
}

void GetPage( String^ url, String^ userName, String^ password, String^ domainName )
{
   try
   {
      CredentialCache^ myCredentialCache = gcnew CredentialCache;

      // Dummy names used as credentials.
      myCredentialCache->Add( gcnew Uri( "http://microsoft.com/" ), "Basic", gcnew NetworkCredential( "user1","passwd1","domain1" ) );
      myCredentialCache->Add( gcnew Uri( "http://msdn.com/" ), "Basic", gcnew NetworkCredential( "user2","passwd2","domain2" ) );
      myCredentialCache->Add( gcnew Uri( url ), "Basic", gcnew NetworkCredential( userName,password,domainName ) );

      // Create a webrequest with the specified url.
      WebRequest^ myWebRequest = WebRequest::Create( url );

      // Call 'GetCredential' to obtain the credentials specific to our Uri.
      NetworkCredential^ myCredential = myCredentialCache->GetCredential( gcnew Uri( url ), "Basic" );
      Display( myCredential );

      // Associating only our credentials.
      myWebRequest->Credentials = myCredential;

      // Sends the request and waits for response.
      WebResponse^ myWebResponse = myWebRequest->GetResponse();

      // Process response here.
      Console::WriteLine( "\nResponse Received." );
      myWebResponse->Close();
   }
   catch ( WebException^ e ) 
   {
      if ( e->Response != nullptr )
            Console::WriteLine( "\r\nFailed to obtain a response. The following error occurred : {0}", (dynamic_cast<HttpWebResponse^>(e->Response))->StatusDescription );
      else
            Console::WriteLine( "\r\nFailed to obtain a response. The following error occurred : {0}", e->Status );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "\nThe following exception was raised : {0}", e->Message );
   }
}

  public static void GetPage(string url,string userName,string password,string domainName)
  {
      try
      {
          CredentialCache myCredentialCache = new CredentialCache();
          // Dummy names used as credentials.
          myCredentialCache.Add(new Uri("http://microsoft.com/"),"Basic", new NetworkCredential("user1","passwd1","domain1"));
          myCredentialCache.Add(new Uri("http://msdn.com/"),"Basic", new NetworkCredential("user2","passwd2","domain2"));
          myCredentialCache.Add(new Uri(url),"Basic", new NetworkCredential(userName,password,domainName));
          // Create a webrequest with the specified url.
       WebRequest myWebRequest = WebRequest.Create(url);
          // Call 'GetCredential' to obtain the credentials specific to our Uri.
          NetworkCredential myCredential = myCredentialCache.GetCredential(new Uri(url),"Basic");
          Display(myCredential);
       // Associating only our credentials.
          myWebRequest.Credentials = myCredential;
          // Sends the request and waits for response.
       WebResponse myWebResponse = myWebRequest.GetResponse();

          // Process response here.

       Console.WriteLine("\nResponse Received.");
          myWebResponse.Close();
      }
      catch(WebException e)
      {
          if (e.Response != null)
              Console.WriteLine("\r\nFailed to obtain a response. The following error occurred : {0}",((HttpWebResponse)(e.Response)).StatusDescription);
          else
              Console.WriteLine("\r\nFailed to obtain a response. The following error occurred : {0}",e.Status);
      }
      catch(Exception e)
      {
          Console.WriteLine("\nThe following exception was raised : {0}",e.Message);
      }
}
public static void Display(NetworkCredential credential)
{
  Console.WriteLine("\nThe credentials are:");
  Console.WriteLine("\nUsername : {0} ,Password : {1} ,Domain : {2}",credential.UserName,credential.Password,credential.Domain);
}

Public Shared Sub GetPage(url As String, userName As String, password As String, domainName As String)
    Try
        Dim myCredentialCache As New CredentialCache()
        ' Dummy names used as credentials    
        myCredentialCache.Add(New Uri("http://microsoft.com/"), "Basic", New NetworkCredential("user1", "passwd1", "domain1"))
        myCredentialCache.Add(New Uri("http://msdn.com/"), "Basic", New NetworkCredential("user2", "passwd2", "domain2"))
        myCredentialCache.Add(New Uri(url), "Basic", New NetworkCredential(userName, password, domainName))
        ' Creates a webrequest with the specified url. 
        Dim myWebRequest As WebRequest = WebRequest.Create(url)
        ' Call 'GetCredential' to obtain the credentials specific to our Uri.
        Dim myCredential As NetworkCredential = myCredentialCache.GetCredential(New Uri(url), "Basic")
        Display(myCredential)
        myWebRequest.Credentials = myCredential 'Associating only our credentials            
        ' Sends the request and waits for response.
        Dim myWebResponse As WebResponse = myWebRequest.GetResponse()
        ' Process response here.
        Console.WriteLine(ControlChars.Cr + "Response Received.")
        myWebResponse.Close()

    Catch e As WebException
        If Not (e.Response Is Nothing) Then
            Console.WriteLine(ControlChars.Lf + ControlChars.Cr + "Failed to obtain a response. The following error occurred : {0}", CType(e.Response, HttpWebResponse).StatusDescription)
        Else
            Console.WriteLine(ControlChars.Lf + ControlChars.Cr + "Failed to obtain a response. The following error occurred : {0}", e.Status)
        End If
    Catch e As Exception
        Console.WriteLine(ControlChars.Cr + "The following exception was raised : {0}", e.Message)
    End Try
End Sub

Public Shared Sub Display(ByVal credential As NetworkCredential)
    Console.WriteLine("The credentials are: ")
    Console.WriteLine(ControlChars.Cr + "Username : {0} ,Password : {1} ,Domain : {2}", credential.UserName, credential.Password, credential.Domain)
End Sub

Remarks

The GetCredential(Uri, String) method searches the CredentialCache and returns the NetworkCredential instance for the specified URI and authorization type. If the CredentialCache contains no matching NetworkCredential instance, null is returned.

GetCredential uses the longest matching URI prefix in the cache to determine which set of credentials to return for an authorization type. The following table shows examples.

URI Prefix	Matches
http://www.contoso.com/portal/news.htm	Requests for the specific Web page news.htm.
http://www.contoso.com/portal/	Requests for all content in the portal path, except the page news.htm.
http://www.contoso.com/	Requests for all resources at www.contoso.com, except those in the portal path.

GetCredential(String, Int32, String)

Source:

CredentialCache.cs

Returns the NetworkCredential instance associated with the specified host, port, and authentication protocol.

public:
 virtual System::Net::NetworkCredential ^ GetCredential(System::String ^ host, int port, System::String ^ authenticationType);

public System.Net.NetworkCredential? GetCredential (string host, int port, string authenticationType);

abstract member GetCredential : string * int * string -> System.Net.NetworkCredential
override this.GetCredential : string * int * string -> System.Net.NetworkCredential

Public Function GetCredential (host As String, port As Integer, authenticationType As String) As NetworkCredential

Parameters

host

String

A String that identifies the host computer.

port

Int32

A Int32 that specifies the port to connect to on host.

authenticationType

String

A String that identifies the authentication scheme used when connecting to host.

Returns

NetworkCredential

A NetworkCredential or, if there is no matching credential in the cache, null.

Implements

GetCredential(String, Int32, String)

Exceptions

ArgumentNullException

host is null.

-or-

authType is null.

ArgumentException

authType not an accepted value.

-or-

host is equal to the empty string ("").

ArgumentOutOfRangeException

port is less than zero.

Remarks

This method searches the CredentialCache and returns the NetworkCredential instance for the specified host, port, and authorization type. The host, port, and authType values passed to this method are case-insensitively compared to the values specified when the credential was added to the CredentialCache using the Add methods.

The supported values for authType are "NTLM", "Digest", "Kerberos", and "Negotiate".