Configuring an HTTP Send Port Programmatically

Configuring an HTTP Send Port Progr...

Microsoft BizTalk Server 2004

The HTTP adapter stores its configuration information in the Configuration database. You store configuration information in a custom XML property bag. During initialization of the HTTP adapter and during its run time, the server passes the configuration to the adapter as follows:

For the HTTP send handler, configuration information passes to the adapter by calling the Load method of the IPersistPropertyBag interface.
For the HTTP send ports, configuration information passes to the adapter as a set of properties on a message context. The HTTP namespace groups these properties together.

The BizTalk Explorer object model exposes the ITransportInfo adapter configuration interface for send ports, which contains the TransportTypeData read/write property. This property accepts the HTTP send port configuration property bag as a name/value pair XML string. Note that to set this property in the BizTalk Explorer object model, it must first be set on the Address property of the ITransportInfo interface.

Setting the TransportTypeData property of the ITransportInfo interface is not required. If it is not set, the HTTP adapter will use the default values for the HTTP send handler.

If send port configuration properties that duplicate the configuration for the handler are not defined, configuration properties for the handler are used. If the HTTP send handler does not have configuration values, the HTTP send adapter logs an error in the event log and moves the message to the backup adapter.

You can set configuration properties programmatically on a message context. You can set these properties in a BizTalk Server orchestration schedule or in custom pipeline components. The following rules apply when using these properties:

If the configuration property is set on an orchestration or in a custom pipeline component in a receive pipeline, then:
- If a message is sent to a static send port, the property value will be overwritten with the value configured for that send port.
- If a message is sent to a dynamic send port, the property value will not be overwritten.
If the configuration property is set in a custom pipeline component in a send pipeline, then:
- The value will not be overwritten regardless of whether the message is sent to a static or dynamic send port.

The following table lists the configuration properties that you can set in the BizTalk Explorer object model for the HTTP send location.

Property name	Type	Description	Restrictions	Comments
RequestTimeout	xs:int	Time-out period of waiting for a response from the server. If set to zero (0), the system calculates the time-out based on the request message size.	Minimum value: 0 Maximum value: MAX_LONG	Default value: 0
ContentType	xs:string	Content type of the request messages	Minimum length: 0 Maximum length: 256	Default value: Text/XML
MaxRedirects	xs:int	Maximum number of times that the HTTP adapter can redirect the request.	Minimum value: 0 Maximum value: 10	Default value: 5
UseHandlerProxySettings	xs:boolean	Specifies whether HTTP send port will use the proxy configuration for the send handler.	None	Default value: True
UseProxy	xs:boolean	Specifies whether the HTTP adapter will use the proxy server.	None	Default value: False This property is ignored if UseHandlerProxySettings is True.
ProxyName	xs:string	Specifies the proxy server name.	Minimum length: 0 Maximum length: 256	Default value: Empty The HTTP send adapter ignores this property if the UseHandlerProxySettings property is set to True. Otherwise, the HTTP send adapter uses this property only if UseProxy is True. This property is required if UseProxy is True.
ProxyPort	xs:int	Specifies the proxy server port.	Minimum value: 0 Maximum value: 65535	Default value: 80 The HTTP send adapter ignores this property if UseHandlerProxySettings is True. Otherwise, HTTP send adapter uses this property only if UseProxy is True. This property is required if UseProxy is True.
ProxyUsername	xs:string	Specifies the user name for authentication with the proxy server.	Minimum length: 0 Maximum length: 256	Default value: empty The HTTP send adapter ignores this property if UseHandlerProxySettings is True. Otherwise, HTTP send adapter uses this property only if UseProxy is True.
ProxyPassword	xs:string	Specifies the user password for authentication with the proxy server.	Minimum length: 0 Maximum length: 256	Default value: empty The HTTP send adapter ignores this property if UseHandlerProxySettings is True. Otherwise, HTTP send adapter uses this property only if UseProxy is True.
AuthenticationScheme	xs:string	Type of authentication to use with the destination server.	None	Valid values: Anonymous (Default) Basic Digest Kerberos
Username	xs:string	User name to use for authentication with the server.	Minimum length: 0 Maximum length: 256	Default value: Empty This value is required if you select Basic or Digest authentication. The HTTP adapter ignores the value of this property if UseSSO is True.
Password	xs:string	User password to use for authentication with the server.	Minimum length: 0 Maximum length: 256	Default value: empty This value is required if you select Basic or Digest authentication. The value of this property is ignored if UseSSO is True.
Certificate	xs:string	Thumbprint of the client SSL certificate.	Minimum length: 0 Maximum length: 59	Default value: Empty
UseSSO	xs:boolean	Specifies if SSO will be used for the send port.	None	Default value: False
AffiliateApplicationName	xs:string	Name of the affiliate application to use for SSO.	Minimum length: 0 Maximum length: 256	Default value: empty Required if UseSSO is True.

The following code shows the XML string to use to set these properties:

<CustomProps>
   <ContentType vt="8">text/xml</ContentType>
   <RequestTimeout vt="3">0</RequestTimeout>
   <MaxRedirects vt="3">5</MaxRedirects>
   <UseHandlerProxySettings vt="8">-1</UseHandlerProxySettings>
   <UseProxy vt="8">-1</UseProxy>
   <ProxyName vt="8">sdfsd</ProxyName>
   <ProxyPort vt="3">80</ProxyPort>
   <ProxyUsername vt="8">Somename</ProxyUsername>
   <ProxyPassword vt="8">Somepassword</ProxyPassword>
   <AuthenticationScheme vt="8">Basic</AuthenticationScheme>
   <Username vt="8">Somename</Username>
   <Password vt="8">Somepassword</Password>
   <Certificate vt="8">AAAA BBBB CCCC DDDD</Certificate>
   <UseSSO vt="11">0</UseSSO>
   <AffiliateApplicationName vt="8">Name</AffiliateApplicationName>
</CustomProps>

See Also