Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

PersistenceProvider Class

.NET Framework 4

The abstract base class from which all durable service persistence providers are derived.

System.Object
  System.ServiceModel.Channels.CommunicationObject
    System.ServiceModel.Persistence.PersistenceProvider
      System.ServiceModel.Persistence.LockingPersistenceProvider

Namespace:  System.ServiceModel.Persistence
Assembly:  System.WorkflowServices (in System.WorkflowServices.dll)
C#
C++
F#
VB
Copy 
public abstract class PersistenceProvider : CommunicationObject

The PersistenceProvider type exposes the following members.

  Name Description
Protected method PersistenceProvider When implemented in a derived class, initializes a new instance of the PersistenceProvider class.
Top
  Name Description
Protected property DefaultCloseTimeout When overridden in a derived class, gets the default interval of time provided for a close operation to complete. (Inherited from CommunicationObject.)
Protected property DefaultOpenTimeout When overridden in a derived class, gets the default interval of time provided for an open operation to complete. (Inherited from CommunicationObject.)
Public property Id Represents the Guid associated with this instance.
Protected property IsDisposed Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Public property State Gets a value that indicates the current state of the communication object. (Inherited from CommunicationObject.)
Protected property ThisLock Gets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject.)
Top
  Name Description
Public method Abort Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject.)
Public method BeginClose(AsyncCallback, Object) Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public method BeginClose(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject.)
Public method BeginCreate When implemented in a derived class, represents the beginning of the Create phase. The Create phase occurs when service instance records are first created in the persistence store.
Public method BeginDelete When implemented in a derived class, represents the beginning of the Delete phase. The Delete phase occurs when service state data is permanently deleted from the persistence store.
Public method BeginLoad When implemented in a derived class, represents the beginning of the Load phase. The Load phase occurs when state data is loaded into the persistence provider from the persistence store.
Public method BeginLoadIfChanged When implemented in a derived class, represents the beginning of the LoadIfChanged phase. The LoadIfChanged phase occurs when state data is loaded into the persistence provider from the persistence store, and the state data in the persistence store has been changed.
Public method BeginOpen(AsyncCallback, Object) Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public method BeginOpen(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject.)
Public method BeginUpdate When implemented in a derived class, represents the beginning of the Update phase. The Update phase occurs when service state data is updated in the persistence store.
Public method Close() Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject.)
Public method Close(TimeSpan) Causes a communication object to transition from its current state into the closed state within a specified interval of time. (Inherited from CommunicationObject.)
Public method Create When implemented in a derived class, creates a service state record in the persistence store.
Public method Delete When implemented in a derived class, permanently deletes service state information from the persistence store.
Public method EndClose Completes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public method EndCreate When implemented in a derived class, represents the end of the Create phase. The Create phase occurs when service state records are first created in the persistence store.
Public method EndDelete When implemented in a derived class, represents the end of the Delete phase. The Delete phase occurs when state data is permanently deleted from the persistence store.
Public method EndLoad When implemented in a derived class, represents the end of the Load phase. The Load phase occurs when state data is loaded into the persistence provider from the persistence store.
Public method EndLoadIfChanged When implemented in a derived class, represents the end of the LoadIfChanged phase. The LoadIfChanged phase occurs when state data is loaded into the persistence provider from the persistence store, and the state data in the persistence store has been changed.
Public method EndOpen Completes an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public method EndUpdate Represents the end of the Update phase. The Update phase occurs when service state records are updated in the persistence store.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Fault Causes a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GetCommunicationObjectType Gets the type of communication object. (Inherited from CommunicationObject.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Load When implemented in a derived class, loads service state information from the persistence store.
Public method LoadIfChanged When implemented in a derived class, loads service state information from the persistence store if that data has been changed.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnAbort Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation. (Inherited from CommunicationObject.)
Protected method OnBeginClose Inserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation. (Inherited from CommunicationObject.)
Protected method OnBeginOpen Inserts processing on a communication object after it transitions to the opening state due to the invocation of an asynchronous open operation. (Inherited from CommunicationObject.)
Protected method OnClose Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation. (Inherited from CommunicationObject.)
Protected method OnClosed Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected method OnClosing Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected method OnEndClose Completes an asynchronous operation on the close of a communication object. (Inherited from CommunicationObject.)
Protected method OnEndOpen Completes an asynchronous operation on the open of a communication object. (Inherited from CommunicationObject.)
Protected method OnFaulted Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation. (Inherited from CommunicationObject.)
Protected method OnOpen Inserts processing on a communication object after it transitions into the opening state which must complete within a specified interval of time. (Inherited from CommunicationObject.)
Protected method OnOpened Invoked during the transition of a communication object into the opened state. (Inherited from CommunicationObject.)
Protected method OnOpening Invoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject.)
Public method Open() Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject.)
Public method Open(TimeSpan) Causes a communication object to transition from the created state into the opened state within a specified interval of time. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposed Throws an exception if the communication object is disposed. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrImmutable Throws an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrNotOpen Throws an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Update When implemented in a derived class, updates service state records in the persistence store.
Top
  Name Description
Public event Closed Occurs when a communication object transitions into the closed state. (Inherited from CommunicationObject.)
Public event Closing Occurs when a communication object transitions into the closing state. (Inherited from CommunicationObject.)
Public event Faulted Occurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject.)
Public event Opened Occurs when a communication object transitions into the opened state. (Inherited from CommunicationObject.)
Public event Opening Occurs when a communication object transitions into the opening state. (Inherited from CommunicationObject.)
Top

Users can create classes derived from this type to create durable service persistence providers that use custom persistence stores, such as third-party databases, the file system, or storage systems accessed remotely. To create a system-provided implementation of this type that uses Microsoft SQL Server as a persistence store, see SqlPersistenceProviderFactory.

Note Note

When creating persistence provider implementations, it is important to maintain the thread's original identity in the new provider's methods (such as Load. Otherwise, security loopholes could be created, because operations would then run under the wrong identity.

For an implementation of this type that uses the file system as a persistence store, see the FilePersistenceProviderFactory.cs file in the DurableServiceFactory SDK sample.

.NET Framework

Supported in: 4, 3.5

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