Indy 9 | Content | Index | Reference

TIdProxyConnectionInfo
Hierarchy, Properties, Methods, See Also, Unit: IdHTTPHeaderInfo
Represents headers in a HTTP request using a Proxy connection.

    TIdProxyConnectionInfo = class(TPersistent)

Unit
IdHTTPHeaderInfo
Description
TIdProxyConnectionInfo is a TPersistent descendant that represents headers used in a HTTP request that requires a Proxy connection. TIdProxyConnectionInfo contains properties that represent the headers used to establish the proxy connection, and to authenticate the client connection using the authorization scheme(s) supported on the Proxy server.

TIdProxyConnectionInfo is the type used to represent the TIdRequestHeaderInfo.ProxyParams property.

TIdProxyConnectionInfo.Authentication
TIdProxyConnectionInfo, See Also
Used to calculate HTTP Authentication credentials for a Proxy connection.

    property Authentication: TIdAuthentication;

Description
Authentication is a public TIdAuthentication member that contains the object instance to be used to perform HTTP Access Authentication for the Proxy connection. Authentication will normally contain an instance of a TIdAuthentication descendant like TIdBasicAuthentication or TIdDigestAuthentication.

Applications can assign the Authentication class to be used for the request. If Authentication has not been assigned, and BasicAuthentication is True, a TIdBasicAuthentication object instance will be automatically created in SetHeaders.

TIdProxyConnectionInfo.BasicAuthentication
TIdProxyConnectionInfo, See Also
Indicates that HTTP Basic Access authentication should be used.

    property BasicAuthentication: boolean;

Description
BasicAuthentication is a Boolean property that indicates if the HTTP Basic Access authentication algorithm should be used to calculate authorization credentials for the HTTP proxy connection. Set BasicAuthentication to True to allow TIdBasicAuthentication to be assigned to Authentication in SetHeaders.

TIdProxyConnectionInfo.ProxyPassword
TIdProxyConnectionInfo, See Also
Represents the password for the proxy authorization credentials.

    property ProxyPassword: string;

Description
ProxyPassword is a String property that identifies the password, used in conjunction with ProxyUsername, to construct authorization credentials for the proxy connection.

ProxyPassword is supplied as the value for Password in the Authentication object instance in SetHeaders.

TIdProxyConnectionInfo.ProxyPort
TIdProxyConnectionInfo, See Also
Port number used by the proxy server program.

    property ProxyPort: Integer;

Description
ProxyPort is an Integer property that represents the port number where a Proxy Server will listen for connections, and perform proxy authentication. ProxyServer and ProxyPort specify the address for the proxy connection.

Changing the value in ProxyPort will result in the freeing and releasing of the instance in Authentication prior to assigning the new value for the ProxyPort property.

TIdProxyConnectionInfo.ProxyServer
TIdProxyConnectionInfo, See Also
IP Address or host name for the proxy server program.

    property ProxyServer: string;

Description
ProxyServer is a String property that represents the IP address or host name where a Proxy Server will listen for connections, and perform proxy authentication. ProxyServer and ProxyPort specify the complete address for the proxy connection.

Changing the value in ProxyServer will result in the freeing and releasing of the instance in Authentication prior to assigning the new value for the ProxyServer property.

TIdProxyConnectionInfo.ProxyUsername
TIdProxyConnectionInfo, See Also
Represents the user name for the proxy authorization credentials.

    property ProxyUsername: string;

Description
ProxyUsername is a String property that contains the identity, used in conjunction with ProxyUsername, to construct authorization credentials for the proxy connection.

ProxyUsername is supplied as the value for Username in the Authentication object instance in SetHeaders.

TIdProxyConnectionInfo.Clear
TIdProxyConnectionInfo, See Also
Resets the header properties for the proxy connection.

    procedure Clear;

Description
Clear is a procedure that resets the header properties for a proxy connection to their default blank values, including ProxyServer, ProxyUsername, ProxyPassword, and ProxyPort.

TIdProxyConnectionInfo.Create
TIdProxyConnectionInfo, See Also
Constructor for the object instance.

    constructor Create;

Description
Create is the constructor for the object instance. Create calls the inherited Create method, and calls Clear prior to exiting from the method.

TIdProxyConnectionInfo.Destroy
TIdProxyConnectionInfo, See Also
Frees the object instance.

    destructor Destroy; override;

Description
Destroy is the destructor for the object instance. Destroy will free the object instance in the Authentication property when an instance has been assigned. Destroy calls the inherited Destroy method prior to exiting the method.

TIdProxyConnectionInfo.SetHeaders
TIdProxyConnectionInfo, See Also
Loads header names and values from object properties.

    procedure SetHeaders(Headers: TIdHeaderList);

Parameters
Headers: TIdHeaderList
Destination for the header names and values.
Description
SetHeaders is a procedure used to populate the TIdHeaderList specified in Headers with the names and values needed to represent the properties of the object instance. SetHeaders creates a 'Proxy-Authorization:' header using the value of the Authentication object property, when assigned. When Authentication is not assigned and BasicAuthentication is True, SetHeaders creates a TIdBasicAuthentication object instance that is used in Authentication to create the 'Proxy-Authorization:' header values.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.