Provide Authentication to Access JSON Data

• Apr 27, 2021
• 8 minutes to read

This tutorial demonstrates how to bind a report to JSON data located at the endpoint that requests basic HTTP authentication.

Tip

Online Example: How to Provide Authentication to Access JSON Data

Runtime Authentication

The JsonDataSource component has a JsonSource property that provides access to a UriJsonSource object. The JsonDataSource uses this object’s methods to retrieve JSON data from the specified URI. Implement the UriJsonSource class’ descendant that provides authentication parameters to get JSON data.

Add the Username and Password properties to your descendant:

C#

using DevExpress.DataAccess.Json;
using System;
using System.ComponentModel;
using System.Net;
using System.Xml.Linq;
//...
    public class MyUriJsonSource : UriJsonSource {
//...
        public string Username { get; set; }

        [PasswordPropertyText(true)]
        public string Password { get; set; }
//...
    }

VB.NET

Imports DevExpress.DataAccess.Json
Imports System
Imports System.ComponentModel
Imports System.Net
Imports System.Xml.Linq
'...
    Public Class MyUriJsonSource
        Inherits UriJsonSource
'...
        Public Property Username() As String

        <PasswordPropertyText(True)>
        Public Property Password() As String
'...
    End Class

Override the UriJsonSource class’ methods as follows:

• GetJsonString
  Use the specified username and password to access JSON data.

  C#

  using DevExpress.DataAccess.Json;
  using System;
  using System.ComponentModel;
  using System.Net;
  using System.Xml.Linq;
  //...
      public class MyUriJsonSource : UriJsonSource {
  //...
          public override string GetJsonString() {
              using(var client = new WebClient()) {
                  client.Credentials = new NetworkCredential(Username, Password);
                  // add a header to the request
                  // client.Headers.Add(Username, Password);
                  return client.DownloadString(Uri);
              }
          }
  //...
      }
  

  VB.NET

  Imports DevExpress.DataAccess.Json
  Imports System
  Imports System.ComponentModel
  Imports System.Net
  Imports System.Xml.Linq
  '...
      Public Class MyUriJsonSource
          Inherits UriJsonSource
  '...
          Public Overrides Function GetJsonString() As String
              Using client = New WebClient()
                  client.Credentials = New NetworkCredential(Username, Password)
                  ' add a header to the request
                  ' client.Headers.Add(Username, Password);
                  Return client.DownloadString(Uri)
              End Using
          End Function
  '...
      End Class
  

  Tip

  The code snippet above demonstrates the basic HTTP authentication. You can implement token-based authentication instead.

• SaveToXml and LoadFromXml
  Save/load the Username and Password property values to/from a report’s serialization to preview the report in the End-User Report Designer.

  C#

  using DevExpress.DataAccess.Json;
  using System;
  using System.ComponentModel;
  using System.Net;
  using System.Xml.Linq;
  //...
      public class MyUriJsonSource : UriJsonSource {
  //...
          protected override void SaveToXml(XElement connection) {
              base.SaveToXml(connection);
              MySecretStorage.SecretStorage.Instance.SaveCredentials(Uri.Authority, new Tuple<string, string>(Username, Password));
          }
  
          protected override void LoadFromXml(XElement connection) {
              base.LoadFromXml(connection);
              var cred = MySecretStorage.SecretStorage.Instance.GetCredentials(Uri.Authority);
              if(cred != null) {
                  Username = cred.Item1;
                  Password = cred.Item2;
              }
          }
  //...
      }
  

  VB.NET

  Imports DevExpress.DataAccess.Json
  Imports System
  Imports System.ComponentModel
  Imports System.Net
  Imports System.Xml.Linq
  '...
      Public Class MyUriJsonSource
          Inherits UriJsonSource
  '...
          Protected Overrides Sub SaveToXml(ByVal connection As XElement)
              MyBase.SaveToXml(connection)
              MySecretStorage.SecretStorage.Instance.SaveCredentials(Uri.Authority, New Tuple(Of String, String)(Username, Password))
          End Sub
  
          Protected Overrides Sub LoadFromXml(ByVal connection As XElement)
              MyBase.LoadFromXml(connection)
              Dim cred = MySecretStorage.SecretStorage.Instance.GetCredentials(Uri.Authority)
              If cred IsNot Nothing Then
                  Username = cred.Item1
                  Password = cred.Item2
              End If
          End Sub
  '...
      End Class
  

  Tip

  In the code above, the SecretStorage class stores the Username and Password property values in a file. To store them in a database, cloud or another location, implement another storage.

