HttpClientConnection HttpClientConnection HttpClientConnection Class

Definition

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.

public ref class HttpClientConnection sealed : Microsoft::SqlServer::Dts::Runtime::DtsObject, Microsoft::SqlServer::Dts::Runtime::IDTSPersist
public sealed class HttpClientConnection : Microsoft.SqlServer.Dts.Runtime.DtsObject, Microsoft.SqlServer.Dts.Runtime.IDTSPersist
Public NotInheritable Class HttpClientConnection
Inherits DtsObject
Implements IDTSPersist
Inheritance
HttpClientConnectionHttpClientConnectionHttpClientConnection
Implements

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.

Constructors

HttpClientConnection(Object) HttpClientConnection(Object) HttpClientConnection(Object)

Initializes a new instance of the HttpClientConnection class.

Properties

BypassProxyOnLocal BypassProxyOnLocal 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 Certificate Certificate

Gets or sets a byte array that represents the actual X.509 binary encoding of the certificate.

CertificateIdentifier CertificateIdentifier CertificateIdentifier

Gets or sets the X.509 certificate identifier.

ChunkSize ChunkSize 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 ProxyBypassList ProxyBypassList

Gets or sets the addresses that do not use a proxy server.

ProxyDomain ProxyDomain ProxyDomain

Gets or sets the domain setting that is used to log on to the proxy.

ProxyPassword ProxyPassword ProxyPassword

Sets the password used to log on to the proxy. This property is read-only.

ProxyURL ProxyURL ProxyURL

Gets or sets the URL that specifies the location of the proxy.

ProxyUserName ProxyUserName ProxyUserName

Gets or sets the username that is used when logging on to the proxy.

ServerDomain ServerDomain ServerDomain

Gets or sets the domain used to log on to the server.

ServerPassword ServerPassword ServerPassword

Sets the password used to log on to the server. This property is write-only.

ServerURL ServerURL ServerURL

Gets or sets the URL that specifies the location of the server.

ServerUserName ServerUserName ServerUserName

Gets or sets the username used to log on to the server.

Timeout Timeout Timeout

Gets or sets the number of seconds after which the HTTP operation times out.

UseProxy UseProxy UseProxy

Gets or sets a Boolean that indicates whether or not the connection will use a proxy.

UseProxyCredentials UseProxyCredentials UseProxyCredentials

Gets or sets a Boolean that indicates whether or not the connection will use network credentials.

UseSecureConnection UseSecureConnection UseSecureConnection

Gets or sets a Boolean that indicates whether the connection is HTTPS or HTTP.

UseServerCredentials UseServerCredentials UseServerCredentials

Gets or sets a Boolean that indicates whether the connection uses network credentials.

Methods

Clone() Clone() Clone()

Returns a new connection object that has the exact same state as the one being cloned.

DownloadData() DownloadData() DownloadData()

Returns a byte array that contains the data downloaded from the resource that was specified in the ServerURL property.

DownloadFile(String, Boolean) DownloadFile(String, Boolean) DownloadFile(String, Boolean)

Downloads data from the resource specified by ServerURL property to a local file.

Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
GetProxyPassword() GetProxyPassword() GetProxyPassword()

Gets the proxy password.

GetServerPassword() GetServerPassword() GetServerPassword()

Gets the server password.

LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.

OpenRead() OpenRead() OpenRead()

Opens a readable stream for the data to be downloaded from the resource specified by the ServerURL property.

SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

ShowCertificateDialog(IntPtr) ShowCertificateDialog(IntPtr) ShowCertificateDialog(IntPtr)

Displays the Windows certificate information dialog box.

Applies to