Interface IStorageServiceFactory

Defines the interface for an storage service factory.

Namespace: DNVGL.One.Compute.StorageLibrary.Factory

Assembly: DNVGL.One.Compute.StorageLibrary.dll

Syntax

public interface IStorageServiceFactory

Methods

CreateDynamicWorkMonitorFactory(String)

Create the dynamic work monitor factory.

Declaration

IDynamicWorkMonitorFactory CreateDynamicWorkMonitorFactory(string storageConnectionString)

Parameters

Type	Name	Description
System.String	storageConnectionString	Storage connection string.

Returns

Type	Description
IDynamicWorkMonitorFactory	The dynamic work monitor factory.

CreateJobPropertiesService(String, String)

Will return an instance of the job properties storage service IJobPropertiesService based upon the supplied connection string.

Declaration

IJobPropertiesService CreateJobPropertiesService(string globalStorageConnectionString, string localStorageConnectionString)

Parameters

Type	Name	Description
System.String	globalStorageConnectionString	The global storage connection string.
System.String	localStorageConnectionString	The local storage connection string.

Returns

Type	Description
IJobPropertiesService	A job properties storage service instance.

CreateJobStatusService(String, String)

Will return an instance of the job status storage service IJobStatusService based upon the supplied connection string.

Declaration

IJobStatusService CreateJobStatusService(string jobStatusStorageConnectionString, string workItemStatusStorageConnectionString = null)

Parameters

Type	Name	Description
System.String	jobStatusStorageConnectionString	The connection string to the job status storage.
System.String	workItemStatusStorageConnectionString	The connection string to the work item status storage.

Returns

Type	Description
IJobStatusService	A job status storage service instance.

Remarks

If workItemStatusStorageConnectionString is null or empty, the jobStatusStorageConnectionString will be used to connect to work item storage.

CreateMessageQueue<T>(String, Boolean, Boolean)

Create a message queue.

Declaration

IMessageQueue<T> CreateMessageQueue<T>(string messageQueue, bool createIfNotExists = true, bool willReceiveMessages = true)
    where T : class

Parameters

Type	Name	Description
System.String	messageQueue	Message queue name.
System.Boolean	createIfNotExists	Creates message queue if it doesn't exist.
System.Boolean	willReceiveMessages	True if the queue will be used to receive messages.

Returns

Type	Description
IMessageQueue<T>	Message queue.

Type Parameters

Name	Description
T	Message type.

CreateMessageSenderService(String)

Will return an instance of the message sender service IMessageSender<T> based upon the supplied connection string.

Declaration

IMessageSender<ScheduleWorkMessage> CreateMessageSenderService(string storageConnectionString)

Parameters

Type	Name	Description
System.String	storageConnectionString	The connection string to the storage data source.

Returns

Type	Description
IMessageSender<ScheduleWorkMessage>	A message sender service instance.

CreateResultStorageService(String)

Will return an instance of the result storage service IFlowModelStorageService<T> based upon the supplied connection string.

Declaration

IFlowModelStorageService<Result> CreateResultStorageService(string storageConnectionString)

Parameters

Type	Name	Description
System.String	storageConnectionString	The connection string to the storage data source.

Returns

Type	Description
IFlowModelStorageService<Result>	A results storage service instance.

CreateWorkItemStatusService(String)

Will return an instance of the work item status storage service IWorkItemStatusService based upon the supplied connection string.

Declaration

IWorkItemStatusService CreateWorkItemStatusService(string storageConnectionString)

Parameters

Type	Name	Description
System.String	storageConnectionString	The connection string to the storage data source.

Returns

Type	Description
IWorkItemStatusService	A work item status storage service instance.

CreateWorkItemStorageService(String)

Will return an instance of the work item storage service IFlowModelStorageService<T> based upon the supplied connection string.

Declaration

IFlowModelStorageService<WorkItem> CreateWorkItemStorageService(string storageConnectionString)

Parameters

Type	Name	Description
System.String	storageConnectionString	The connection string to the storage data source.

Returns

Type	Description
IFlowModelStorageService<WorkItem>	A work item storage service instance.

DeleteMessageQueue(String)

Delete the message queue.

Declaration

void DeleteMessageQueue(string messageQueue)

Parameters

Type	Name	Description
System.String	messageQueue	Message queue name.

GetFileTransferService(WorkUnit)

Get the file transfer service.

Declaration

IFileTransferService GetFileTransferService(WorkUnit workUnit)

Parameters

Type	Name	Description
WorkUnit	workUnit	Work unit.

Returns

Type	Description
IFileTransferService	A IFileTransferService.