• Clone
  Include the Username and Password property values in the MyUriJsonSource object’s cloned copy. The End-User Report Designer uses this copy when you switch to Preview.

  C#

  using DevExpress.DataAccess.Json;
  using System;
  using System.ComponentModel;
  using System.Net;
  using System.Xml.Linq;
  //...
      public class MyUriJsonSource : UriJsonSource {
  //...
          protected override JsonSourceBase Clone() {
              var clone = new MyUriJsonSource() {
                  Uri = Uri,
                  RootElement = RootElement,
                  Username = Username,
                  Password = Password
              };
              return clone;
          }
  //...
      }
  

  VB.NET

  Imports DevExpress.DataAccess.Json
  Imports System
  Imports System.ComponentModel
  Imports System.Net
  Imports System.Xml.Linq
  '...
      Public Class MyUriJsonSource
          Inherits UriJsonSource
  '...
          Protected Overrides Function Clone() As JsonSourceBase
              Dim clonedUriJsonSource = New MyUriJsonSource() With {
                  .Uri = Uri,
                  .RootElement = RootElement,
                  .Username = Username,
                  .Password = Password
              }
              Return clonedUriJsonSource
          End Function
  '...
      End Class 
  

Implement a helper method that uses the passed URI, username, and password to create a JsonDataSource object.

C#

using DevExpress.DataAccess.Json;
using DevExpress.DataAccess.UI.Native.Json;
using System;
using System.Windows.Forms;
using XtraReport_JsonDataSource_with_Authorization.ReportCustomization;
//...
    public static class JsonDataSourceAuthorization_Example {
        public static JsonDataSource CreateCustomJsonDataSource(string uri, string username, string password) {
            var jsonDatasource = new JsonDataSource() {
                Name = "jsonDataSource",
                JsonSource = new MyUriJsonSource() {
                    Uri = new Uri(uri),
                    Username = username,
                    Password = password
                }
            };
            return jsonDatasource;
        }
    }

VB.NET

Imports DevExpress.DataAccess.Json
Imports DevExpress.DataAccess.UI.Native.Json
Imports System
Imports System.Windows.Forms
Imports XtraReport_JsonDataSource_with_Authorization.ReportCustomization
'...
    Public Module JsonDataSourceAuthorization_Example
        Public Function CreateCustomJsonDataSource(ByVal uri As String, ByVal username As String, ByVal password As String) As JsonDataSource
            Dim jsonDatasource = New JsonDataSource() With {
                .Name = "jsonDataSource",
                .JsonSource = New MyUriJsonSource() With {
                    .Uri = New Uri(uri),
                    .Username = username,
                    .Password = password
                }
            }
            Return jsonDatasource
        End Function
    End Module

You can now use this helper method to assign a JSON data source to a report.

C#

private void RuntimeAuthenticationButton_Click(object sender, EventArgs e) {
    var report = new XtraReport1();
    report.DataSource = JsonDataSourceAuthorization_Example.CreateCustomJsonDataSource(
        @"http://northwind.servicestack.net/customers.json", "username1", "userPassword1");
    report.DataMember = "Customers";
    new DevExpress.XtraReports.UI.ReportDesignTool(report).ShowDesigner();
}

VB.NET

