Skip to content

Commit 3a8c5ad

Browse files
WilliamBZAWilliamBZA
authored
Merge pull request #7131 from Particular/obsolete-databus
Obsolete databus API
2 parents 6749a2a + d9caa9d commit 3a8c5ad

16 files changed

+315
-10
lines changed

‎src/NServiceBus.Core.Tests/ApprovalFiles/APIApprovals.ApproveNServiceBus.approved.txt

Lines changed: 135 additions & 0 deletions
Large diffs are not rendered by default.

‎src/NServiceBus.Core.Tests/ApprovalFiles/NullableAnnotations.ApproveNullableTypes.approved.txt

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ NServiceBus.Configuration.AdvancedExtensibility.AdvancedExtensibilityExtensions
1111
NServiceBus.ConfigureAudit
1212
NServiceBus.ConfigureCriticalErrorAction
1313
NServiceBus.ConfigureError
14-
NServiceBus.ConfigureFileShareDataBus
1514
NServiceBus.ConfigureLicenseExtensions
1615
NServiceBus.ConfigurePurging
1716
NServiceBus.ConnectorContextExtensions
@@ -24,11 +23,6 @@ NServiceBus.ConversationIdStrategyContext
2423
NServiceBus.ConversationRoutingExtensions
2524
NServiceBus.CriticalError
2625
NServiceBus.CriticalErrorContext
27-
NServiceBus.DataBus.DataBusExtensions
28-
NServiceBus.DataBus.DataBusExtensions`1
29-
NServiceBus.DataBus.IDataBus
30-
NServiceBus.DataBus.IDataBusSerializer
31-
NServiceBus.DataBusProperty`1
3226
NServiceBus.DateTimeOffsetHelper
3327
NServiceBus.DefaultRecoverabilityPolicy
3428
NServiceBus.DelayedDeliveryOptionExtensions
@@ -53,7 +47,6 @@ NServiceBus.Faults.FaultsHeaderKeys
5347
NServiceBus.Faults.ImmediateRetryMessage
5448
NServiceBus.Features.Audit
5549
NServiceBus.Features.AutoSubscribe
56-
NServiceBus.Features.DataBus
5750
NServiceBus.Features.Feature
5851
NServiceBus.Features.FeatureConfigurationContext
5952
NServiceBus.Features.Outbox
@@ -70,7 +63,6 @@ NServiceBus.Hosting.Helpers.AssemblyScannerResults
7063
NServiceBus.Hosting.Helpers.SkippedFile
7164
NServiceBus.Hosting.HostInformation
7265
NServiceBus.ICriticalErrorContext
73-
NServiceBus.IDataBusProperty
7466
NServiceBus.IDistributionPolicy
7567
NServiceBus.IMessageConvention
7668
NServiceBus.IMessageCreator
@@ -211,7 +203,6 @@ NServiceBus.StartupDiagnosticEntries
211203
NServiceBus.StaticHeadersConfigExtensions
212204
NServiceBus.SubscriptionMigrationModeSettings
213205
NServiceBus.Support.RuntimeEnvironment
214-
NServiceBus.SystemJsonDataBusSerializer
215206
NServiceBus.TimeToBeReceivedAttribute
216207
NServiceBus.TimeToBeReceivedConventionExtensions
217208
NServiceBus.Transport.DispatchProperties
@@ -250,6 +241,5 @@ NServiceBus.Unicast.Subscriptions.MessageDrivenSubscriptions.ISubscriptionStorag
250241
NServiceBus.Unicast.Subscriptions.MessageDrivenSubscriptions.Subscriber
251242
NServiceBus.Unicast.Subscriptions.MessageType
252243
NServiceBus.UnitOfWorkSettingsExtensions
253-
NServiceBus.UseDataBusExtensions
254244
NServiceBus.XmlSerializationExtensions
255245
NServiceBus.XmlSerializer

