ISecureDataConverter Interface

OBSOLETE

This interface is obsolete. Use the ISecureDataConverter interface instead.

If implemented, enables the Web Report Designer to use a custom algorithm for storing data source connection strings on the client.

Namespace: DevExpress.XtraReports.Web.ClientControls

Assembly: DevExpress.XtraReports.v24.1.Web.dll

NuGet Package: DevExpress.Web.Reporting.Common

Declaration

C#

[Obsolete("This interface is obsolete. Use the DevExpress.DataAccess.ISecureDataConverter interface instead.")]
public interface ISecureDataConverter :
    ISecureDataConverter

VB.NET

<Obsolete("This interface is obsolete. Use the DevExpress.DataAccess.ISecureDataConverter interface instead.")>
Public Interface ISecureDataConverter
    Inherits ISecureDataConverter

Remarks

When the SQL Data Source wizard obtains connection strings from the Web.config file, the serialized report only contains the connection name (and not the connection string itself).

You can register a custom connection string provider and store all the connection parameters or only the connection name with the serialized data source. When the report serialized with connection parameters is passed to the client, these parameters are encrypted by applying the MachineKey algorithm. You can implement a custom data protection mechanism using the ISecureDataConverter or IDataSourceProtectionService interface.

Refer to the following topics for more information on data connection registration processes:

• ASP.NET Web Forms - Register Data Connections
• ASP.NET MVC - Register Data Connections
• ASP.NET Core - Register Data Connections

The following code illustrates an ISecureDataConverter implementation that stores connections in an XML file.

C#

using DevExpress.XtraReports.Web.ClientControls;
using System;
using System.Linq;
using System.Xml.Linq;
// ...

public class CustomSecureDataConverter : ISecureDataConverter {
    const string URI = @"E:\Temp\Connections.xml";
    const string XML_CONNECTION = "Connection";
    const string XML_ID = "Id";
    static XDocument document;
    static object lockObj = new object();

    static CustomSecureDataConverter() {
        document = XDocument.Load(URI);
    }

    public string Protect(string entity) {
        var id = Guid.NewGuid().ToString();
        lock (lockObj)
            document.Root.Add(new XElement(XML_CONNECTION, new XAttribute(XML_ID, id), entity));
        return id;
    }

    public string Unprotect(string protectedEntity) {
        return document.Root.Elements(XML_CONNECTION)
            .First(x => x.Attribute(XML_ID).Value == protectedEntity)
            .Value;
    }

    public static void Flush() {
        document.Save(URI);
    }
}

VB.NET

Imports DevExpress.XtraReports.Web.ClientControls
Imports System
Imports System.Linq
Imports System.Xml.Linq
' ...

Public Class CustomSecureDataConverter
    Implements ISecureDataConverter
    Const URI As String = "E:\Temp\Connections.xml"
    Const XML_CONNECTION As String = "Connection"
    Const XML_ID As String = "Id"
    Shared document As XDocument
    Shared lockObj As New Object()

    Shared Sub New()
        document = XDocument.Load(URI)
    End Sub

    Public Function Protect(entity As String) As String
        Dim id = Guid.NewGuid().ToString()
        SyncLock lockObj
            document.Root.Add(New XElement(XML_CONNECTION, New XAttribute(XML_ID, id), entity))
        End SyncLock
        Return id
    End Function

    Public Function Unprotect(protectedEntity As String) As String
        Return document.Root.Elements(XML_CONNECTION).First(Function(x) x.Attribute(XML_ID).Value = protectedEntity).Value
    End Function

    Public Shared Sub Flush()
        document.Save(URI)
    End Sub
End Class

A custom Data Converter implementation should be registered at the application startup (by calling the DefaultReportDesignerContainer.RegisterSecureDataConverter<T> method) and released in the Application_End event (by calling the Flush method).

C#

using DevExpress.XtraReports.Web.ReportDesigner;
// ...

protected void Application_Start(object sender, System.EventArgs e) {
    DefaultReportDesignerContainer.RegisterSecureDataConverter<CustomSecureDataConverter>();
}

protected void Application_End(object sender, System.EventArgs e) {
    CustomSecureDataConverter.Flush();
}

VB.NET

Imports DevExpress.XtraReports.Web.ReportDesigner
' ...

Protected Sub Application_Start(sender As Object, e As System.EventArgs)
    DefaultReportDesignerContainer.RegisterSecureDataConverter(Of CustomSecureDataConverter)()
End Sub

Protected Sub Application_End(sender As Object, e As System.EventArgs)
    CustomSecureDataConverter.Flush()
End Sub