Protocol Element (ICF)

Contains elements that describe a single custom delivery protocol used by one or more applications.

Syntax

<Protocols>
    <Protocol>

Element Characteristics

Characteristic Description

Data type

None.

Default value

None.

Occurrence

Required once or more per Protocols element.

Updates

Can be added or deleted, and then applied when updating the instance.

Element Relationships

Relationship Elements

Parent element

Protocols Element (ICF)

Child elements

ProtocolName Element for Protocol (ICF)

ClassName Element (ICF)

AssemblyName Element (ICF)

Remarks

You need one Protocol element for each custom delivery protocol used by applications hosted by the instance. Do not define the Protocol element for the built-in File and SMTP delivery protocols.

For custom delivery protocols based on the IDeliveryProtocol interface, you need to provide both the fully qualified class name that implements the custom delivery protocol and the name of the assembly that contains the class.

For custom delivery protocols based on the IHttpProtocolProvider interface, just specify HttpExtension for the class name and omit the AssemblyName element. When you define a delivery channel for an HttpExtension delivery protocol, make sure to provide the arguments required by the custom protocol.

Example

This example shows the definition of a short message service (SMS) delivery protocol that implements the IDeliveryProtocol interface. The class is named SMSProtocol and is in the Protocols namespace. The class is located in the SMS.dll assembly.

<Protocol>
    <ProtocolName>SMSProtocol</ProtocolName>
    <ClassName>Protocols.SMSProtocol</ClassName>
    <AssemblyName>%BaseDirPath%\SMS.dll</AssemblyName>
</Protocol>

This example shows how to define a delivery protocol based on the IHttpProtocolProvider interface. The class is implemented in the Notification Services assembly, so you do not need to provide the assembly information.

<Protocol>
    <ProtocolName>HTTP</ProtocolName>
    <ClassName>HttpExtension</ClassName>
</Protocol>

See Also

Reference

Application Definition File Reference

Concepts

Instance Configuration File Reference

Other Resources

Developing a Custom Delivery Protocol

Help and Information

Getting SQL Server 2005 Assistance