Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

Spring.Data Assembly

Referenced Assemblies

Assembly Reference Description
Common.Logging  
mscorlib  
mscorlib  
Spring.Aop  
Spring.Core  
System  
System.Data  
System.EnterpriseServices  
System.Transactions  
System.Xml  

Dependent Assemblies

Assembly Description
Spring.Data.NHibernate12  
Spring.Data.NHibernate20  
Spring.Data.NHibernate21  
Spring.Messaging  
Spring.Messaging.Ems  
Spring.Messaging.Nms  
Spring.Scheduling.Quartz  
Spring.Testing.Microsoft  
Spring.Testing.NUnit  

Namespaces

Namespace Description
Spring.Dao Missing <summary> Documentation for Spring.Dao
Spring.Dao.Attributes Missing <summary> Documentation for Spring.Dao.Attributes
Spring.Dao.Support Missing <summary> Documentation for Spring.Dao.Support
Spring.Dao.Support.Generic Missing <summary> Documentation for Spring.Dao.Support.Generic
Spring.Data Missing <summary> Documentation for Spring.Data
Spring.Data.Common Missing <summary> Documentation for Spring.Data.Common
Spring.Data.Config Missing <summary> Documentation for Spring.Data.Config
Spring.Data.Core Missing <summary> Documentation for Spring.Data.Core
Spring.Data.Generic Missing <summary> Documentation for Spring.Data.Generic
Spring.Data.Objects Missing <summary> Documentation for Spring.Data.Objects
Spring.Data.Objects.Generic Missing <summary> Documentation for Spring.Data.Objects.Generic
Spring.Data.Support Missing <summary> Documentation for Spring.Data.Support
Spring.Transaction Missing <summary> Documentation for Spring.Transaction
Spring.Transaction.Config Missing <summary> Documentation for Spring.Transaction.Config
Spring.Transaction.Interceptor Missing <summary> Documentation for Spring.Transaction.Interceptor
Spring.Transaction.Support Missing <summary> Documentation for Spring.Transaction.Support

Classes