‎src/NServiceBus.Core/Conventions/Conventions.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,10 @@ public bool IsCommandType(Type t)
144144
/// <summary>
145145
/// Returns true if the given property should be send via the DataBus.
146146
/// </summary>
147+
[ObsoleteEx(
148+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
149+
RemoveInVersion = "11",
150+
TreatAsErrorFromVersion = "10")]
147151
public bool IsDataBusProperty(PropertyInfo property)
148152
{
149153
ArgumentNullException.ThrowIfNull(property);

‎src/NServiceBus.Core/Conventions/ConventionsBuilder.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ public ConventionsBuilder DefiningEventsAs(Func<Type, bool> definesEventType)
5151
/// <summary>
5252
/// Sets the function to be used to evaluate whether a property should be sent via the DataBus or not.
5353
/// </summary>
54+
[ObsoleteEx(
55+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
56+
RemoveInVersion = "11",
57+
TreatAsErrorFromVersion = "10")]
5458
public ConventionsBuilder DefiningDataBusPropertiesAs(Func<PropertyInfo, bool> definesDataBusProperty)
5559
{
5660
ArgumentNullException.ThrowIfNull(definesDataBusProperty);

‎src/NServiceBus.Core/DataBus/ConfigureFileShareDataBus.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ public static class ConfigureFileShareDataBus
1414
/// <param name="config">The configuration object.</param>
1515
/// <param name="basePath">The location to which to write/read serialized properties for the databus.</param>
1616
/// <returns>The configuration.</returns>
17+
[ObsoleteEx(
18+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
19+
RemoveInVersion = "11",
20+
TreatAsErrorFromVersion = "10")]
1721
public static DataBusExtensions<FileShareDataBus> BasePath(this DataBusExtensions<FileShareDataBus> config, string basePath)
1822
{
1923
ArgumentNullException.ThrowIfNull(config);

‎src/NServiceBus.Core/DataBus/DataBus.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ namespace NServiceBus.Features;
1212
/// <summary>
1313
/// Used to configure the databus.
1414
/// </summary>
15+
[ObsoleteEx(
16+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
17+
RemoveInVersion = "11",
18+
TreatAsErrorFromVersion = "10")]
1519
public class DataBus : Feature
1620
{
1721
internal DataBus()

‎src/NServiceBus.Core/DataBus/DataBusDefinition.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,18 @@
55
/// <summary>
66
/// Defines a databus that can be used by NServiceBus.
77
/// </summary>
8+
[ObsoleteEx(
9+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
10+
RemoveInVersion = "11",
11+
TreatAsErrorFromVersion = "10")]
812
public abstract class DataBusDefinition
913
{
1014
/// <summary>
1115
/// The feature to enable when this databus is selected.
1216
/// </summary>
17+
[ObsoleteEx(
18+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
19+
RemoveInVersion = "11",
20+
TreatAsErrorFromVersion = "10")]
1321
protected internal abstract Type ProvidedByFeature();
1422
}

‎src/NServiceBus.Core/DataBus/DataBusExtensions.cs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,19 @@
1010
/// This class provides implementers of databus with an extension mechanism for custom settings via extension methods.
1111
/// </summary>
1212
/// <typeparam name="T">The databus definition eg <see cref="FileShareDataBus" />.</typeparam>
13+
[ObsoleteEx(
14+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
15+
RemoveInVersion = "11",
16+
TreatAsErrorFromVersion = "10")]
1317
public class DataBusExtensions<T> : DataBusExtensions where T : DataBusDefinition
1418
{
1519
/// <summary>
1620
/// Default constructor.
1721
/// </summary>
22+
[ObsoleteEx(
23+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
24+
RemoveInVersion = "11",
25+
TreatAsErrorFromVersion = "10")]
1826
public DataBusExtensions(SettingsHolder settings)
1927
: base(settings)
2028
{
@@ -24,11 +32,19 @@ public DataBusExtensions(SettingsHolder settings)
2432
/// <summary>
2533
/// This class provides implementers of databus with an extension mechanism for custom settings via extension methods.
2634
/// </summary>
35+
[ObsoleteEx(
36+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
37+
RemoveInVersion = "11",
38+
TreatAsErrorFromVersion = "10")]
2739
public class DataBusExtensions : ExposeSettings
2840
{
2941
/// <summary>
3042
/// Default constructor.
3143
/// </summary>
44+
[ObsoleteEx(
45+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
46+
RemoveInVersion = "11",
47+
TreatAsErrorFromVersion = "10")]
3248
public DataBusExtensions(SettingsHolder settings)
3349
: base(settings)
3450
{
@@ -37,6 +53,10 @@ public DataBusExtensions(SettingsHolder settings)
3753
/// <summary>
3854
/// Configures additional deserializers to be considered when processing data bus properties. Can be called multiple times.
3955
/// </summary>
56+
[ObsoleteEx(
57+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
58+
RemoveInVersion = "11",
59+
TreatAsErrorFromVersion = "10")]
4060
public DataBusExtensions AddDeserializer<TSerializer>() where TSerializer : IDataBusSerializer, new()
4161
{
4262
var serializer = (TSerializer)Activator.CreateInstance(typeof(TSerializer));
@@ -47,6 +67,10 @@ public DataBusExtensions(SettingsHolder settings)
4767
/// <summary>
4868
/// Configures additional deserializers to be considered when processing data bus properties. Can be called multiple times.
4969
/// </summary>
70+
[ObsoleteEx(
71+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
72+
RemoveInVersion = "11",
73+
TreatAsErrorFromVersion = "10")]
5074
public DataBusExtensions AddDeserializer<TSerializer>(TSerializer serializer) where TSerializer : IDataBusSerializer
5175
{
5276
ArgumentNullException.ThrowIfNull(serializer);

‎src/NServiceBus.Core/DataBus/DataBusProperty.cs

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,46 +8,78 @@
88
/// Default implementation for <see cref="IDataBusProperty" />.
99
/// </summary>
1010
/// <typeparam name="T">Type of data to store in <see cref="IDataBusProperty" />.</typeparam>
11+
[ObsoleteEx(
12+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
13+
RemoveInVersion = "11",
14+
TreatAsErrorFromVersion = "10")]
1115
public class DataBusProperty<T> : IDataBusProperty where T : class
1216
{
1317
/// <summary>
1418
/// Initializes a <see cref="DataBusProperty{T}" /> with no value set.
1519
/// </summary>
20+
[ObsoleteEx(
21+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
22+
RemoveInVersion = "11",
23+
TreatAsErrorFromVersion = "10")]
1624
public DataBusProperty() { }
1725

1826
/// <summary>
1927
/// Initializes a <see cref="DataBusProperty{T}" /> with the <paramref name="value" />.
2028
/// </summary>
2129
/// <param name="value">The value to initialize with.</param>
30+
[ObsoleteEx(
31+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
32+
RemoveInVersion = "11",
33+
TreatAsErrorFromVersion = "10")]
2234
public DataBusProperty(T value) => SetValue(value);
2335

2436
/// <summary>
2537
/// The value.
2638
/// </summary>
2739
[JsonIgnore]
2840
[XmlIgnore]
41+
[ObsoleteEx(
42+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
43+
RemoveInVersion = "11",
44+
TreatAsErrorFromVersion = "10")]
2945
public T Value { get; private set; }
3046

3147
/// <summary>
3248
/// The property <see cref="Type" />.
3349
/// </summary>
3450
[JsonIgnore]
51+
[ObsoleteEx(
52+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
53+
RemoveInVersion = "11",
54+
TreatAsErrorFromVersion = "10")]
3555
public Type Type { get; } = typeof(T);
3656

3757
/// <summary>
3858
/// The <see cref="IDataBusProperty" /> key.
3959
/// </summary>
60+
[ObsoleteEx(
61+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
62+
RemoveInVersion = "11",
63+
TreatAsErrorFromVersion = "10")]
4064
public string Key { get; set; }
4165

4266
/// <summary>
4367
/// <code>true</code> if <see cref="IDataBusProperty" /> has a value.
4468
/// </summary>
69+
[ObsoleteEx(
70+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
71+
RemoveInVersion = "11",
72+
TreatAsErrorFromVersion = "10")]
4573
public bool HasValue { get; set; }
4674

4775
/// <summary>
4876
/// Sets the value for <see cref="IDataBusProperty" />.
4977
/// </summary>
5078
/// <param name="valueToSet">The value to set.</param>
79+
[ObsoleteEx(
80+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
81+
RemoveInVersion = "11",
82+
TreatAsErrorFromVersion = "10")]
5183
public void SetValue(object valueToSet)
5284
{
5385
Value = valueToSet as T;
@@ -58,5 +90,9 @@ public void SetValue(object valueToSet)
5890
/// Gets the value of the <see cref="IDataBusProperty" />.
5991
/// </summary>
6092
/// <returns>The value.</returns>
93+
[ObsoleteEx(
94+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
95+
RemoveInVersion = "11",
96+
TreatAsErrorFromVersion = "10")]
6197
public object GetValue() => Value;
6298
}

‎src/NServiceBus.Core/DataBus/FileShareDataBus.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,19 @@ namespace NServiceBus;
77
/// <summary>
88
/// Base class for data bus definitions.
99
/// </summary>
10+
[ObsoleteEx(
11+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
12+
RemoveInVersion = "11",
13+
TreatAsErrorFromVersion = "10")]
1014
public class FileShareDataBus : DataBusDefinition
1115
{
1216
/// <summary>
1317
/// The feature to enable when this databus is selected.
1418
/// </summary>
19+
[ObsoleteEx(
20+
Message = "The DataBus feature has been released as a dedicated package, 'NServiceBus.ClaimCheck.DataBus'",
21+
RemoveInVersion = "11",
22+
TreatAsErrorFromVersion = "10")]
1523
protected internal override Type ProvidedByFeature()
1624
{
1725
return typeof(DataBusFileBased);

0 commit comments

Comments
 (0)