Class AzureStorageCommandingDependencies

Inheritance

System.Object

AzureStorageCommandingDependencies

Namespace: AzureFromTheTrenches.Commanding.AzureStorage

Assembly: AzureFromTheTrenches.Commanding.AzureStorage.dll

Syntax

public static class AzureStorageCommandingDependencies : object

Methods

AddAzureStorageAuditQueueProcessor(ICommandingDependencyResolverAdapter, CloudQueue, CloudQueue)

Registers the IAzureStorageCommandQueueProcessorFactory interface through which a audit queue processor task can be started

Declaration

public static ICommandingDependencyResolverAdapter AddAzureStorageAuditQueueProcessor(this ICommandingDependencyResolverAdapter dependencyResolver, CloudQueue queue, CloudQueue deadLetterQueue = null)

Parameters

Type	Name	Description
ICommandingDependencyResolverAdapter	dependencyResolver	The dependency resolver
CloudQueue	queue	The queue to dequeue from
CloudQueue	deadLetterQueue	An optional dead letter queue to place items in if errors repeatedly occur in item processing

Returns

Type	Description
ICommandingDependencyResolverAdapter	The dependency resovler

AddAzureStorageCommandAuditing(ICommandingDependencyResolverAdapter, CloudQueue, CloudBlobContainer, IStorageStrategy, AzureStorageAuditorOptions)

Sets up azure storage command auditing for output to a queue. This is best suited for scenarios where there are multiple auditors or storage mechanisms in the audit pipeline as it enables execution of the command dispatch pipeline to rapidly continue but still with a guarantee that the command will be audited.

Generally when configuring this auditor no other auditors are configured - but you can.

Declaration

public static ICommandingDependencyResolverAdapter AddAzureStorageCommandAuditing(this ICommandingDependencyResolverAdapter dependencyResolver, CloudQueue queue, CloudBlobContainer blobContainer = null, IStorageStrategy storageStrategy = null, AzureStorageAuditorOptions options = null)

Parameters

Type	Name	Description
ICommandingDependencyResolverAdapter	dependencyResolver	The dependency resolver
CloudQueue	queue	The queue to audit via
CloudBlobContainer	blobContainer	The blob container to store the payload to. If this is set then the payload is stored before the item is queued, if left null then the payload will be serialized into the queue item. The default setting of null is the more performant and common case, setting the container here is only useful for very large command payloads that won't fit inside a queue item. If the payload is stored in the blob container specified here then there will be no way for downstream auditors to access it from the AuditItem model - it will be null.
IStorageStrategy	storageStrategy
AzureStorageAuditorOptions	options

Returns

Type	Description
ICommandingDependencyResolverAdapter

AddAzureStorageCommandAuditing(ICommandingDependencyResolverAdapter, CloudStorageAccount, CloudBlobContainer, IStorageStrategy, AzureStorageAuditorOptions)

Sets up azure storage command auditing for direct output to tables

Declaration

public static ICommandingDependencyResolverAdapter AddAzureStorageCommandAuditing(this ICommandingDependencyResolverAdapter dependencyResolver, CloudStorageAccount cloudStorageAccount, CloudBlobContainer commandPayloadContainer = null, IStorageStrategy storageStrategy = null, AzureStorageAuditorOptions options = null)

Parameters

Type	Name	Description
ICommandingDependencyResolverAdapter	dependencyResolver	The dependency resolver
CloudStorageAccount	cloudStorageAccount	The cloud storage account to use for storage
CloudBlobContainer	commandPayloadContainer	(Optional) The blob container that
IStorageStrategy	storageStrategy
AzureStorageAuditorOptions	options	Auditor options

Returns

Type	Description
ICommandingDependencyResolverAdapter

AddAzureStorageCommanding(ICommandingDependencyResolverAdapter)

Declaration

public static ICommandingDependencyResolverAdapter AddAzureStorageCommanding(this ICommandingDependencyResolverAdapter dependencyResolver)

Parameters

Type	Name	Description
ICommandingDependencyResolverAdapter	dependencyResolver

Returns

Type	Description
ICommandingDependencyResolverAdapter

AddAzureStorageCommanding<TSerializer>(ICommandingDependencyResolverAdapter)

Declaration

public static ICommandingDependencyResolverAdapter AddAzureStorageCommanding<TSerializer>(this ICommandingDependencyResolverAdapter dependencyResolver)
    where TSerializer : IAzureStorageQueueSerializer