Class Description
AbstractAdoOperation Abstract base class providing common functionality for generic and non generic implementations of "AdoOperation" subclasses.
AbstractFallbackTransactionAttributeSource Abstract implementation of ITransactionAttributeSource that caches attributes for methods, and implements a default fallback policy.
AbstractPlatformTransactionManager Abstract base class that allows for easy implementation of concrete platform transaction managers.
AdoAccessor Base class for AdoTemplate and other ADO.NET DAO helper classes defining common properties like DbProvider.
AdoDaoSupport Convenient super class for ADO.NET data access objects.
AdoDaoSupport Convenient super class for ADO.NET data access objects using generics.
AdoNonQuery Encapsulate Command.ExecuteNonQuery operations within a reusable class.
AdoOperation A "AdoOperation" is a thread-safe, reusable object representing an ADO Query, "NonQuery" (Create, Update, Delete), stored procedure or DataSet manipualtions.
AdoOperation A "AdoOperation" is a thread-safe, reusable object representing an ADO Query, "NonQuery" (Create, Update, Delete), stored procedure or DataSet manipualtions.
AdoPlatformTransactionManager ADO.NET based implementation of the IPlatformTransactionManager interface.
AdoQuery Place together the mapping logic to a plain .NET object for one result set within the same class.
AdoQuery Place together the mapping logic to a plain .NET object for one result set within the same class.
AdoScalar Encapsulate Command ExecuteScalar operations within a reusable class.
AdoTemplate This is the central class in the Spring.Data namespace. It simplifies the use of ADO.NET and helps to avoid commons errors.
AdoTemplate This is the central class in the Spring.Data.Generic namespace. It simplifies the use of ADO.NET and helps to avoid commons errors.
AdoTransactionObjectSupport Convenient base class for ADO.NET transaction aware objects.
AdoUtils Missing <summary> documentation for T:Spring.Data.Support.AdoUtils
AttributeDrivenObjectDefinitionParser IObjectDefinitionParser implementation that allows users to easily configure all the infrastructure objects required to enable attribute-driven transction demarcation.
AttributesTransactionAttributeSource Implementation of ITransactionAttributeSource that uses Attributes.
BadSqlGrammarException Exception thrown when SQL specified is invalid.
CannotAcquireLockException Exception thrown on failure to aquire a lock during an update i.e a select for update statement.
CannotCreateTransactionException Exception thrown when a transaction can't be created using an underlying transaction API such as COM+.
CannotGetAdoConnectionException Fatal exception thrown when we can't connect to an RDBMS using ADO.NET
CannotSerializeTransactionException Exception thrown on failure to complete a transaction in serialized mode due to update conflicts.
ChainedPersistenceExceptionTranslator Implementation of PersistenceExceptionTranslator that supports chaining, allowing the addition of PersistenceExceptionTranslator instances in order. Returns
non-null
on the first (if any) match.
CleanupFailureDataAccessException Exception thrown when we couldn't cleanup after a data access operation, but the actual operation went OK.
ConcurrencyFailureException Exception thrown on concurrency failure. This exception should be sublassed to indicate the type of failure - optimistic locking, failure to acquire lock, etc.
ConnectionHolder Connection holder, wrapping a ADO.NET connection and transaction.
ConnectionSynchronization Callback for resource cleanup at end of transaction.
ConnectionTxPair A simple holder for the current Connection/Transaction objects to use within a given AdoTemplate Execute operation. Used internally.
ConnectionUtils Missing <summary> documentation for T:Spring.Data.Support.ConnectionUtils
DaoSupport Generic base class for DAOs, defining template methods for DAO initialization.
DataAccessException Root of the hierarchy of data access exceptions
DataAccessResourceFailureException Data access exception thrown when a resource fails completely: for example, if we can't connect to a database using ADO.NET.
DataAccessUtils Miscellaneous utility methods for DAO implementations. Useful with any data access technology.
DataAccessUtils Miscellaneous utility methods for DAO implementations. Useful with any data access technology.
DatabaseNamespaceParser Implementation of the custom configuration parser for database definitions.
DataIntegrityViolationException Exception thrown when an attempt to insert or update data results in violation of an integrity constraint.
DataRetrievalFailureException Exception thrown if certain expected data could not be retrieved, e.g. when looking up specific data via a known identifier.
DbMetadata Provides database metdata information.
DbParameter A parameter class used by DbParametersBuilder
DbParameters A more portable means to create a collection of ADO.NET parameters.
DbParametersBuilder Assists in creating a collection of parameters by keeping track of all IDbParameters its creates. After creating a number of parameters ask for the collection with the GetParameters methods.
DbProvider Implemenation of of DbProvider that uses metadata to create provider specific ADO.NET objects.
DbProviderFactory Create DbProviders based on configuration information in assembly resource dbproviders.xml
DbProviderFactoryObject A IFactoryObject implementation that creates instances of the IDbProvider class.
DeadlockLoserDataAccessException Generic exception thrown when the current process was a deadlock loser, and its transaction rolled back.
DefaultServiceDomainAdapter Implementation that delegates to ServiceDomain and ContextUtil for all functionality.
DefaultTransactionAttribute Transaction attribute approach to rolling back on all exceptions, no other exceptions by default.
DefaultTransactionAttributeSourceAdvisor Advisor driven by a ITransactionAttributeSource, used to exclude a general advice IAdvice from methods that are non-transactional.
DefaultTransactionDefinition Default implementation of the ITransactionDefinition interface, offering object-style configuration and sensible default values.
DefaultTransactionScopeAdapter Uses TransactionScope and System.Transactions.Transaction.Current to provide necessary state and operations to TxScopeTransactionManager.
DefaultTransactionStatus Default implementation of the ITransactionStatus interface, used by AbstractPlatformTransactionManager.
DelegatingDbProvider IDbProvider implementation that delegates all calls to a given target IDbProvider
DelegatingTransactionAttributeWithName ITransactionAttribute that delegates all calls to a give target attribute except for the name, which is specified in the constructor.
DuplicateKeyException Exception thrown when an attempt to insert or update data results in violation of an primary key or unique constraint. Note that this is not necessarily a purely relational concept; unique primary keys are required by most database types.
EmptyResultDataAccessException Data access exception thrown when a result was not of the expected size, for example when expecting a single row but getting 0 or more than 1 rows.
ErrorCodeExceptionTranslator Implementation of IAdoExceptionTranslator that analyzes provider specific error codes and translates into the DAO exception hierarchy.
ErrorCodes Holds ADO.NET error codes for a particular provider.
FallbackExceptionTranslator Translates all exceptions to an UncategorizedAdoException.
HeuristicCompletionException Exception that represents a transaction failure caused by heuristics.
IDbCommandCreatorFactory Helper class that can efficiently create multiple IDbCommand objects with different parameters based on a SQL statement and a single set of parameter declarations.
IllegalTransactionStateException Exception thrown when the existence or non-existence of a transaction amounts to an illegal state according to the transaction propagation behavior that applies.
IncorrectResultSizeDataAccessException Data access exception thrown when a result was not of the expected size, for example when expecting a single row but getting 0 or more than 1 rows.
IncorrectUpdateSemanticsDataAccessException Data access exception thrown when something unintended appears to have happened with an update, but the transaction hasn't already been rolled back.
InvalidDataAccessApiUsageException Exception thrown on incorrect usage of the API, such as failing to "compile" a query object that needed compilation before execution.
InvalidDataAccessResourceUsageException Root for exceptions thrown when we use a data access resource incorrectly.
InvalidIsolationLevelException Exception that gets thrown when an invalid isolation level is specified, i.e. an isolation level that the transaction manager implementation doesn't support.
InvalidResultSetAccessException Exception thrown when a result set has been accessed in an invalid fashion.
InvalidTimeoutException Exception that gets thrown when an invalid timeout is specified, for example when the transaction manager implementation doesn't support timeouts.
MappingAdoQuery Reusable query in which concrete subclasses must implement the MapRow method to map each row of a single result set into an object.
MappingAdoQuery Reusable query in which concrete subclasses must implement the MapRow method to map each row of a single result set into an object.
MappingAdoQueryWithContext Reusable query in which concrete subclasses must implement the MapRow method to map each row of a single result set into an object.
MappingAdoQueryWithContext Reusable query in which concrete subclasses must implement the abstract MapRow method to map each row of a single result set into an object.
MatchAlwaysTransactionAttributeSource Very simple implementation of ITransactionAttributeSource which will always return the same ITransactionAttribute for all methods fed to it.
MethodMapTransactionAttributeSource Simple implementation of the ITransactionAttributeSource interface that allows attributes to be stored per method in a map.
MultiDelegatingDbProvider A wrapper implementation for IDbProvider such that multiple DbProvider instances can be selected at runtime, say based on web request criteria.
NamedResultSetProcessor Provides a name to a ResultSetProcessor for use with AdoOperation subclasses such as StoredProcedure.
NamedResultSetProcessor(T) Provides a name to a ResultSetProcessor for use with AdoOperation subclasses such as StoredProcedure.
NameMatchTransactionAttributeSource Simple implementation of the ITransactionAttributeSource that allows attributes to be matched by registered name.
NestedTransactionNotSupportedException Exception thrown when attempting to work with a nested transaction but nested transactions are not supported by the underlying backend.
NonTransientDataAccessException Root of the hierarchy of data access exception that are considered non-transient - where a retry of the same operation would fail unless the cause of the Exception is corrected.
NonTransientDataAccessResourceException Data access exception thrown when a resource fails completely and the failure is permanent.
NoRollbackRuleAttribute Tag class. Its class means it has the opposite behaviour to the RollbackRuleAttribute superclass.
NoTransactionException Exception thrown when an operation is attempted that relies on an existing transaction (such as setting rollback status) and there is no existing transaction. This represents an illegal usage of the transaction API.
NullMappingDataReader A data reader implementation that mapps DBNull values to sensible defaults.
ObjectOptimisticLockingFailureException Exception thrown on an optimistic locking violation for a mapped object. Provides information about the persistent class and the identifier.
ObjectRetrievalFailureException Exception thrown if a mapped object could not be retrieved via its identifier. Provides information about the persistent class and the identifier.
OptimisticLockingFailureException Exception thrown on an optimistic locking violation.
ParameterUtils Miscellaneous utility methods for manipulating parameter objects.
PermissionDeniedDataAccessException Exception thrown when the underlyingresource denied a permission to access a specific element, such as a specific database table.
PersistenceExceptionTranslationAdvisor Spring AOP exception translation aspect for use at Repository or DAO layer level. Translates native persistence exceptions into Spring's DataAccessException hierarchy, based on a given PersistenceExceptionTranslator.
PersistenceExceptionTranslationInterceptor AOP MethodInterceptor that provides persistence exception translation based on a given PersistenceExceptionTranslator.
PersistenceExceptionTranslationPostProcessor Object post-processor that automatically applies persistence exception translation to any bean that carries the RepositoryAttribute attribute, adding a corresponding PersistenceExceptionTranslationAdvisor to the exposed proxy (either an existing AOP proxy or a newly generated proxy that implements all of the target's interfaces).
PessimisticLockingFailureException Exception thrown on a pessimistic locking violation.
ResourceHolderSupport Convenient base class for resource holders.
RollbackRuleAttribute Rule determining whether or not a given exception (and any subclasses) should cause a rollback.
RowCallbackResultSetExtractor Adapter to enable use of a IRowCallback inside a ResultSetExtractor.
RowMapperResultSetExtractor Adapter implementation of the ResultSetExtractor interface that delegates to a RowMapper which is supposed to create an object for each row. Each object is added to the results List of this ResultSetExtractor.
RowMapperResultSetExtractor(T) Adapter implementation of the ResultSetExtractor interface that delegates to a RowMapper which is supposed to create an object for each row. Each object is added to the results List of this ResultSetExtractor.
RuleBasedTransactionAttribute ITransactionAttribute implementation that works out whether a given exception should cause transaction rollback by applying a number of rollback rules, both positive and negative.
ServiceDomainPlatformTransactionManager Transaction Manager that uses EnterpriseServices to access the MS-DTC. It requires the support of 'Services without Components' functionality which is available on Win 2003 and Win XP SP2.
ServiceDomainPlatformTransactionManager.ServiceDomainTransactionObject Missing <summary> documentation for T:Spring.Data.Core.ServiceDomainPlatformTransactionManager.ServiceDomainTransactionObject
SimpleServiceConfig A class that contains the properties of ServiceConfig used by ServiceDomainPlatformTransactionManager.
StoredProcedure A superclass for object based abstractions of RDBMS stored procedures.
StoredProcedure A superclass for object based abstractions of RDBMS stored procedures.
TransactionAspectSupport Superclass for transaction aspects, such as the AOP Alliance-compatible TransactionInterceptor.
TransactionAspectSupport.TransactionInfo Opaque object used to hold transaction information.
TransactionAttribute .NET Attribute for describing transactional behavior of methods in a class.
TransactionAttributeConverter Type converter for ITransactionAttribute objects.
TransactionAttributeEditor Type converter for ITransactionAttribute objects.
TransactionAttributeSourceAdvisor Advisor driven by a ITransactionAttributeSource, used to exclude a TransactionInterceptor from methods that are non-transactional.
TransactionAttributeSourceEditor Editor that can convert String values into ITransactionAttributeSource instances.
TransactionAttributeSourceEditor.PropertiesEditor Internal class to parse property values.
TransactionCallbackWithoutResult Simple convenience class for TransactionCallback implementation. Allows for implementing a DoInTransaction version without result, i.e. without the need for a return statement.
TransactionException Base class for all transaction exceptions.
TransactionInterceptor An AOP Alliance IMethodInterceptor providing declarative transaction management using the common Spring.NET transaction infrastructure.
TransactionProxyFactoryObject Proxy factory object for simplified declarative transaction handling.
TransactionSuspensionNotSupportedException Exception thrown when attempting to suspend an existing transaction but transaction suspension is not supported by the underlying backend.
TransactionSynchronizationAdapter Adapter for the ITransactionSynchronization interface.
TransactionSynchronizationManager Internal class that manages resources and transaction synchronizations per thread.
TransactionSystemException Exception thrown when a general transaction system error is encountered, for instance on commit or rollback.
TransactionTemplate Helper class that simplifies programmatic transaction demarcation and transaction exception handling.
TransactionTimedOutException Exception to be thrown when a transaction has timed out.
TransactionUsageException Superclass for exceptions caused by inappropriate usage of a Spring.NET transaction API.
TransientDataAccessException Root of the hierarchy of data access exception that are considered transient - where a previously failed operation might be able to succeed when the operation is retried without any intervention by application-level functionality.
TransientDataAccessResourceException RDta access exception thrown when a resource fails temporarily and the operation can be retried.
TxAdviceObjectDefinitionParser The IObjectDefinitionParser for the
<tx:advice>
tag.
TxNamespaceParser
NamespaceParser
allowing for the configuration of declarative transaction management using either XML or using attributes. This namespace handler is the central piece of functionality in the Spring transaction management facilities and offers two appraoches to declaratively manage transactions. One approach uses transaction semantics defined in XML using the
<tx:advice>
elements, the other uses attributes in combination with the
<tx:annotation-driven>
element. Both approached are detailed in the Spring reference manual.
TxNamespaceUtils This is a utility class to help in parsing the transaction namespace
TxScopeTransactionManager TransactionManager that uses TransactionScope provided by System.Transactions.
TxScopeTransactionManager.PromotableTxScopeTransactionObject The transaction resource object that encapsulates the state and functionality contained in TransactionScope and Transaction.Current via the ITransactionScopeAdapter property.
TypedDataSetUtils Using reflection on VS.NET 2005 a generated typed dataset, apply the connection/transaction pair associated with the current Spring based transaction scope.
TypeMismatchDataAccessException Exception thrown on mismatch between CLS type and database type: for example on an attempt to set an object of the wrong type in an RDBMS column.
UncategorizedAdoException Exception thrown when we can't classify a SQLException into one of our generic data access exceptions.
UncategorizedDataAccessException Normal superclass when we can't distinguish anything more specific than "something went wrong with the underlying resource": for example, a SQLException from Sql Server that we can't pinpoint more precisely.
UnexpectedRollbackException Thrown when an attempt to commit a transaction resulted in an unexpected rollback.
UserCredentialsDbProvider An adapter for a target IDbProvider, applying the specified user credentials to the connection string for every GetConnection call.

Interfaces

Interface Description
IAdoExceptionTranslator Interface to be implemented by classes that can translate between properietary SQL exceptions and Spring.NET's data access strategy-agnostic DataAccessException.
IAdoOperations Interface that defines ADO.NET related database operations.
IAdoOperations Interface that defines ADO.NET related database operations using generics
ICommandCallback Generic callback interface for code that operates on a IDbCommand.
ICommandCallback(T) Generic callback interface for code that operates on a DbCommand.
ICommandSetter Called by the AdoTemplate class to allow implementations to set any necessary parameters on the command object. The CommandType and CommandText will have already been supplied.
ICommandTextProvider Interface to be implemented by objects that can provide SQL strings
ICommonAdoOperations Missing <summary> documentation for T:Spring.Data.ICommonAdoOperations
IDataAdapterCallback Generic callback interface for code that operates on a IDbDataAdapter.
IDataAdapterCallback(T) Generic callback interface for code that operates on a IDbDataAdapter.
IDataAdapterSetter Called by the AdoTemplate class to allow implementations to set any necessary properties on the DbDataAdapter object.
IDataReaderWrapper Custom data reader implementations often delegate to an underlying instance. This interface captures that relationship for reuse in the framework.
IDataSetFillLifecycleProcessor Lifecycle callback methods that can be registered when performing Fill operations with AdoTemplate.
IDbCommandCallback(T) Generic callback interface for code that operates on a IDbCommand.
IDbCommandCreator One of the central callback interfaces used by the AdoTemplate class This interface creates a IDbCommand. Implementations are responsible for configuring the created command with command type, command text and any necessary parameters.
IDbDataAdapterCreator This interface creates a IDbDataAdapterCommand. Implementations are responsible for configuring the created command with appropriate select and actions commands along with their parameters.
IDbMetadata Provides minimal database metadata information to support the functionality in Spring.NET ADO.NET Framework.
IDbParameter A parameter interface used by IDbParametersBuilder
IDbParameters Missing <summary> documentation for T:Spring.Data.Common.IDbParameters
IDbParametersBuilder A builder to create a collection of ADO.NET parameters.
IDbProvider Factory interface to create provider specific ADO.NET objects.
IPersistenceExceptionTranslator Interface implemented by Spring integrations with data access technologies that throw exceptions.
IPlatformTransactionManager This is the central interface in Spring.NET's transaction support.
IResourceTransactionManager Extension of the IPlatformTransactionManager interface, indicating a native resource transaction manager, operating on a single target resource. Such transaction managers differ from DTC based transaction managers in that they do not use transaction enlistment for an open number of resources but rather focus on leveraging the native power and simplicity of a single target resource.
IResultSetExtractor Callback interface to process all result sets and rows in an AdoTemplate query method.
IResultSetExtractor(T) Callback interface to process all results sets and rows in an AdoTemplate query method.
IRowCallback Callback to process each row of data in an AdoOperation's Query method.
IRowMapper Callback to process each row of data in a result set to an object.
IRowMapper(T) Generic callback to process each row of data in a result set to an object.
ISavepointManager Interface that specifies means to programmatically manage transaction savepoints in a generic fashion.
IServiceDomainAdapter Provides the necessary transactional state and operations for ServiceDomainTransactionManager to work with ServiceDomain and ContextUtil.
ISmartTransactionObject Interface to be implemented by transaction objects that are able to return an internal rollback-only marker, typically from a another transaction that has participated and marked it as rollback-only.
ITransactionAttribute This interface adds a RollbackOn specification to ITransactionDefinition.
ITransactionAttributeSource Interface used by TransactionInterceptor to source transaction attributes.
ITransactionCallback Callback interface for transactional code.
ITransactionDefinition Interface for classes that define transaction properties. Base interface for ITransactionAttribute.
ITransactionOperations Interface specifying basic transaction exectuion operations.
ITransactionScopeAdapter Provides the necessary transactional state and operations for TxScopeTransactionManager to work with TransactionScope and Transaction.Current.
ITransactionStatus Representation of the status of a transaction, consisting of a transaction object and some status flags.
ITransactionSynchronization Interface for transaction synchronization callbacks.

Delegates

Delegate Description
CommandDelegate Callback delegate for code that operates on a IDbCommand.
CommandDelegate(T) Generic callback delegate for code that operates on a DbCommand.
CommandSetterDelegate Callback delegate to set any necessary parameters or other properties on the command object. The CommandType and CommandText properties will have already been supplied
DataAdapterDelegate(T) Called by AdoTemplate.Execute with an preconfigured ADO.NET IDbDataAdapter instance with its SelectCommand property populated with CommandType and Text values along with Connection/Transaction properties based on the calling transaction context.
IDbCommandDelegate(T) Generic callback delegate for code that operates on a IDbCommand.
ResultSetExtractorDelegate Callback delegate to process all result sets and row in an AdoTemplate query method.
ResultSetExtractorDelegate(T) Callback delegate to process all result sets and row in an AdoTemplate query method.
RowCallbackDelegate Missing <summary> documentation for T:Spring.Data.RowCallbackDelegate
RowMapperDelegate Callback delegate to process each row of data in a result set to an object.
RowMapperDelegate(T) Callback delegate to process each row of data in a result set to an object.
TransactionDelegate Callback delegate for performing actions within a transactional context.

Enumerations

Enumeration Description
TransactionOutcomeState Represents a transaction's current state.
TransactionPropagation Enumeration describing Spring.NET's transaction propagation settings.
TransactionSynchronizationState Enumeration containing the state of transaction synchronization.
TransactionSynchronizationStatus Enumeration of status values when synchronizing transactions.