Private Sub RuntimeAuthenticationButton_Click(ByVal sender As Object, ByVal e As EventArgs)
    Dim report = New XtraReport1()
    report.DataSource = JsonDataSourceAuthorization_Example.CreateCustomJsonDataSource("http://northwind.servicestack.net/customers.json", "username1", "userPassword1")
    report.DataMember = "Customers"
    Call (New DevExpress.XtraReports.UI.ReportDesignTool(report)).ShowDesigner()
End Sub

Add JSON Authentication to a Wizard Page

The Report Wizard and Data Source Wizard (VS, WinForms, WPF) contain the Specify JSON Data Location page. You can customize this page to allow users to specify the JSON data source’s authentication parameters.

The following steps describe how to add the Username and Password editors to the Specify JSON Data Location wizard page:

1. Extend the IChooseJsonSourcePageView interface with the Username and Password properties.

   C#

   using DevExpress.DataAccess.Wizard.Views;
   //...
       public interface IMyChooseJsonSourcePageView : IChooseJsonSourcePageView {
           string Username { get; set; }
           string Password { get; set; }
       }
   

   VB.NET

   Imports DevExpress.DataAccess.Wizard.Views
   '...
       Public Interface IMyChooseJsonSourcePageView
           Inherits IChooseJsonSourcePageView
   
           Property Username() As String
           Property Password() As String
       End Interface   
   

2. Implement a custom Page View based on the ChooseJsonSourcePageView to add the Username and Password items to the page.

   C#

   public class MyChooseJsonSourcePageView : DevExpress.DataAccess.UI.Wizard.Views.ChooseJsonSourcePageView, IMyChooseJsonSourcePageView {
       //...
   }
   

   VB.NET

   Public Class MyChooseJsonSourcePageView
       Inherits DevExpress.DataAccess.UI.Wizard.Views.ChooseJsonSourcePageView
       Implements IMyChooseJsonSourcePageView
   
       '...
   End Class
   