Parameters

Type	Name	Description
ICommandingDependencyResolverAdapter	dependencyResolver

Returns

Type	Description
ICommandingDependencyResolverAdapter

Type Parameters

Name	Description
TSerializer

UseAzureStorageAuditQueueProcessor(ICommandingDependencyResolver, CloudQueue, CloudQueue)

Registers the IAzureStorageCommandQueueProcessorFactory interface through which a audit queue processor task can be started

Declaration

public static ICommandingDependencyResolver UseAzureStorageAuditQueueProcessor(this ICommandingDependencyResolver dependencyResolver, CloudQueue queue, CloudQueue deadLetterQueue = null)

Parameters

Type	Name	Description
ICommandingDependencyResolver	dependencyResolver	The dependency resolver
CloudQueue	queue	The queue to dequeue from
CloudQueue	deadLetterQueue	An optional dead letter queue to place items in if errors repeatedly occur in item processing

Returns

Type	Description
ICommandingDependencyResolver	The dependency resovler

UseAzureStorageCommandAuditing(ICommandingDependencyResolver, CloudQueue, CloudBlobContainer, IStorageStrategy, AzureStorageAuditorOptions)

Sets up azure storage command auditing for output to a queue. This is best suited for scenarios where there are multiple auditors or storage mechanisms in the audit pipeline as it enables execution of the command dispatch pipeline to rapidly continue but still with a guarantee that the command will be audited.

Generally when configuring this auditor no other auditors are configured - but you can.

Declaration

public static ICommandingDependencyResolver UseAzureStorageCommandAuditing(this ICommandingDependencyResolver dependencyResolver, CloudQueue queue, CloudBlobContainer blobContainer = null, IStorageStrategy storageStrategy = null, AzureStorageAuditorOptions options = null)

Parameters

Type	Name	Description
ICommandingDependencyResolver	dependencyResolver	The dependency resolver
CloudQueue	queue	The queue to audit via
CloudBlobContainer	blobContainer	The blob container to store the payload to. If this is set then the payload is stored before the item is queued, if left null then the payload will be serialized into the queue item. The default setting of null is the more performant and common case, setting the container here is only useful for very large command payloads that won't fit inside a queue item. If the payload is stored in the blob container specified here then there will be no way for downstream auditors to access it from the AuditItem model - it will be null.
IStorageStrategy	storageStrategy
AzureStorageAuditorOptions	options

Returns

Type	Description
ICommandingDependencyResolver

UseAzureStorageCommandAuditing(ICommandingDependencyResolver, CloudStorageAccount, CloudBlobContainer, IStorageStrategy, AzureStorageAuditorOptions)

Sets up azure storage command auditing for direct output to tables

Declaration

public static ICommandingDependencyResolver UseAzureStorageCommandAuditing(this ICommandingDependencyResolver dependencyResolver, CloudStorageAccount cloudStorageAccount, CloudBlobContainer commandPayloadContainer = null, IStorageStrategy storageStrategy = null, AzureStorageAuditorOptions options = null)

Parameters

Type	Name	Description
ICommandingDependencyResolver	dependencyResolver	The dependency resolver
CloudStorageAccount	cloudStorageAccount	The cloud storage account to use for storage
CloudBlobContainer	commandPayloadContainer	(Optional) The blob container that
IStorageStrategy	storageStrategy
AzureStorageAuditorOptions	options	Auditor options

Returns

Type	Description
ICommandingDependencyResolver

UseAzureStorageCommanding(ICommandingDependencyResolver)

Declaration

public static ICommandingDependencyResolver UseAzureStorageCommanding(this ICommandingDependencyResolver dependencyResolver)

Parameters

Type	Name	Description
ICommandingDependencyResolver	dependencyResolver

Returns

Type	Description
ICommandingDependencyResolver

UseAzureStorageCommanding<TSerializer>(ICommandingDependencyResolver)

Declaration

public static ICommandingDependencyResolver UseAzureStorageCommanding<TSerializer>(this ICommandingDependencyResolver dependencyResolver)
    where TSerializer : IAzureStorageQueueSerializer

Parameters

Type	Name	Description
ICommandingDependencyResolver	dependencyResolver

Returns

Type	Description
ICommandingDependencyResolver

Type Parameters

Name	Description
TSerializer