BizTalk 2006 : Dealing with Extremely Large Messages (part 2) - Large Message Encoding

Large Message Encoding

The large message encoding component is to be used on the send side when the large message is sent by BizTalk. You will need to create a custom send pipeline and add this pipeline component to the Encode stage. This component relies on a property schema being deployed that will be used to store the location to the file within the message context.

Imports System
Imports System.IO
Imports System.Text
Imports System.Drawing
Imports System.Resources
Imports System.Reflection
Imports System.Diagnostics
Imports System.Collections
Imports System.ComponentModel
Imports Microsoft.BizTalk.Message.Interop
Imports Microsoft.BizTalk.Component.Interop
Imports Microsoft.BizTalk.Component
Imports Microsoft.BizTalk.Messaging

Namespace ABC.BizTalk.PipelineComponents

<ComponentCategory(CategoryTypes.CATID_PipelineComponent), _
     System.Runtime.InteropServices.Guid("4f1c7d50-e66f-451b-8e94-2f8d599cd013"), _
     ComponentCategory(CategoryTypes.CATID_Encoder)> _
Public Class LargeFileEncodingComponent
       Implements IBaseComponent, IPersistPropertyBag, IComponentUI,_
Microsoft.BizTalk.Component.Interop.IComponent

        Private resourceManager As System.Resources.ResourceManager = New_
        System.Resources.ResourceManager("ABC.BizTalk.PipelineComponents._
        LargeFileEncodingComponent", [Assembly].GetExecutingAssembly)
        Private Const ABC_PROPERTY_SCHEMA_NAMESPACE =_
"http://ABC.BizTalk.Schemas.ABCPropertySchema"

        '<summary>
        'Name of the component
        '</summary>
        <Browsable(False)> _
        Public ReadOnly Property Name() As String Implements_
Microsoft.BizTalk.Component.Interop.IBaseComponent.Name
            Get
                Return resourceManager.GetString("COMPONENTNAME",_
System.Globalization.CultureInfo.InvariantCulture)
            End Get
        End Property

        '<summary>
        'Version of the component
        '</summary>
        <Browsable(False)> _
        Public ReadOnly Property Version() As String Implements_

					  

Microsoft.BizTalk.Component.Interop.IBaseComponent.Version
            Get
                Return resourceManager.GetString("COMPONENTVERSION",_
System.Globalization.CultureInfo.InvariantCulture)
            End Get
        End Property

        '<summary>
        'Description of the component
        '</summary>
        <Browsable(False)> _
        Public ReadOnly Property Description() As String Implements_
Microsoft.BizTalk.Component.Interop.IBaseComponent.Description
            Get
                Return resourceManager.GetString("COMPONENTDESCRIPTION",_
System.Globalization.CultureInfo.InvariantCulture)
            End Get
        End Property

        '<summary>
        'Component icon to use in BizTalk Editor
        '</summary>
        <Browsable(False)> _
        Public ReadOnly Property Icon() As IntPtr Implements_
Microsoft.BizTalk.Component.Interop.IComponentUI.Icon
            Get
                Return CType(Me.resourceManager.GetObject("COMPONENTICON",_
System.Globalization.CultureInfo.InvariantCulture), System.Drawing.Bitmap).GetHicon
            End Get
        End Property

        '<summary>
        'Gets class ID of component for usage from unmanaged code.
        '</summary>
        '<param name="classid">
        'Class ID of the component
        '</param>
        Public Sub GetClassID(ByRef classid As System.Guid) Implements_
Microsoft.BizTalk.Component.Interop.IPersistPropertyBag.GetClassID
            classid = New System.Guid("4f1c7d50-e66f-451b-8e94-2f8d599cd013")
        End Sub

        '<summary>
        'not implemented
        '</summary>
        Public Sub InitNew() Implements_

					  

Microsoft.BizTalk.Component.Interop.IPersistPropertyBag.InitNew
        End Sub

        '<summary>
        'Loads configuration properties for the component
        '</summary>
        '<param name="pb">Configuration property bag</param>
        '<param name="errlog">Error status</param>
        Public Overridable Sub Load(ByVal pb As_
        Microsoft.BizTalk.Component.Interop.IPropertyBag,_
        ByVal errlog As Integer) Implements_
        Microsoft.BizTalk.Component.Interop.IPersistPropertyBag.Load
        End Sub

        '<summary>
        'Saves the current component configuration into the property bag
        '</summary>
        '<param name="pb">Configuration property bag</param>
        '<param name="fClearDirty">not used</param>
        '<param name="fSaveAllProperties">not used</param>
        Public Overridable Sub Save(ByVal pb As_
        Microsoft.BizTalk.Component.Interop.IPropertyBag, ByVal fClearDirty As_
        Boolean, ByVal fSaveAllProperties As Boolean) Implements_
        Microsoft.BizTalk.Component.Interop.IPersistPropertyBag.Save
        End Sub

        '<summary>
        'Reads property value from property bag
        '</summary>
        '<param name="pb">Property bag</param>
        '<param name="propName">Name of property</param>
        '<returns>Value of the property</returns>
        Private Function ReadPropertyBag(ByVal pb As_
        Microsoft.BizTalk.Component.Interop.IPropertyBag, ByVal propName As_
        String) As Object
            Dim val As Object = Nothing
            Try
                pb.Read(propName, val, 0)
            Catch e As System.ArgumentException
                Return val
            Catch e As System.Exception
                Throw New System.ApplicationException(e.Message)
            End Try
            Return val
        End Function

					  

'<summary>
        'Writes property values into a property bag.
        '</summary>
        '<param name="pb">Property bag.</param>
        '<param name="propName">Name of property.</param>
        '<param name="val">Value of property.</param>
        Private Sub WritePropertyBag(ByVal pb As_
Microsoft.BizTalk.Component.Interop.IPropertyBag, ByVal propName As String, ByVal _
val As Object)
            Try
                pb.Write(propName, val)
            Catch e As System.Exception
                Throw New System.ApplicationException(e.Message)
            End Try
            End Sub

         '<summary>
         'The Validate method is called by the BizTalk Editor during the build
         'of a BizTalk project.
         '</summary>
         '<param name="obj">An Object containing the configuration
         ' properties.</param>
         '<returns>The IEnumerator enables the caller to enumerate through a
         'collection of strings containing error messages. These error messages
         'appear as compiler error messages. To report successful property
         'validation, the method should return an empty enumerator.</returns>
         Public Function Validate(ByVal obj As Object) As _
System.Collections.IEnumerator Implements _
Microsoft.BizTalk.Component.Interop.IComponentUI.Validate
            'example implementation:
            'ArrayList errorList = new ArrayList();
            'errorList.Add("This is a compiler error");
            'return errorList.GetEnumerator();
            Return Nothing
        End Function

        '<summary>
        'Implements IComponent.Execute method.
        '</summary>
        '<param name="pc">Pipeline context</param>
        '<param name="inmsg">Input message</param>
        '<returns>Original input message</returns>
        '<remarks>
        'IComponent.Execute method is used to initiate
        'the processing of the message in this pipeline component.
        '</remarks>

					  

Public Function Execute(ByVal pContext As_
Microsoft.BizTalk.Component.Interop.IPipelineContext, ByVal inmsg As_
Microsoft.BizTalk.Message.Interop.IBaseMessage) As_
Microsoft.BizTalk.Message.Interop.IBaseMessage Implements_
Microsoft.BizTalk.Component.Interop.IComponent.Execute
            'Build the message that is to be sent out
            BuildMessageData(pContext, inmsg)
            Return inmsg
        End Function

        '<summary>
        'Method used to assign the data to a stream. Method reads path from
         promoted property
        '</summary>
        '<param name="pc">Pipeline context</param>
        '<param name="inmsg">Input message to be assigned</param>
        '<returns>Original input message by reference</returns>
        '<remarks>
        'Receives the input message ByRef then assigns the file stream to the_
 messageBody.Data property
        '</remarks>
        Private Sub BuildMessageData(ByVal pContext As IPipelineContext,_
        ByRef inMsg As IBaseMessage)
            Dim messageBody As IBaseMessagePart = _
pContext.GetMessageFactory().CreateMessagePart()
            Dim data As New FileStream(inMsg.Context.Read("LargeFileLocation", _
ABC_PROPERTY_SCHEMA_NAMESPACE), FileMode.Open, FileAccess.Read, FileShare.Read, 4 *_
1024 * 1024)
            messageBody.Data = data
            If data.CanSeek Then
                data.Position = 0
            End If
            inMsg.BodyPart.Data = data
        End Sub
End Class
End Namespace