3. Implement a Page Presenter based on the ChooseJsonSourcePage<TModel> to define the page’s custom logic.
   In the Begin, Validate and Commit methods, create the MyUriJsonSource class’s instance and pass the page’s IMyChooseJsonSourcePageView.Username and IMyChooseJsonSourcePageView.Password property values as constructor parameters.

   C#

   public class MyChooseJsonSourcePage<TModel> : ChooseJsonSourcePage<TModel> where TModel : class, IJsonDataSourceModel {
       //...
       public override void Begin() {
           base.Begin();
           if(Model.JsonSource != null) {
               var myJsonSource = Model.JsonSource as MyUriJsonSource;
               if(myJsonSource != null && View is IMyChooseJsonSourcePageView) {
                   (View as IMyChooseJsonSourcePageView).Password = myJsonSource.Password;
                   (View as IMyChooseJsonSourcePageView).Username = myJsonSource.Username;
               }
           }
       }
       public override bool Validate(out string errorMessage) {
           //...
           JsonDataSource source = null;
           try {
               return AsyncHelper.DoWithWaitForm(token => {
                   source = new JsonDataSource {
                       JsonSource = new MyUriJsonSource() {
                           Uri = new Uri(View.Uri),
                           Username = (View as IMyChooseJsonSourcePageView)?.Username,
                           Password = (View as IMyChooseJsonSourcePageView)?.Password
                       }
                   };
                   token.ThrowIfCancellationRequested();
                   source.Fill();
                   Model.DataSchema = DevExpress.DataAccess.Native.Data.DataView.ConvertToDataView(source);
                   Model.JsonSchema = source.Schema;
               }, Context.WaitFormActivator, Context.CreateExceptionHandler(ExceptionHandlerKind.Loading));
           } catch(Exception e) {
               errorMessage = e.Message;
               return false;
           } finally {
               source?.Dispose();
           }
       }
       public override void Commit() {
           Model.JsonSource = new MyUriJsonSource() {
               Uri = new Uri(View.Uri),
               Username = (View as IMyChooseJsonSourcePageView)?.Username,
               Password = (View as IMyChooseJsonSourcePageView)?.Password
           };
           View.Changed -= ViewOnChanged;
       }
   }
   

   VB.NET

   Public Class MyChooseJsonSourcePage(Of TModel As {Class, IJsonDataSourceModel})
       Inherits ChooseJsonSourcePage(Of TModel)
   
       '...
       Public Overrides Sub Begin()
           MyBase.Begin()
           If Model.JsonSource IsNot Nothing Then
               Dim myJsonSource = TryCast(Model.JsonSource, MyUriJsonSource)
               If myJsonSource IsNot Nothing AndAlso TypeOf View Is IMyChooseJsonSourcePageView Then
                   TryCast(View, IMyChooseJsonSourcePageView).Password = myJsonSource.Password
                   TryCast(View, IMyChooseJsonSourcePageView).Username = myJsonSource.Username
               End If
           End If
       End Sub
       Public Overrides Function Validate(<System.Runtime.InteropServices.Out()> ByRef errorMessage As String) As Boolean
           '...
           Dim source As JsonDataSource = Nothing
           Try
               Return AsyncHelper.DoWithWaitForm(Sub(token)
                   source = New JsonDataSource With {
                       .JsonSource = New MyUriJsonSource() With {
                           .Uri = New Uri(View.Uri),
                           .Username = (TryCast(View, IMyChooseJsonSourcePageView))?.Username,
                           .Password = (TryCast(View, IMyChooseJsonSourcePageView))?.Password
                       }
                   }
                   token.ThrowIfCancellationRequested()
                   source.Fill()
                   Model.DataSchema = DevExpress.DataAccess.Native.Data.DataView.ConvertToDataView(source)
                   Model.JsonSchema = source.Schema
               End Sub, Context.WaitFormActivator, Context.CreateExceptionHandler(ExceptionHandlerKind.Loading))
           Catch e As Exception
               errorMessage = e.Message
               Return False
           Finally
               source?.Dispose()
           End Try
       End Function
       Public Overrides Sub Commit()
           Model.JsonSource = New MyUriJsonSource() With {
               .Uri = New Uri(View.Uri),
               .Username = (TryCast(View, IMyChooseJsonSourcePageView))?.Username,
               .Password = (TryCast(View, IMyChooseJsonSourcePageView))?.Password
           }
           View.Changed -= ViewOnChanged
       End Sub
   End Class     
   

