This example demonstrates how to provide a report's JSON data source with authentication parameters at runtime. You can see two approaches to provide authentication to the specified Web Service Endpoint:
- Approach 1
You can use a connection string to create a JsonDataSource object. The connection string can include authentication parameters.
In this approach, only the JsonDataSource's connection name is serialized to the report's definition. The JsonDataSource's JsonSource property is not specified. - Approach 2
You can use the UriJsonSource object to specify authentication parameters. Assign this object to the JsonDataSource's JsonSource property.
In this approach, authentication parameters are serialized to the report's definition together with the JsonDataSource's UriJsonSource object.
Files to Review
- MyUriJsonSource.cs (VB: MyUriJsonSource.vb)
- Form1.cs (VB: Form1.vb)
Documentation
Does this example address your development requirements/objectives?
(you will be redirected to DevExpress.com to submit your response)
Example Code
ReportCustomization/MyUriJsonSource.cs(vb)
C#using DevExpress.DataAccess.Json;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Net;
using System.Text;
using System.Threading.Tasks;
using System.Xml.Linq;
using DevExpress.DataAccess.Native;
using System.Security.Cryptography;
using System.IO;
using System.Web.Security;
namespace Xtrareport_json_datasource_with_authorization.ReportCustomization {
public class MyUriJsonSource : UriJsonSource {
public string UserName { get; set; }
[PasswordPropertyText(true)]
public string Password { get; set; }
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;
}
}
}
}
Form1.cs(vb)
C#using DevExpress.DataAccess.Json;
using DevExpress.XtraReports.UI;
using System;
using System.Collections.Generic;
using System.Data.Common;
using System.IO;
using System.Text;
using System.Windows.Forms;
using Xtrareport_json_datasource_with_authorization.ReportCustomization;
namespace Xtrareport_json_datasource_with_authorization
{
public partial class Form1 : Form {
public Form1() {
InitializeComponent();
}
#region CreateReportDataSourceFromConnectionStringButton_Click
private void CreateReportDataSourceFromConnectionStringButton_Click(object sender, EventArgs e) {
// XtraReport1 does not have assigned data sources
var report = new XtraReport1();
// Create JsonDataSource from the specified connection string
var jsonDataSource = CreateReportDataSourceFromConnectionString();
// Retrieve data to populate the Report Designer's Field List
jsonDataSource.Fill();
report.DataSource = jsonDataSource;
report.DataMember = "Customers";
new DevExpress.XtraReports.UI.ReportDesignTool(report).ShowDesigner();
}
#endregion
#region CreateReportDataSourceFromConnectionString
public static JsonDataSource CreateReportDataSourceFromConnectionString() {
JsonDataSource jsonDataSource = new DevExpress.DataAccess.Json.JsonDataSource() {
// The application's configuration file should include the "JsonConnection" connection string
ConnectionName = "JsonConnection"
};
return jsonDataSource;
}
#endregion
#region CreateReportDataSourceWithAuthenticationInCodeButton_Click
private void CreateReportDataSourceWithAuthenticationInCodeButton_Click(object sender, EventArgs e) {
// XtraReport1 does not have assigned data sources
var report = new XtraReport1();
// Create JsonDataSource in code
JsonDataSource jsonDataSource = CreateReportDataSourceWithAuthenticationInCode();
// Retrieve data to populate the Report Designer's Field List
jsonDataSource.Fill();
report.DataSource = jsonDataSource;
report.DataMember = "Customers";
new DevExpress.XtraReports.UI.ReportDesignTool(report).ShowDesigner();
}
#endregion
#region CreateReportDataSourceWithAuthenticationInCode
public static JsonDataSource CreateReportDataSourceWithAuthenticationInCode() {
#endregion
#region CreateReportDataSourceWithAuthenticationInCode_JsonSource
// Create a new UriJsonSource object and configure authentication data in it
var jsonSource = new DevExpress.DataAccess.Json.UriJsonSource();
jsonSource.Uri = new Uri(@"http://northwind.servicestack.net/customers.json");
jsonSource.AuthenticationInfo.Username = "user";
jsonSource.AuthenticationInfo.Password = "pwd";
jsonSource.HeaderParameters.Add(new HeaderParameter("MyAuthHeader1", "secretToken1"));
jsonSource.HeaderParameters.Add(new HeaderParameter("MyAuthHeader2", "secretToken2"));
jsonSource.QueryParameters.Add(new QueryParameter("id", "123456"));
jsonSource.QueryParameters.Add(new QueryParameter("name", "MyName"));
#endregion
#region CreateReportDataSourceWithAuthenticationInCode_JsonDataSource
// Create a JsonDataSource object and assign the UriJsonSource object to it
var jsonDataSource = new DevExpress.DataAccess.Json.JsonDataSource() {
JsonSource = jsonSource
};
return jsonDataSource;
#endregion
#region CreateReportDataSourceWithAuthenticationInCode_EndClass
}
#endregion
}
#region ConvertReportWithMyUriJsonSourceTo191
public static class JsonDatasourceAuthorization_Example {
public static string ConvertReportWithMyUriJsonSourceTo191(string repxContent, out List<string> connectionString) {
var report = new XtraReport();
using(var ms = new MemoryStream(Encoding.UTF8.GetBytes(repxContent))) {
report.LoadLayoutFromXml(ms);
}
connectionString = new List<string>();
int i = 0;
foreach(var component in report.ComponentStorage) {
var jsonDS = (component as DevExpress.DataAccess.Json.JsonDataSource);
var jsonSource = (jsonDS?.JsonSource as MyUriJsonSource);
if(jsonSource != null) {
i++;
jsonDS.ConnectionName = string.Format("newJsonConnection_{0}{1}", report.Name, i.ToString());
var builder = new DbConnectionStringBuilder();
builder.Add("Uri", jsonSource.Uri.OriginalString);
builder.Add("UserName", jsonSource.UserName);
builder.Add("Password", jsonSource.Password);
connectionString.Add(string.Format("<add name=\"{0}\" connectionString=\"{1}\" providerName=\"JsonSourceProvider\" />",
jsonDS.ConnectionName, builder.ConnectionString));
jsonDS.JsonSource = null;
}
}
using(var ms = new MemoryStream()) {
report.SaveLayoutToXml(ms);
ms.Position = 0;
StreamReader reader = new StreamReader(ms);
return reader.ReadToEnd();
}
}
}
#endregion
}