System.Net.Authorization Class

public class Authorization

Base Types

Object
  Authorization

Assembly

System

Library

Networking

Summary

Supplies authentication messages used to authenticate a client to server.

Description

The Authorization class contains authentication information returned by a IAuthenticationModule module. Authorization instances are used to pass server challenge responses and client preauthentication information.

[Note: Applications do not create or access instances of this type directly; instances of this type are created by authentication modules and used by the AuthenticationManager.]

See Also

System.Net Namespace

Members

Authorization Constructors

Authorization(System.String) Constructor
Authorization(System.String, bool) Constructor
Authorization(System.String, bool, System.String) Constructor

Authorization Properties

Authorization.Complete Property
Authorization.ConnectionGroupId Property
Authorization.Message Property
Authorization.ProtectionRealm Property


Authorization(System.String) Constructor

public Authorization(string token);

Summary

Constructs and initializes a new instance of the Authorization class with the specified authorization message.

Parameters

token
A String containing the authorization message to be sent to the server.

Description

This constructor creates a Authorization instance with the System.Net.Authorization.Message property set to token and the System.Net.Authorization.Complete property set to true . If token is null or a zero-length string, System.Net.Authorization.Message is set to null . System.Net.Authorization.ConnectionGroupId is set to null .

[Note: The System.Net.Authorization.Complete property indicates whether the authentication, as defined by the authentication protocol implemented by the caller, is finished or requires additional information exchange between the client and server.]

See Also

System.Net.Authorization Class, System.Net Namespace

Authorization(System.String, bool) Constructor

public Authorization(string token, bool finished);

Summary

Constructs and initializes a new instance of the Authorization class with the specified authorization message and completion status.

Parameters

token
A String containing the authentication message to be sent to the server.
finished
A Boolean value indicating the completion status of the client authentication. Specify true if the authentication is complete; otherwise, false .

Description

This constructor creates a Authorization instance with the System.Net.Authorization.Message property set to token and the System.Net.Authorization.Complete property set to finished. If token is null or a zero-length string, System.Net.Authorization.Message is set to null . System.Net.Authorization.ConnectionGroupId is set to null .

[Note: The System.Net.Authorization.Complete property indicates whether the authentication, as defined by the authentication protocol implemented by the caller, is finished or requires additional information exchange between the client and server.]

See Also

System.Net.Authorization Class, System.Net Namespace

Authorization(System.String, bool, System.String) Constructor

public Authorization(string token, bool finished, string connectionGroupId);

Summary

Constructs and initializes a new instance of the Authorization class with the specified authorization message, completion status, and connection group identifier.

Parameters

token
A String containing the authentication message to be sent to the server.
finished
A Boolean value indicating the completion status of the authentication. Specify true if the authentication is complete; otherwise, false .
connectionGroupId
A String containing a unique identifier that will be used to identify the authenticated connection, or null .

Description

This constructor creates a Authorization instance with the System.Net.Authorization.Message property set to token, the System.Net.Authorization.Complete property set to finished, and the System.Net.Authorization.ConnectionGroupId property set to connectionGroupId. If token is null or a zero-length string, System.Net.Authorization.Message is set to null . If connectionGroupId is null or a zero-length string, System.Net.Authorization.ConnectionGroupId is set to null .

[Note: The connection group identifier is used to restrict access to the server connection established with the current authorization instance. Only WebRequest instances that have connectionGroupId as their System.Net.WebRequest.ConnectionGroupName property value can use the connection. The connection group information set by this constructor is also available in the System.Net.ServicePoint.ConnectionName property of the service point that represents the connection.

The System.Net.Authorization.Complete property indicates whether the authentication, as defined by the authentication protocol implemented by the caller, is finished or requires additional information exchange between the client and server.

]

See Also

System.Net.Authorization Class, System.Net Namespace

Authorization.Complete Property

public bool Complete { get; }

Summary

Gets a Boolean value indicating the completion status of the authentication.

Property Value

true if the authentication process is complete; otherwise, false .

Description

This property is read-only.

The System.Net.Authorization.Complete property is set to true when the authentication process between the client and the server is finished.

[Note: Some authentication modules, such as a Kerberos module, use multiple round trips between the client and server to complete an authentication. The authentication module sets the System.Net.Authorization.Complete property to false until the authentication is complete.]

See Also

System.Net.Authorization Class, System.Net Namespace

Authorization.ConnectionGroupId Property

public string ConnectionGroupId { get; }

Summary

Gets the unique identifier for an authenticated connection.

Property Value

A String containing a unique connection identifier, or null if no value was specified to the constructor for the current instance.

Description

This property is read-only.

The connection group identifier is used to restrict access to the server connection established with the current authorization instance.

[Note: Only WebRequest instances that have System.Net.Authorization.ConnectionGroupId as their System.Net.WebRequest.ConnectionGroupName property value can use the connection. If the value of this property is null , access to the connection is not restricted in this manner. The connection group information is also available in the System.Net.ServicePoint.ConnectionName property of the service point that represents the connection.]

See Also

System.Net.Authorization Class, System.Net Namespace

Authorization.Message Property

public string Message { get; }

Summary

Gets the response to an authentication challenge.

Property Value

A String containing the message that will be returned to the server in response to an authentication challenge.

Description

This property is read-only.

[Note: The content of the string returned by this property is determined by the protocol implemented by the IAuthenticationModule object that created the current instance. ]

See Also

System.Net.Authorization Class, System.Net Namespace

Authorization.ProtectionRealm Property

public string[] ProtectionRealm { get; set; }

Summary

Gets or sets the URIs that can be authenticated using the value in the System.Net.Authorization.Message property.

Property Value

A String array containing URIs.

Description

[Note: A WebRequest compares a URI to this list to determine if the current instance can be used to authenticate a request for a given URI.]

See Also

System.Net.Authorization Class, System.Net Namespace