4. Implement the IWizardCustomizationService interface to register the custom Page View and Presenter.

   C#

   public class MyWizardCustomizationService : IWizardCustomizationService, IJsonEditorsCustomizationService {
           public void CustomizeDataSourceWizard(IWizardCustomization<XtraReportModel> tool) {
               tool.RegisterPage<ChooseJsonSourcePage<XtraReportModel>, MyChooseJsonSourcePage<XtraReportModel>>();
               tool.RegisterPageView<IChooseJsonSourcePageView, MyChooseJsonSourcePageView>();
           }
   
           public void CustomizeReportWizard(IWizardCustomization<XtraReportModel> tool) {
               tool.RegisterPage<ChooseJsonSourcePage<XtraReportModel>, MyChooseJsonSourcePage<XtraReportModel>>();
               tool.RegisterPageView<IChooseJsonSourcePageView, MyChooseJsonSourcePageView>();
           }
   
           public void CustomizeWizard(JsonEditorId editor, IWizardCustomization<JsonDataSourceModel> tool) {
               tool.RegisterPage<ChooseJsonSourcePage<JsonDataSourceModel>, MyChooseJsonSourcePage<JsonDataSourceModel>>();
               tool.RegisterPageView<IChooseJsonSourcePageView, MyChooseJsonSourcePageView>();
           }
   
           public bool TryCreateDataSource(IDataSourceModel model, out object dataSource, out string dataMember) {
               dataSource = null;
               dataMember = model?.DataMember;
               return false;
           }
   
           public bool TryCreateReport(IDesignerHost designerHost, XtraReportModel model, object dataSource, string dataMember) {
               return false;
           }
       } 
   

   VB.NET

   Public Class MyWizardCustomizationService
       Implements IWizardCustomizationService, IJsonEditorsCustomizationService
   
           Public Sub CustomizeDataSourceWizard(ByVal tool As IWizardCustomization(Of XtraReportModel))
               tool.RegisterPage(Of ChooseJsonSourcePage(Of XtraReportModel), MyChooseJsonSourcePage(Of XtraReportModel))()
               tool.RegisterPageView(Of IChooseJsonSourcePageView, MyChooseJsonSourcePageView)()
           End Sub
   
           Public Sub CustomizeReportWizard(ByVal tool As IWizardCustomization(Of XtraReportModel))
               tool.RegisterPage(Of ChooseJsonSourcePage(Of XtraReportModel), MyChooseJsonSourcePage(Of XtraReportModel))()
               tool.RegisterPageView(Of IChooseJsonSourcePageView, MyChooseJsonSourcePageView)()
           End Sub
   
           Public Sub CustomizeWizard(ByVal editor As JsonEditorId, ByVal tool As IWizardCustomization(Of JsonDataSourceModel))
               tool.RegisterPage(Of ChooseJsonSourcePage(Of JsonDataSourceModel), MyChooseJsonSourcePage(Of JsonDataSourceModel))()
               tool.RegisterPageView(Of IChooseJsonSourcePageView, MyChooseJsonSourcePageView)()
           End Sub
   
           Public Function TryCreateDataSource(ByVal model As IDataSourceModel, <System.Runtime.InteropServices.Out()> ByRef dataSource As Object, <System.Runtime.InteropServices.Out()> ByRef dataMember As String) As Boolean
               dataSource = Nothing
               dataMember = model?.DataMember
               Return False
           End Function
   
           Public Function TryCreateReport(ByVal designerHost As IDesignerHost, ByVal model As XtraReportModel, ByVal dataSource As Object, ByVal dataMember As String) As Boolean
               Return False
           End Function
   End Class 
   

   In the code abode, the MyWizardCustomizationService class implements the IJsonEditorsCustomizationService interface to invoke the customized Specify JSON Data Location wizard page from the context menu.

   

5. Add MyWizardCustomizationService to the DesignMdiController‘s service collection.

   C#

   private void DesignTimeAuthenticationButton_Click(object sender, EventArgs e) {
       var reportDesignTool = new DevExpress.XtraReports.UI.ReportDesignTool(new DevExpress.XtraReports.UI.XtraReport());
       reportDesignTool.DesignForm.DesignMdiController.AddService(typeof(IWizardCustomizationService), new MyWizardCustomizationService());
       reportDesignTool.DesignForm.DesignMdiController.AddService(typeof(IJsonEditorsCustomizationService), new MyWizardCustomizationService());
       reportDesignTool.ShowDesigner();
   }    
   

   VB.NET

   Private Sub DesignTimeAuthenticationButton_Click(ByVal sender As Object, ByVal e As EventArgs)
       Dim reportDesignTool = New DevExpress.XtraReports.UI.ReportDesignTool(New DevExpress.XtraReports.UI.XtraReport())
       reportDesignTool.DesignForm.DesignMdiController.AddService(GetType(IWizardCustomizationService), New MyWizardCustomizationService())
       reportDesignTool.DesignForm.DesignMdiController.AddService(GetType(IJsonEditorsCustomizationService), New MyWizardCustomizationService())
       reportDesignTool.ShowDesigner()
   End Sub
   

Refer to the Wizard Customization Overview topic for more information on how to customize wizard pages.