You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
290 lines
9.5 KiB
290 lines
9.5 KiB
' ///////////////////////////////////////////////////////////////////////////
|
|
' // Description: Connection Provider class for Database connection sharing
|
|
' // Generated by LLBLGen v1.21.2003.712 Final on: Dienstag, 1. Januar 2013, 19:36:38
|
|
' // This class implements IDisposable.
|
|
' ///////////////////////////////////////////////////////////////////////////
|
|
Imports System
|
|
Imports System.Configuration
|
|
Imports System.Data
|
|
Imports System.Data.SqlClient
|
|
Imports System.Collections
|
|
|
|
Namespace DB
|
|
' /// <summary>
|
|
' /// Purpose: provides a SqlConnection object which can be shared among data-access tier objects
|
|
' /// to provide a way to do ADO.NET transaction coding without the hassling with SqlConnection objects
|
|
' /// on a high level.
|
|
' /// </summary>
|
|
Public Class clsConnectionProvider
|
|
Implements IDisposable
|
|
|
|
#Region " Class Member Declarations "
|
|
|
|
Private m_scoDBConnection As SqlConnection
|
|
Private m_bIsTransactionPending, m_bIsDisposed As Boolean
|
|
Private m_stCurrentTransaction As SqlTransaction
|
|
Private m_alSavePoints As ArrayList
|
|
|
|
#End Region
|
|
|
|
|
|
Public Sub New()
|
|
' // Init the class
|
|
InitClass()
|
|
End Sub
|
|
|
|
|
|
' /// <summary>
|
|
' /// Purpose: Implements the IDispose' method Dispose.
|
|
' /// </summary>
|
|
Overloads Public Sub Dispose() Implements IDisposable.Dispose
|
|
Dispose(True)
|
|
GC.SuppressFinalize(Me)
|
|
End Sub
|
|
|
|
|
|
' /// <summary>
|
|
' /// Purpose: Implements the Dispose functionality.
|
|
' /// </summary>
|
|
Overridable Overloads Protected Sub Dispose(ByVal bIsDisposing As Boolean)
|
|
' // Check to see if Dispose has already been called.
|
|
If Not m_bIsDisposed Then
|
|
If bIsDisposing Then
|
|
' // Dispose managed resources.
|
|
If Not (m_stCurrentTransaction Is Nothing) Then
|
|
m_stCurrentTransaction.Dispose()
|
|
m_stCurrentTransaction = Nothing
|
|
End If
|
|
If Not (m_scoDBConnection Is Nothing) Then
|
|
' // closing the connection will abort (rollback) any pending transactions
|
|
m_scoDBConnection.Close()
|
|
m_scoDBConnection.Dispose()
|
|
m_scoDBConnection = Nothing
|
|
End If
|
|
End If
|
|
End If
|
|
m_bIsDisposed = True
|
|
End Sub
|
|
|
|
|
|
' /// <summary>
|
|
' /// Purpose: Initializes class members.
|
|
' /// </summary>
|
|
Private Sub InitClass()
|
|
' // Create all the objects and initialize other members.
|
|
m_scoDBConnection = new SqlConnection()
|
|
m_bIsDisposed = False
|
|
m_stCurrentTransaction = Nothing
|
|
m_bIsTransactionPending = False
|
|
m_alSavePoints = new ArrayList()
|
|
End Sub
|
|
|
|
|
|
' /// <summary>
|
|
' /// Purpose: Opens the connection object.
|
|
' /// </summary>
|
|
' /// <returns>True, if succeeded, otherwise an Exception exception is thrown.</returns>
|
|
Public Function OpenConnection() As Boolean
|
|
Try
|
|
If (m_scoDBConnection.State And ConnectionState.Open) > 0 Then
|
|
' // It's already open.
|
|
Throw New Exception("OpenConnection::Connection is already open.")
|
|
End If
|
|
m_scoDBConnection.Open()
|
|
m_bIsTransactionPending = False
|
|
m_alSavePoints.Clear()
|
|
Return True
|
|
Catch ex As Exception
|
|
' // bubble exception
|
|
Throw ex
|
|
End Try
|
|
End Function
|
|
|
|
|
|
' /// <summary>
|
|
' /// Purpose: Starts a new ADO.NET transaction using the open connection object of this class.
|
|
' /// </summary>
|
|
' /// <param name="sTransactionName">Name of the transaction to start</param>
|
|
' /// <returns>True, if transaction is started correctly, otherwise an Exception exception is thrown</returns>
|
|
Public Function BeginTransaction(sTransactionName As String) As Boolean
|
|
Try
|
|
If m_bIsTransactionPending Then
|
|
' // no nested transactions allowed.
|
|
Throw New Exception("BeginTransaction::Already transaction pending. Nesting not allowed")
|
|
End If
|
|
If (m_scoDBConnection.State And ConnectionState.Open) = 0 Then
|
|
' // no open connection
|
|
Throw New Exception("BeginTransaction::Connection is not open.")
|
|
End If
|
|
' // begin the transaction and store the transaction object.
|
|
m_stCurrentTransaction = m_scoDBConnection.BeginTransaction(IsolationLevel.ReadCommitted, sTransactionName)
|
|
m_bIsTransactionPending = True
|
|
Return True
|
|
Catch ex As Exception
|
|
' // bubble exception
|
|
Throw ex
|
|
End Try
|
|
End Function
|
|
|
|
|
|
' /// <summary>
|
|
' /// Purpose: Commits a pending transaction on the open connection object of this class.
|
|
' /// </summary>
|
|
' /// <returns>True, if commit was succesful, or an Exception exception is thrown</returns>
|
|
Public Function CommitTransaction() As Boolean
|
|
Try
|
|
If Not m_bIsTransactionPending Then
|
|
' // no transaction pending
|
|
Throw New Exception("CommitTransaction::No transaction pending.")
|
|
End If
|
|
If (m_scoDBConnection.State And ConnectionState.Open) = 0 Then
|
|
' // no open connection
|
|
Throw New Exception("CommitTransaction::Connection is not open.")
|
|
End if
|
|
' // commit the transaction
|
|
m_stCurrentTransaction.Commit()
|
|
m_bIsTransactionPending = False
|
|
m_stCurrentTransaction.Dispose()
|
|
m_stCurrentTransaction = Nothing
|
|
m_alSavePoints.Clear()
|
|
Return True
|
|
Catch ex As Exception
|
|
' // bubble exception
|
|
Throw ex
|
|
End Try
|
|
End Function
|
|
|
|
|
|
' /// <summary>
|
|
' /// Purpose: Rolls back a pending transaction on the open connection object of this class,
|
|
' /// or rolls back to the savepoint with the given name. Savepoints are created with SaveTransaction().
|
|
' /// </summary>
|
|
' /// <param name="sTransactionToRollback">Name of transaction to roll back. Can be name of savepoint</param>
|
|
' /// <returns>True, if rollback was succesful, or an Exception exception is thrown</returns>
|
|
Public Function RollbackTransaction(sTransactionToRollback As String) As Boolean
|
|
Try
|
|
If Not m_bIsTransactionPending Then
|
|
' // no transaction pending
|
|
Throw New Exception("RollbackTransaction::No transaction pending.")
|
|
End If
|
|
If (m_scoDBConnection.State And ConnectionState.Open) = 0 Then
|
|
' // no open connection
|
|
Throw New Exception("RollbackTransaction::Connection is not open.")
|
|
End If
|
|
' // rollback the transaction
|
|
m_stCurrentTransaction.Rollback(sTransactionToRollback)
|
|
' // if this wasn't a savepoint, we've rolled back the complete transaction, so we
|
|
' // can clean it up.
|
|
If Not m_alSavePoints.Contains(sTransactionToRollback) Then
|
|
' // it's not a savepoint
|
|
m_bIsTransactionPending = False
|
|
m_stCurrentTransaction.Dispose()
|
|
m_stCurrentTransaction = Nothing
|
|
m_alSavePoints.Clear()
|
|
End If
|
|
Return True
|
|
Catch ex As Exception
|
|
' // bubble exception
|
|
Throw ex
|
|
End Try
|
|
End Function
|
|
|
|
|
|
' /// <summary>
|
|
' /// Purpose: Saves a pending transaction on the open connection object of this class to a 'savepoint'
|
|
' /// with the given name.
|
|
' /// When a rollback is issued, the caller can rollback to this savepoint or roll back the complete transaction.
|
|
' /// </summary>
|
|
' /// <param name="sSavePointName">Name of the savepoint to store the current transaction under.</param>
|
|
' /// <returns>True, if save was succesful, or an Exception exception is thrown</returns>
|
|
Public Function SaveTransaction(sSavePointName As String) As Boolean
|
|
Try
|
|
If Not m_bIsTransactionPending Then
|
|
' // no transaction pending
|
|
Throw New Exception("SaveTransaction::No transaction pending.")
|
|
End If
|
|
If (m_scoDBConnection.State And ConnectionState.Open) = 0 Then
|
|
' // no open connection
|
|
Throw New Exception("SaveTransaction::Connection is not open.")
|
|
End If
|
|
' // save the transaction
|
|
m_stCurrentTransaction.Save(sSavePointName)
|
|
' // Store the savepoint in the list.
|
|
m_alSavePoints.Add(sSavePointName)
|
|
Return True
|
|
Catch ex As Exception
|
|
' // bubble exception
|
|
Throw ex
|
|
End Try
|
|
End Function
|
|
|
|
|
|
' /// <summary>
|
|
' /// Purpose: Closes the open connection. Depending on bCommitPendingTransactions, a pending
|
|
' /// transaction is commited, or aborted.
|
|
' /// </summary>
|
|
' /// <param name="bCommitPendingTransaction">Flag for what to do when a transaction is still pending. True
|
|
' /// will commit the current transaction, False will abort (rollback) the complete current transaction.</param>
|
|
' /// <returns>True, if close was succesful, False if connection was already closed, or an Exception exception is thrown when
|
|
' /// an error occurs</returns>
|
|
Public Function CloseConnection(bCommitPendingTransaction As Boolean) As Boolean
|
|
Try
|
|
If (m_scoDBConnection.State And ConnectionState.Open) = 0 Then
|
|
' // No open connection
|
|
Return False
|
|
End If
|
|
If m_bIsTransactionPending Then
|
|
If bCommitPendingTransaction Then
|
|
' // Commit the pending transaction
|
|
m_stCurrentTransaction.Commit()
|
|
Else
|
|
' // Rollback the pending transaction
|
|
m_stCurrentTransaction.Rollback()
|
|
End If
|
|
m_bIsTransactionPending = False
|
|
m_stCurrentTransaction.Dispose()
|
|
m_stCurrentTransaction = Nothing
|
|
m_alSavePoints.Clear()
|
|
End If
|
|
' // close the connection
|
|
m_scoDBConnection.Close()
|
|
Return True
|
|
Catch ex As Exception
|
|
' // bubble exception
|
|
Throw ex
|
|
End Try
|
|
End Function
|
|
|
|
|
|
#Region " Class Property Declarations "
|
|
|
|
Public ReadOnly Property stCurrentTransaction() As SqlTransaction
|
|
Get
|
|
Return m_stCurrentTransaction
|
|
End Get
|
|
End Property
|
|
|
|
|
|
Public ReadOnly Property bIsTransactionPending() As Boolean
|
|
Get
|
|
Return m_bIsTransactionPending
|
|
End Get
|
|
End Property
|
|
|
|
|
|
Public ReadOnly Property scoDBConnection() As SqlConnection
|
|
Get
|
|
Return m_scoDBConnection
|
|
End Get
|
|
End Property
|
|
Public WriteOnly Property sConnectionString() As String
|
|
Set (ByVal Value As String)
|
|
m_scoDBConnection.ConnectionString = Value
|
|
End Set
|
|
End Property
|
|
|
|
#End Region
|
|
|
|
End Class
|
|
End Namespace
|