HttpClientConnection Class

Article
04/26/2013

Contains properties and methods that enable a package to access a Web server using the HTTP protocol to send or receive files. This class cannot be inherited.

Inheritance Hierarchy

System.Object
Microsoft.SqlServer.Dts.Runtime.DtsObject
Microsoft.SqlServer.Dts.Runtime.HttpClientConnection

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
<SerializableAttribute> _
Public NotInheritable Class HttpClientConnection _
    Inherits DtsObject _
    Implements IDTSPersist
'Usage
Dim instance As HttpClientConnection

[SerializableAttribute]
public sealed class HttpClientConnection : DtsObject, 
    IDTSPersist

[SerializableAttribute]
public ref class HttpClientConnection sealed : public DtsObject, 
    IDTSPersist

[<SealedAttribute>]
[<SerializableAttribute>]
type HttpClientConnection =  
    class 
        inherit DtsObject 
        interface IDTSPersist 
    end

public final class HttpClientConnection extends DtsObject implements IDTSPersist

The HttpClientConnection type exposes the following members.

Constructors

	Name	Description
	HttpClientConnection	Initializes a new instance of the HttpClientConnection class.

Top

Properties

	Name	Description
	BypassProxyOnLocal	Gets or sets a Boolean that indicates if the proxy server is configured to use credentials and bypass the proxy server and use local addresses instead.
	Certificate	Gets or sets a byte array that represents the actual X.509 binary encoding of the certificate.
	CertificateIdentifier	Gets or sets the X.509 certificate identifier.
	ChunkSize	Gets or sets the value that indicates the minimum number of bytes to retrieve from or send to the server during a read/write operation.
	ProxyBypassList	Gets or sets the addresses that do not use a proxy server.
	ProxyDomain	Gets or sets the domain setting that is used to log on to the proxy.
	ProxyPassword	Sets the password used to log on to the proxy. This property is read-only.
	ProxyURL	Gets or sets the URL that specifies the location of the proxy.
	ProxyUserName	Gets or sets the username that is used when logging on to the proxy.
	ServerDomain	Gets or sets the domain used to log on to the server.
	ServerPassword	Sets the password used to log on to the server. This property is write-only.
	ServerURL	Gets or sets the URL that specifies the location of the server.
	ServerUserName	Gets or sets the username used to log on to the server.
	Timeout	Gets or sets the number of seconds after which the HTTP operation times out.
	UseProxy	Gets or sets a Boolean that indicates whether or not the connection will use a proxy.
	UseProxyCredentials	Gets or sets a Boolean that indicates whether or not the connection will use network credentials.
	UseSecureConnection	Gets or sets a Boolean that indicates whether the connection is HTTPS or HTTP.
	UseServerCredentials	Gets or sets a Boolean that indicates whether the connection uses network credentials.

Top

Methods

	Name	Description
	Clone	Returns a new connection object that has the exact same state as the one being cloned.
	DownloadData	Returns a byte array that contains the data downloaded from the resource that was specified in the ServerURL property.
	DownloadFile	Downloads data from the resource specified by ServerURL property to a local file.
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetProxyPassword	Gets the proxy password.
	GetServerPassword	Gets the server password.
	GetType	(Inherited from Object.)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
	OpenRead	Opens a readable stream for the data to be downloaded from the resource specified by the ServerURL property.
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
	ShowCertificateDialog	Displays the Windows certificate information dialog box.
	ToString	(Inherited from Object.)

Top

Remarks

The HTTP connection manager allows packages to access resources over HTTP, allowing tasks such as extracting data from a Web service and operating on it. The HTTP connection manager encapsulates the functionality of creating and maintaining a HTTP connection. The HTTP connection manager includes custom properties, in addition to the properties that are common to all connection managers. The HTTP connection manager provides the runtime with a connection to a HTTP server that acts as a source. When you create an HTTP connection manager, you can specify properties specific to that connection and test to see if the connection is alive. After the connection has been created, the connection can be used by various tasks in the runtime.

This class inherits from DtsObject and implements IDTSPersist.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via