ICredentials Interface

 

Provides the base authentication interface for retrieving credentials for Web client authentication.

Namespace:   System.Net
Assembly:  System (in System.dll)

public interface ICredentials

NameDescription
System_CAPS_pubmethodGetCredential(Uri, String)

Returns a NetworkCredential object that is associated with the specified URI, and authentication type.

The ICredentials interface provides the GetCredential method to objects that supply network credentials to applications.

The following example illustrates how to use the ICredentials interface.

class CredentialList : ICredentials
{
	class CredentialInfo
	{
		public Uri uriObj;
		public String authenticationType;
		public NetworkCredential networkCredentialObj;

		public CredentialInfo(Uri uriObj, String authenticationType, NetworkCredential networkCredentialObj)
		{
			this.uriObj = uriObj;
			this.authenticationType = authenticationType;
			this.networkCredentialObj = networkCredentialObj;
		}
	}

	private ArrayList arrayListObj;

	public CredentialList()
	{
		arrayListObj = new ArrayList();
	}

	public void Add (Uri uriObj, String authenticationType, NetworkCredential credential)
	{
		// Add a 'CredentialInfo' object into a list.
		arrayListObj.Add (new CredentialInfo(uriObj, authenticationType, credential));      
	}
	// Remove the 'CredentialInfo' object from the list that matches to the given 'Uri' and 'AuthenticationType'
	public void Remove (Uri uriObj, String authenticationType)
	{
		for(int index=0;index < arrayListObj.Count; index++)
		{
			CredentialInfo credentialInfo = (CredentialInfo)arrayListObj[index];
			if(uriObj.Equals(credentialInfo.uriObj)&& authenticationType.Equals(credentialInfo.authenticationType))
				arrayListObj.RemoveAt(index);
		}
	}
	public NetworkCredential GetCredential (Uri uriObj, String authenticationType)
	{
		for(int index=0;index < arrayListObj.Count; index++)
		{
			CredentialInfo credentialInfoObj = (CredentialInfo)arrayListObj[index];
			if(uriObj.Equals(credentialInfoObj.uriObj) && authenticationType.Equals(credentialInfoObj.authenticationType))
				return credentialInfoObj.networkCredentialObj;
		}
		return null;
	}
};

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 3.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: