- Allows
- This configuration includes the
-
- Any AOP proxy obtained from Spring.NET can be cast to this interface to - allow the manipulation of said proxy's AOP advice. -
-
- Please be aware that Spring.NET's AOP implementation only supports
- method advice (as encapsulated by the
-
- Please be aware that Spring.NET's AOP implementation only supports
- method advice (as encapsulated by the
-
- The return value of this method can be used to index into
- the
- The return value of this method can be used to index into
- the
- This is useful if an advised object needs to call another advised
- method on itself. (If it uses the
- Will never return
- Will never return
- When a config is frozen, no advice changes can be made. This is
- useful for optimization, and useful when we don't want callers
- to be able to manipulate configuration after casting to
-
This class distinguishes between "common" interceptors: shared for all proxies it - creates, and "specific" interceptors: unique per object instance. There need not - be any common interceptors. If there are, they are set using the interceptorNames - property. As with ProxyFactoryObject, interceptors names in the current factory - are used rather than object references to allow correct handling of prototype - advisors and interceptors: for example, to support stateful mixins. - Any advice type is supported for "interceptorNames" entries.
-Such autoproxying is particularly useful if there's a large number of objects that need - to be wrapped with similar proxies, i.e. delegating to the same interceptors. - Instead of x repetitive proxy definitions for x target objects, you can register - one single such post processor with the object factory to achieve the same effect.
-Subclasses can apply any strategy to decide if a object is to be proxied, - e.g. by type, by name, by definition details, etc. They can also return - additional interceptors that should just be applied to the specific object - instance. The default concrete implementation is ObjectNameAutoProxyCreator, - identifying the objects to be proxied via a list of object names.
-Any number of TargetSourceCreator implementations can be used with any subclass, - to create a custom target source - for example, to pool prototype objects. - Autoproxying will occur even if there is no advice if a TargetSourceCreator specifies - a custom TargetSource. If there are no TargetSourceCreators set, or if none matches, - a SingletonTargetSource will be used by default to wrap the object to be autoproxied.
-
- Note that it is no longer possible to configure subclasses to
- expose the
- The exact meaning of agressive optimizations will differ - between proxies, but there is usually some tradeoff. -
-
- For example, optimization will usually mean that advice changes
- won't take effect after a proxy has been created. For this reason,
- optimization is disabled by default. An optimize value of
-
- The default is
- The default is
- This obviously allows one to customise the
-
- The default is not frozen. -
-The previous name of this method was "GetInterceptorAndAdvisorForObject". - It has been renamed in the course of general terminology clarification - in Spring 1.1. An AOP Alliance Interceptor is just a special form of - Advice, so the generic Advice term is preferred now.
-The third parameter, customTargetSource, is new in Spring 1.1; - add it to existing implementations of this method.
-null).
- he relevant property infos for the target object (with ignored
- dependency types - which the factory handles specifically - already filtered out)
- The object instance created, but whose properties have not yet
- been set.
- Name of the object.
- Overridden from the super class to prevent the proxy configuration - from being frozen before the proxy is created. The default is not frozen. -
-
- Invoked after population of normal object properties but before an init
- callback like
- The default implementation checks for "xxx*", "*xxx" and "*xxx*" matches, - as well as direct equality. Can be overridden in subclasses. -
-<aop:config> tag.
- proxy-target-type' attribute
- - This method is never invoked if the parser is namespace aware - and was called to process the root node. -
-aop namespace tags.
- - A constructor invocation is a joinpoint and can be intercepted by a - constructor interceptor. -
-- An invocation is a joinpoint and can be intercepted by an interceptor. - Typical examples would be a constructor invocation and a method call. -
-
- A runtime joinpoint is an event that occurs on a static
- joinpoint (i.e. a location in a program). For instance, an
- invocation is the runtime joinpoint on a method (static joinpoint).
- The static part of a given joinpoint can be generically retrieved
- using the
- In the context of an interception framework, a runtime joinpoint - is then the reification of an access to an accessible object (a - method, a constructor, a field), i.e. the static part of the - joinpoint. It is passed to the interceptors that are installed on - the static joinpoint. -
-- The implementation and semantics of this method depend on the - actual joinpoint type. Consult the derived interfaces of this - interface for specifics. -
-- The static part is an accessible object on which a chain of - interceptors are installed. -
-- For instance, the target object for a method invocation. -
-- It is of course possible to change element values within this array - to change the arguments to an intercepted invocation. -
-
- This property is a friendly implementation of the
-
- Only one canonical
- Can be used as part of a pointcut, or for the entire targeting of an - introduction. -
-- This is a utility class, and as such has no publicly visible - constructors. -
-- Alternative to an object pool. -
-- Application code is written as to a normal pool; callers can't assume - they will be dealing with the same instance in invocations in different - threads. However, state can be relied on during the operations of a - single thread: for example, if one caller makes repeated calls on the - AOP proxy. -
-- This class act both as an introduction and as an interceptor, so it - should be added twice, once as an introduction and once as an - interceptor. -
-
- All such
- This target will be invoked via reflection if no around advice chooses - to end the interceptor chain itself. -
-
- If an
- Application developers don't usually need to work with target sources - directly: this is an AOP framework interface. -
-
- This is an
- Ensures that the
- This object should be a prototype, or the same instance will always
- be obtained from the owning
- Needed so that prototype instances can be created as necessary. -
-- Such interceptions are nested "on top" of the target. -
-- A generic interceptor can intercept runtime events that occur within a - base program. Those events are materialized by (reified in) joinpoints. - Runtime joinpoints can be invocations, field access, exceptions, etc. -
-- This interface is not used directly. Use the various derived interfaces - to intercept specific events. -
-- Implementations can be any type of advice, such as interceptors. -
-
- Polite implementations would certainly like to invoke
-
- Unlike most thread local storage which is static, this variable is - meant to be per thread per instance of this class. -
-- Tries to locate the target from thread local storage. If no target - is found, a target will be obtained and bound to the thread. -
-
- This is the default implementation of the
-
- No-op implementation. -
-
- Returns
- This class provides a simple way of obtaining and configuring AOP - proxies in code. -
-- Instances of this class are not themselves AOP proxies, but - subclasses of this class are normally factories from which AOP proxy - instances are obtained directly. -
-
- This class frees subclasses of the housekeeping of
-
- If an
- If entry value is
- Does nothing if the supplied (proxied)
- The return value of this method can be used to index into
- the
Acces is not synchronized
-
- The return value of this method can be used to index into
- the
- An example of such a change would be when a new introduction is
- added. Resetting
-
- Subclasses must not create a proxy by any other means (at least - without having a well thought out and cogent reason for doing so). - This is because the implementation of this method performs some - required housekeeping logic prior to creating an AOP proxy. -
-
- Useful when this instance has been created using the no-argument
- constructor, and needs to get all of its confiuration data from
- another
- Will never return
- This is a convenience write-only property that allows client code
- to set the target object... the target object will be implicitly
- wrapped within a new
-
- If this property value is
- Users will be able to add interceptors dynamically without proxy
- regeneration, but if they add introductions the proxy
-
- Interceptors must be added if this factory is to do anything useful. -
-- Can be called repeatedly; the effect of repeated invocations will - (of course) vary if interfaces have been added or removed. -
-- This is a convenience method for creating a proxy for a single - interceptor. -
-
- Implementors can create AOP Alliance
-
- There is no need for most Spring.NET users to implement this interface;
- do so only if you need to introduce more
-
- Is it valid to invoke the
-
- Don't worry about any
- A more efficient alternative solution in cases where there is no
- interception advice and therefore no need to create an
-
- Used internally by the AOP framework: application developers should not need - to use this class directly. -
-
- Such pointcut unions are tricky, because one cannot simply
- A pointcut is composed of
- An
- If the value of the
- If an implementation returns
- This is a static check. If this method invocation returns
-
- In order for this method to have even been invoked, the supplied
-
- Invoked immediately before any potential running of the - advice, and after any advice earlier in the advice chain has - run. -
-
- If
- Note that this property can be checked when an AOP proxy is created, - and implementations need not check the value of this property again - before each method invocation. -
-
- The
- The functionality in this class might be used by a target object that - needed access to resources on the invocation. However, this approach - should not be used when there is a reasonable alternative, as it makes - application code dependent on usage under AOP and the Spring.NET AOP - framework. -
-- This method is for internal use only, and should never be called by - client code. -
-- This method is for internal use only, and should never be called by - client code. -
-- This is a utility class, and as such exposes no public constructors. -
-
- Will be
- The default value for the
-
- Implementations must also automatically register adapters for
-
- Don't worry about the pointcut associated with the
-
- Note that it is not necessary to register adapters for
-
- Such interceptions are nested "on top" of the target. -
-
- Polite implementations would certainly like to invoke
-
- If configuring an object of this class in a Spring IoC container, - use constructor injection to supply the intial target. -
-- No-op implementation. -
-- Two invoker interceptors are equal if they have the same target or - if the targets are equal. -
-
- Can return
- Maintains a pool of target instances, acquiring and releasing a target - object from the pool for each method invocation. -
-- This class is independent of pooling technology. -
-
- Subclasses must implement the
-
- This class implements the
- This is an
- Disposes of the pool. -
-
- The
- Always throws a
- Must be implemented by a derived class in order to specify matching - rules. -
-
- Always returns
- This is an abstract class, and as such has no publicly - visible constructors. -
-- The default implementation checks for "xxx*", "*xxx" and "*xxx*" matches, - as well as direct equality. Can be overridden in subclasses. -
-- Matching will be the union of all these; if any match, the pointcut matches. -
-- This covers nearly all advisors except introduction advisors, for which - method-level matching does not apply. -
-
- Spring.NET AOP is centered on around advice delivered via method
- interception, compliant with the AOP Alliance interception API.
- The
- An advisor that was creating a mixin would be a per instance
- operation and would thus return
- Use
- An advice may be an interceptor, a throws advice, before advice, - introduction etc. -
-- An advice may be an interceptor, a throws advice, before advice, - introduction etc. -
-- Not supported for dynamic advisors. -
-
- Invoked after population of normal object properties but before an init
- callback like
- An advice may be an interceptor, a throws advice, before advice, - introduction etc. -
-
- Before advice is advice that executes before a joinpoint, but
- which does not have the ability to prevent execution flow proceeding to
- the joinpoint (unless it throws an
- Spring.NET only supports method before advice. Although this - is unlikely to change, this API is designed to allow field - before advice in future if desired. -
-AbstractAutoProxyCreator can support a number of TargetSourceCreators, - which will be applied in order.
-Subclasses must implement the abstract findCandidateAdvisors() method - to return a list of Advisors applying to any object. Subclasses can also - override the inherited shouldSkip() method to exclude certain objects - from autoproxying, but they must be careful to invoke the shouldSkip() - method of this class, which tries to avoid circular reference problems - and infinite loops.
-Advisors or advices requiring ordering should implement the Ordered interface. - This class sorts advisors by Ordered order value. Advisors that don't implement - the Ordered interface will be considered to be unordered, and will appear - at the end of the advisor chain in undefined order.
-The previous name of this method was "GetInterceptorAndAdvisorForObject". - It has been renamed in the course of general terminology clarification - in Spring 1.1. An AOP Alliance Interceptor is just a special form of - Advice, so the generic Advice term is preferred now.
-The third parameter, customTargetSource, is new in Spring 1.1; - add it to existing implementations of this method.
-
- Invoked after population of normal object properties but before an init
- callback like
- This is the most commonly used
- This implementation will release the target object when said object - is disposed. -
-
- Subclasses can, of course, override this method if they want to
- return a different
- Disposes of the pool. -
-
- The default is
- The default is
- This is a fundamental AOP concept called introduction. -
-- Introductions are often mixins, enabling the building of composite - objects that can achieve many of the goals of multiple inheritance. -
-
- This constructor will also register the well-known
-
- This contructor is marked as
- Evaluating such pointcuts is slower than evaluating normal pointcuts, - but can nevertheless be useful in some cases. Of course, your mileage - may vary as to what 'slower' actually means. -
-
- If the supplied
- Subclasses are encouraged to override this method for greater - filtering (and performance). -
-
- This, the default, implementation always matches (returns
-
- Subclasses are encouraged to override this method if it is possible - to filter out some candidate classes. -
-
- This, the default, implementation always matches (returns
-
- Subclasses are encouraged to override this method if it is possible - to filter out some candidate classes. -
-- Useful as a debugging aid. -
-
- Note that this value is distinct from the number of times that this
- pointcut sucessfully matches a target method, in that a
-
- This implementation is a runtime pointcut, and so always returns
-
- Implementations of the
- AfterThrowing([MethodInfo method, Object[] args, Object target], Exception subclass);
-
- The method name is fixed (i.e. your methods must be named
-
- Please note that the object encapsulating the throws advice does not
- need to implement the
- This is a framework class that should not normally need to be used - directly by Spring.NET users. -
-
- Find below some examples of valid
- public class GlobalExceptionHandlingAdvice : IThrowsAdvice
- {
- public void AfterThrowing(Exception ex) {
- // handles absolutely any and every Exception...
- }
- }
-
-
- public class RemotingExceptionHandlingAdvice : IThrowsAdvice
- {
- public void AfterThrowing(RemotingException ex) {
- // handles any and every RemotingException (and subclasses of RemotingException)...
- }
- }
-
-
- using System.Data;
-
- public class DataExceptionHandlingAdvice
- {
- public void AfterThrowing(ConstraintException ex) {
- // specialised handling of ConstraintExceptions
- }
-
- public void AfterThrowing(NoNullAllowedException ex) {
- // specialised handling of NoNullAllowedExceptions
- }
-
- public void AfterThrowing(DataException ex) {
- // handles all other DataExceptions...
- }
- }
-
-
- Will return
- Normally this call will be used to initialize the object. -
-
- Invoked after population of normal object properties but before an
- init callback such as
-
- It is not dynamic. -
-- This is a utility class, and as such has no publicly visible - constructors. -
-- To be implemented by introduction aspects in order to obtain access to - the target object. -
-
- This implementation creates a new instance
- of the
advisor tag you can configure an advisor tag supports only referenced config' tag.
- ILog instance used to write logging messages.
-
-
-
- on FooException1 log 'My Message, Method Name ' + #method.Name
- on FooException1 translate new BarException('My Message, Method Called = ' + #method.Name", #e)
- on FooException2,Foo3Exception wrap BarException 'My Bar Message'
- on FooException4 replace BarException 'My Bar Message'
- on FooException5 return 32
- on FooException6 swallow
-
-
-
-
-
-
- Polite implementations would certainly like to invoke
-
- This method allows the object instance to perform the kind of - initialization only possible when all of it's dependencies have - been injected (set), and to throw an appropriate exception in the - event of misconfiguration. -
-
- Please do consult the class level documentation for the
-
- Polite implementations would certainly like to invoke
-
- This method allows the object instance to perform the kind of - initialization only possible when all of it's dependencies have - been injected (set), and to throw an appropriate exception in the - event of misconfiguration. -
-
- Please do consult the class level documentation for the
-
- This is an
- Derived classes can override this method to add preconditions for - dynamic matching. -
-
- This implementation always returns
- Must be overriden by derived classes to provide criteria for dynamic matching. -
-- This is an abstract class, and as such has no publicly - visible constructors. -
-- This is an abstract class, and as such has no publicly - visible constructors. -
-- Not supported for dynamic advisors. -
-
- This implementation always returns a filter that evaluates to
- This implementation always returns itself (this object). -
-- This implementation always returns itself (this object). -
-
- In the future Spring.NET may also offer a more efficient alternative
- solution in cases where there is no interception advice and therefore
- no need to create an
- Used internally by the Spring.NET AOP framework: application developers - should not need to use this class directly. -
-- Creates a decorator-base proxy if one the following is true : - - the "ProxyTargetType" property is set - - no interfaces have been specified -
-- In general, specify "ProxyTargetType" to enforce a decorator-based proxy, - or specify one or more interfaces to use a composition-based proxy. -
-- Normally this call will be used to initialize the object. -
-
- Invoked after population of normal object properties but before an
- init callback such as
-
- Subclasses can override the
-
- A method invocation is a joinpoint and can be intercepted by a method - interceptor. -
-
- This property is a friendly implementation of the
-
- This is an abstract class, and as such exposes no publicly visible - constructors. -
-
-
- Subclasses can override this to use custom invocation. -
-
-
- May or may not correspond with a method invoked on an underlying - implementation of that interface. -
-
- May be
- All methods return a
- IPointcut pointcut = new ComposablePointcut()
- .Union(typeFilter)
- .Intersection(methodMatcher)
- .Intersection(pointcut);
-
-
- There is no
- After returning advice is invoked only on a normal method - return, but not if an exception is thrown. Such advice can see - the return value of the advised method invocation, but cannot change it. -
-- Possible uses for this type of advice would include performing access - control checks on the return value of an advised method invocation, the - ubiquitous logging of method invocation return values (useful during - development), etc. -
-
- Note that the supplied
- Subclasses can override this to use custom invocation. -
-- This implementation creates instance of the AdvisedProxy object. -
-- This advice can be used to evict items from the cache. -
-
- Information that determines which items should be evicted and from which cache
- are retrieved from the
- Items are evicted *after* target method is invoked. Return value of the method,
- as well as method arguments, can be used to determine a list of keys for the items
- that should be evicted (return value will be passed as a context for
-
- Note that the supplied
- This advice can be used to cache the return value of the method. -
-
- Parameters that determine where, how and for how long the return value
- will be cached are retrieved from the
- This method tries to retrieve an object from the cache, using the supplied
-
- If object does not exist in the cache, the advised method is called (using
-
- The filter arising from the union will match all of the
-
- The filter arising from the intersection will match all of the
-
- This is a utility class, and as such has no publicly visible constructors. -
-- Matching will be the union of all these; if any match, the pointcut matches. -
-
- There are no methods on this interface, as methods are discovered and
- invoked via reflection. Please do see read the API documentation for the
-
- There are any number of possible uses for this type of advice. Some
- examples would include the ubiquitous logging of any such exceptions,
- monitoring the number and type of exceptions and sending emails to
- a support desk once certain criteria have been met, wrapping generic
- exceptions such as
- Can only be used in an object factory. -
-- No-op implementation. -
-- Uses the regular expression classes from the .NET Base Class Library. -
-
- The regular expressions must be a match. For example, the
- .*Get* pattern will match Get.* will not.
-
- The regular expressions must be a match. For example, the
- .*Get.* pattern will match Get.* will not.
-
- This base class is serializable. Subclasses should decorate all
- fields with the
- This is an abstract class, and as such has no publicly - visible constructors. -
-- Can be invoked multiple times. -
-
- This method will be invoked from the
- Try to match the regular expression against the fully qualified name
- of the method's declaring
- Note that the declaring
- In this instance, simply returns
- Can be invoked multiple times. -
-
- This method will be invoked from the
-
- This interface cannot be implemented directly; subinterfaces must - provide the advice type implementing the introduction. -
-- Introduction is the implementation of additional interfaces (not - implemented by a target) via AOP advice. -
-
- Invoked before adding an
-
- This is the
- This constructor adds all interfaces implemented by the supplied
-
- This, the default, implementation always returns
- Invoked before adding an
-
- Default for an introduction is per-instance interception. -
-- This advice can be used to cache the parameter of the method. -
-
- Information that determines where, how and for how long the return value
- will be cached are retrieved from the
- Parameter values are cached *after* the target method is invoked in order to - capture any parameter state changes it might make (for example, it is common - to set an object identifier within the save method for the persistent entity). -
-
- Note that the supplied
- Normally this call will be used to initialize the object. -
-
- Invoked after population of normal object properties but before an
- init callback such as
-
- This class is exposed as a singleton. -
-- This is a utility class, and as such has no publicly visible constructors. -
-
- The
- Such advice cannot prevent the method call proceeding, short of
- throwing an
- The main advantage of
- Possible uses for this type of advice would include performing class - invariant checks prior to the actual method invocation, the ubiquitous - logging of method invocations (useful during development), etc. -
-- Because the target source is static, the target object can be cached - and simply returned as is. -
-
- The only requirement for it to work is that it needs to be defined
- in an application context along with any arbitrary "non-native" Spring.NET
-
- Does nothing, simply returns the supplied
- Registers the supplied
on exception name [ExceptionName1,ExceptionName2,...] retry [number of times] [delay|rate] [delay time|rate expression].
- For example, on exception name ArithmeticException retry 3x delay 1s
-
- Polite implementations would certainly like to invoke
-
- This method allows the object instance to perform the kind of - initialization only possible when all of it's dependencies have - been injected (set), and to throw an appropriate exception in the - event of misconfiguration. -
-
- Please do consult the class level documentation for the
-
- Normally this call will be used to initialize the object. -
-
- Invoked after population of normal object properties but before an
- init callback such as
-
- Normally this call will be used to initialize the object. -
-
- Invoked after population of normal object properties but before an
- init callback such as
-
-
- Global interceptors and advisors can be added at the factory level
- (that is, outside the context of a
-
- It is possible to cast a proxy obtained from this factory to an
-
- If it's sourced from object name, it will need to be - refreshed each time a new prototype instance is created. -
-- Default is for globals expansion only. -
-- Default is for globals expansion only. -
-
- Invoked when clients obtain objects from this factory object. The
- (proxy) instance will be cached for a singleton, and created on each
- call to
- Only works when the
-
- This property must always be set (configured) when using a
-
- Only works when the
-
- This is a utility class, and as such has no publicly - visible constructors. -
-- This is an abstract class, and as such has no publicly - visible constructors. -
-- This is an abstract class, and as such has no publicly - visible constructors. -
-
- Configure this class using the
- Can delegate to any type of regular expression pointcut. Currently only
- pointcuts based on the regular expression classes from the .NET Base
- Class Library are supported. The
-
- This should not normally be set directly. -
-- These methods are particularly useful for composing pointcuts - using the union and intersection methods. -
-- This is a utility class, and as such has no publicly - visible constructors. -
-- Caches against a key based on : - - the base type - - the target type - - the interfaces to proxy -
-- Not intended to be used directly by applications. -
-- This includes interfaces implemented by any superclasses. -
-- This is an important test as it can be used to optimize out a - pointcut for a class. -
-
- Invoking this method with a
- This is an important test as it can be used to optimize out an - advisor for a class. -
-- This is a utility class, and as such has no publicly - visible constructors. -
-- A method matcher may be evaluated statically (based on method and target - class) or need further evaluation dynamically (based on arguments at - the time of method invocation). -
-- The newly created matcher will match all the methods that either of the two - supplied matchers would match. -
-- The newly created matcher will match only those methods that both - of the supplied matchers would match. -
-- This is a utility class, and as such has no publicly - visible constructors. -
-- This implementation calls the base constructor. -
-- Not intended to be used directly by applications. -
-- This is a utility class, and as such has no publicly visible - constructors. -
-- Subclasses can override this to use custom invocation. -
-- This validator uses following rules to determine if target value is valid: -
| Target |
- Valid Value | -
|---|---|
| A |
- Not |
-
| A |
- Not |
-
| One of the number types. | -Not zero. | -
| A |
- Not |
-
| Any reference type other than |
- Not |
-
- You cannot use this validator to validate any value types other than the ones - specified in the table above. -
-
- Custom validators should always extend this class instead of
- simply implementing
- The primary motivation for this interface is to enable validation to be - decoupled from the (user) interface and placed in business objects. -
-
- Application developers writing their own custom
-
- This validator will be valid when one or more of the validators in the
-
- This validator will be valid only when all of the validators in the
-
- Mainly for internal use within the framework. -
-- This is a utility class, and as such exposes no public constructors. -
-Usually this is non issue because the same exception will be raised entering the monitor
- associated with the lock (
Use of
Used for implementation of a
- Because release does not raise exceptions, - it can be used in `finally' clauses without requiring extra - embedded try/catch blocks. But keep in mind that - as with any java method, implementations may - still throw unchecked exceptions such as Error or NullPointerException - when faced with uncontinuable errors. However, these should normally - only be caught by higher-level error handlers. -
-- The method has best-effort semantics: - The msecs bound cannot - be guaranteed to be a precise upper bound on wait time in Java. - Implementations generally can only attempt to return as soon as possible - after the specified bound. Also, timers in Java do not stop during garbage - collection, so timeouts can occur just because a GC intervened. - So, msecs arguments should be used in - a coarse-grained manner. Further, - implementations cannot always guarantee that this method - will return at all without blocking indefinitely when used in - unintended ways. For example, deadlocks may be encountered - when called in an unintended context. -
-
- This
- Note that the list is composed of instances of the actual
-
- The following code snippets show examples of how to decorate the
- the proxied class with one or more
- // get a concrete implementation of an IProxyTypeBuilder...
- IProxyTypeBuilder builder = ... ;
- builder.TargetType = typeof( ... );
-
- IDictionary typeAtts = new Hashtable();
- builder.TypeAttributes = typeAtts;
-
- // applies a single Attribute to the proxied class...
- typeAtts = new Attribute[] { new MyCustomAttribute() });
-
- // applies a number of Attributes to the proxied class...
- typeAtts = new Attribute[]
- {
- new MyCustomAttribute(),
- new AnotherAttribute(),
- });
-
-
- This dictionary must use simple
- The key may be wildcarded using the
- The following code snippets show examples of how to decorate the
- members of a proxied class with one or more
-
- // get a concrete implementation of an IProxyTypeBuilder...
- IProxyTypeBuilder builder = ... ;
- builder.TargetType = typeof( ... );
-
- IDictionary memAtts = new Hashtable();
- builder.MemberAttributes = memAtts;
-
- // applies a single Attribute to all members of the proxied class...
- memAtts ["*"] = new Attribute[] { new MyCustomAttribute() });
-
- // applies a number of Attributes to all members of the proxied class...
- memAtts ["*"] = new Attribute[]
- {
- new MyCustomAttribute(),
- new AnotherAttribute(),
- });
-
- // applies a single Attribute to those members of the proxied class
- // that have identifiers starting with 'Do' ...
- memAtts ["Do*"] = new Attribute[] { new MyCustomAttribute() });
-
- // applies a number of Attributes to those members of the proxied class
- // that have identifiers starting with 'Do' ...
- memAtts ["Do*"] = new Attribute[]
- {
- new MyCustomAttribute(),
- new AnotherAttribute(),
- });
-
- - The specified object can be of different type : -
-- If the target type does not implement the interface, - we return the interfaces methods as the target methods for many reasons : -
- The default value of this property is the
-
- Only interfaces can be proxied using composition, so the target - must implement one or more interfaces. -
-- This implementation creates instance of the target object for delegation - using constructor arguments. -
-
- Typically not used directly but via its subclasses such as
-
- Usage: specify either the
- The following example uses the
- public class Foo
- {
- public string ToString(string name, int age, string address)
- {
- return string.Format("{0}, {1} years old, {2}", name, age, address);
- }
-
- public static void Main()
- {
- Foo foo = new Foo();
- MethodInvoker invoker = new MethodInvoker();
- invoker.Arguments = new object [] {"Kaneda", "18 Kaosu Gardens, Nakatani Drive, Okinanawa"};
- invoker.AddNamedArgument("age", 29);
- invoker.Prepare();
- // at this point, the arguments that will be passed to the method invocation
- // will have been resolved into the following ordered array : {"Kaneda", 29, "18 Kaosu Gardens, Nakatani Drive, Okinanawa"}
- string details = (string) invoker.Invoke();
- Console.WriteLine (details);
- // will print out 'Kaneda, 29 years old, 18 Kaosu Gardens, Nakatani Drive, Okinanawa'
- }
- }
-
- - The method can be invoked any number of times afterwards. -
-
- A possible use case is to determine the return
- The invoker needs to have been prepared beforehand (via a call to the
-
- Only necessary when the target method is
- Only necessary when the target method is not
- Refers to either a
- Ordering is significant... the order of the arguments in this
- property must match the ordering of the various parameters on the target
- method. There does however exist a small possibility for confusion when
- the arguments in this property are supplied in addition to one or more named
- arguments. In this case, each named argument is slotted into the index position
- corresponding to the named argument... once once all named arguments have been
- resolved, the arguments in this property are slotted into any remaining (empty)
- slots in the method parameter list (see the example in the overview of the
-
- If this property is not set, or the value passed to the setter invocation
- is
- Setting the value of this property to
- The keys of this dictionary are the (
- If this property is not set, or the value passed to the setter invocation
- is a
- The method can be invoked any number of times afterwards. -
-- Provides common properties like the object registry to work on. -
-
- This is an
- This is an
- Note that this class generally is expected to be used for accessing factory methods,
- and as such defaults to operating in singleton mode. The first request to
-
- A
- Another (esoteric) use case for this factory object is when one needs to call a method
- that doesn't return any value (for example, a
-
- The following example uses an instance of this class to call a
-
-
- - The following example is similar to the preceding example; the only pertinent difference is the fact that - a number of different objects are passed as arguments, demonstrating that not only simple value types - are valid as elements of the argument list... -
-
-
-
-
-
- - Named parameters are also supported... this next example yields the same results as - the preceding example (that did not use named arguments). -
-
-
-
- - Similarly, the following example uses an instance of this class to call an instance method... -
-
-
-
-
- - The above example could also have been written using an anonymous inner object definition... if the - object on which the method is to be invoked is not going to be used outside of the factory object - definition, then this is the preferred idiom because it limits the scope of the object on which the - method is to be invoked to the surrounding factory object. -
-
-
-
-
- If an object implements this interface, it is used as a factory,
- not directly as an object.
- An implementation of the
-
- This method allows the object instance to perform the kind of - initialization only possible when all of it's dependencies have - been injected (set), and to throw an appropriate exception in the - event of misconfiguration. -
-
- Please do consult the class level documentation for the
-
- Returns the return value of the method that is to be invoked. -
-
- Will return the same value each time if the
-
- If the return value of the method that this factory is to invoke is
-
- Allows for framework-internal plug'n'play, e.g. in
-
-
- If this is an
- With the exception of
-
- This is the basic client view of a Spring.NET IoC container; further interfaces
- such as
- This is the root interface to be implemented by objects that can hold a number
- of object definitions, each uniquely identified by a
- The point of this approach is that the IObjectFactory is a central registry of - application components, and centralizes the configuring of application components - (no more do individual objects need to read properties files, for example). - See chapters 4 and 11 of "Expert One-on-One J2EE Design and Development" for a - discussion of the benefits of this approach. -
-
- Normally an IObjectFactory will load object definitions stored in a configuration
- source (such as an XML document), and use the
- In contrast to the methods in
-
- Object factories are supposed to support the standard object lifecycle interfaces - as far as possible. The maximum set of initialization methods and their standard - order is: -
-
-
-
-
- On shutdown of an object factory, the following lifecycle methods apply: -
-
-
-
-
- That is, will
- Will ask the parent factory if the object cannot be found in this factory - instance. -
-- Will ask the parent factory if the object cannot be found in this factory - instance. -
-- Will ask the parent factory if the object cannot be found in this factory - instance. -
-- This method allows an object factory to be used as a replacement for the - Singleton or Prototype design pattern. -
-- Note that callers should retain references to returned objects. There is no - guarantee that this method will be implemented to be efficient. For example, - it may be synchronized, or may need to run an RDBMS query. -
-- Will ask the parent factory if the object cannot be found in this factory - instance. -
-- This method allows an object factory to be used as a replacement for the - Singleton or Prototype design pattern. -
-- Note that callers should retain references to returned objects. There is no - guarantee that this method will be implemented to be efficient. For example, - it may be synchronized, or may need to run an RDBMS query. -
-- Will ask the parent factory if the object cannot be found in this factory - instance. -
-
- Provides a measure of type safety by throwing an exception if the object is
- not of the required
- This method allows an object factory to be used as a replacement for the - Singleton or Prototype design pattern. -
-- Note that callers should retain references to returned objects. There is no - guarantee that this method will be implemented to be efficient. For example, - it may be synchronized, or may need to run an RDBMS query. -
-- Will ask the parent factory if the object cannot be found in this factory - instance. -
-
- More specifically, checks the type of object that
-
- In addition to being generally useful, typically this method is used to provide - dependency injection functionality for objects that are instantiated outwith the - control of a developer. A case in point is the way that the current (1.1) - ASP.NET classes instantiate web controls... the instantiation takes place within - a private method of a compiled page, and thus cannot be hooked into the - typical Spring.NET IOC container lifecycle for dependency injection. -
-
- namespace ExampleNamespace
- {
- public class BusinessObject
- {
- private IDao _dao;
-
- public BusinessObject() {}
-
- public IDao Dao
- {
- get { return _dao; }
- set { _dao = value; }
- }
- }
- }
-
- with the corresponding driver code looking like so...
-
- IObjectFactory factory = GetAnIObjectFactoryImplementation();
- BusinessObject instance = new BusinessObject();
- factory.ConfigureObject(instance, "object_definition_name");
- // at this point the dependencies for the 'instance' object will have been resolved...
-
- - This method allows an object factory to be used as a replacement for the - Singleton or Prototype design pattern. -
-- Note that callers should retain references to returned objects. There is no - guarantee that this method will be implemented to be efficient. For example, - it may be synchronized, or may need to run an RDBMS query. -
-- Will ask the parent factory if the object cannot be found in this factory - instance. -
-
- This is the indexer for the
- Does not consider any hierarchy this factory may participate in. -
-
- Does consider objects created by
- Does not consider any hierarchy this factory may participate in. -
-
- Does consider objects created by
- Does not consider any hierarchy this factory may participate in. -
-
- This version of the IListableObjectFactory.GetObjectsOfType(type,true,true) .
-
- Provides the means to configure an object factory in addition to the
- object factory client methods in the
-
- Allows for framework-internal plug'n'play even when needing access to object - factory configuration methods. -
-
- When disposed, it will destroy all cached singletons in this factory. Call
-
- To be invoked during factory configuration. -
-
- This will typically be used for dependencies that are resolved
- in other ways, like
- To be invoked during factory configuration. -
-- This is typically used to support names that are illegal within - XML ids (which are used for object names). -
-- Typically invoked during factory configuration, but can also be - used for runtime registration of aliases. Therefore, a factory - implementation should synchronize alias access. -
-- Typically invoked during factory configuration, but can also be - used for runtime registration of singletons. Therefore, a factory - implementation should synchronize singleton access; it will have - to do this anyway if it supports lazy initialization of singletons. -
-- To be invoked during factory configuration. -
-
- Only checks already instantiated singletons; does not return
-
- The main purpose of this method is to check manually registered
- singletons (
- To check whether an object factory contains an object definition
- with a given name, use the
-
- Use the
-
- Note that the parent shouldn't be changed: it should only be set outside - a constructor if it isn't available when an object of this class is - created. -
-- The returned object instance may be a wrapper around the original. -
-- The returned object instance may be a wrapper around the original. -
-- Typically invoked at the end of factory setup, if desired. -
-- As this is a startup method, it should destroy already created singletons if - it fails, to avoid dangling resources. In other words, after invocation - of that method, either all or no singletons at all should be - instantiated. -
-
- Currently supports reading custom configuration sections and returning them as
-
- This is a utility class, and as such has no publicly visible - constructors. -
-- Often used to wire subscribers to event publishers. -
-- This is a utility class, and as such has no publicly visible constructors. -
-
- This is a default implementation of
- This was done in order to avoid redundant
- The error code is a
- The GUI can render this anyway it pleases, allowing for I18n etc. -
-
- If no
- If the supplied
- This implementation respects the inheritance chain of any parameter
-
- Type aliases can be used instead of fully qualified type names anywhere - a type name is expected in a Spring.NET configuration file. -
-
- This includes type names specified within an object definition, as well
- as values of the properties or constructor arguments that expect
-
- The following example shows how to configure both this section handler and - how to define type aliases within a Spring.NET config section: -
-
-
-
-
-
-
-
-
-
-
- ...
-
-
-
- - Spring allows registration of custom resource handlers that can be used to load - object definitions from. -
-
- For example, if you wanted to store your object definitions in a database instead
- of in the config file, you could write a custom
- Afterwards, you would simply specify resource URI within the
- The following example shows how to configure both this section handler, - how to define custom resource within Spring config section, and how to load - object definitions using custom resource handler: -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This interface is to be implemented by most (if not all)
-
- Configuration and lifecycle methods are encapsulated here to avoid
- making them obvious to
- Calling
-
-
-
- In addition to standard object factory lifecycle capabilities,
-
- This interface is the central client interface in Spring.NET's IoC - container implementation. As such it does inherit a quite sizeable - number of interfaces; implementations are strongly encouraged to use - composition to satisfy each of the inherited interfaces (where - appropriate of course). -
-- This enables the parameterization and internationalization of messages. -
-- Spring.NET provides one out-of-the-box implementation for production - use: -
- If the lookup is not successful, implementations are permitted to - take one of two actions. -
-- If the lookup is not successful, implementations are permitted to - take one of two actions. -
-- If the lookup is not successful, implementations are permitted to - take one of two actions. -
-- If the lookup is not successful, implementations are permitted to - take one of two actions. -
-- If the lookup is not successful, implementations are permitted to - take one of two actions. -
-
- This method must use the
-
- Examples of resources that may be resolved by this method include - (but are not limited to) objects such as icons and bitmaps. -
-- Examples of resources that may be resolved by this method include - (but are not limited to) objects such as icons and bitmaps. -
-
- Resource key names are of the form
- Serves as a super-interface for the
-
- An
- The
- The handle should always be a reusable resource descriptor; this
- allows one to make repeated calls to the underlying
-
-
- This is to be set immediately after an
-
- If the parent context is
- To be invoked during context configuration. -
-- Can be used to access specific functionality of the factory. -
-
- Although this class is advertised as immutable, it really isn't.
- Anyone with access to the wrapped
- This interface models the mathematical
-
-
- Also, the
- None of the
- The following table summarizes the binary operators that are supported
- by the
- That is, the element is included if it is in either
-
- That is, the element is included if it exists in both sets. The
-
- This returns a set of all the elements in set
-
- The original sets are not modified during this operation. The - result set is a clone of this set containing the elements - from the exclusive-or operation. -
-
- That is, the element is included if it is in either
-
- That is, the element is included only if it exists in both
-
- This returns a set of all the elements in set
-
- The original sets are not modified during this operation. The
- result set is a clone of one of the sets (
-
- This will work for derived
- The type of array needs to be compatible with the objects in the
-
- In this case, "equality" means that the two sets contain the same
- elements. The "==" and "!=" operators are not overridden by design.
- If you wish to check for "equivalent"
-
- Note that enumeration is inherently not thread-safe. Use the
-
- When implementing this, if your object uses a base object, like an
-
- The type of array needs to be compatible with the objects in the
-
- Note that enumeration is inherently not thread-safe. Use the
-
- You can use any object that implements the
-
- This object overrides the
- To make a
- It is also standard practice that at least one of your constructors
- takes an
- The type of array needs to be compatible with the objects in the
-
- Set this object in the constructor if you create your own
-
- This class allows validation groups to reference validators that - are defined outside of the group itself. -
-
- It also allows users to narrow the context for the referenced validator
- by specifying value for the
- For example, objects can look up collaborating objects via the factory. -
-- Note that most objects will choose to receive references to collaborating - objects via respective properties and / or an appropriate constructor. -
-
- For a list of all object lifecycle methods, see the
-
- Invoked after population of normal object properties but before an init
- callback like
- Invoked after population of normal object properties but before an init
- callback like
- This is an
- This is an
- This is good if you are unsure about whether you data-set will be tiny - or huge. -
-
-
- The core Spring.NET library already provides three implementations of this interface - straight out of the box; they are... -
-
- If you have a custom collection class (i.e. a class that either implements the
-
- Lets say one has a
- using System;
-
- using Spring.Objects.Factory.Support;
-
- namespace MyNamespace
- {
- public sealed class Bag : ICollection
- {
- // ICollection implementation elided for clarity...
-
- public void Add(object o)
- {
- // implementation elided for clarity...
- }
- }
-
- public class ManagedBag : Bag, IManagedCollection
- {
- public ICollection Resolve(
- string objectName, RootObjectDefinition definition,
- string propertyName, ManagedCollectionElementResolver resolver)
- {
- Bag newBag = new Bag();
- string elementName = propertyName + "[bag-element]";
- foreach(object element in this)
- {
- object resolvedElement = resolver(objectName, definition, elementName, element);
- newBag.Add(resolvedElement);
- }
- return newBag;
- }
- }
- }
-
- - The nesting hierarchy of an object factory is taken into account by the various methods - exposed by this class. -
-
- For example, if the managed object identified as foo is a
- factory, getting &foo will return the factory, not the
- instance returned by the factory.
-
- This is a utility class, and as such has no publicly visible - constructors. -
-- Includes counts of ancestor object factories. -
-- Objects that are "overridden" (specified in a descendant factory - with the same name) are counted only once. -
-- Will return unique names in case of overridden object definitions. -
-
- Does consider objects created by
- Will return unique names in case of overridden object definitions. -
-
- Does consider objects created by
- The return list will only contain objects of this type. - Useful convenience method when we don't care about object names. -
-- Useful convenience method when we expect a single object and don't care - about the object name. -
-- Useful convenience method when we expect a single object and don't care - about the object name. -
-
- Useful convenience method when we expect a single object and don't care
- about the object name.
- This version of
- That is, does the supplied
- The "variable sources" are objects containing name-value pairs - that allow a variable value to be retrieved for the given name.
-- Out of the box, Spring.NET supports a number of variable sources, - that allow users to obtain variable values from .NET config files, - Java-style property files, environment, registry, etc.
-- Users can always write their own variable sources implementations, - that will allow them to load variable values from the database or - other proprietary data source.
-- The actual order can be interpreted as prioritization, the first object (with the - lowest order value) having the highest priority. -
-
- Normally starting with 0 or 1, with
- Higher value can be interpreted as lower priority, consequently the first object - has highest priority. -
-
- Application contexts can auto-detect
-
- Useful for custom config files targeted at system administrators that - override object properties configured in the application context. -
-- See PropertyResourceConfigurer and its concrete implementations for - out-of-the-box solutions that address such configuration needs. -
-- All object definitions will have been loaded, but no objects will have - been instantiated yet. This allows for overriding or adding properties - even to eager-initializing objects. -
-- All object definitions will have been loaded, but no objects will have - been instantiated yet. This allows for overriding or adding properties - even to eager-initializing objects. -
-
- This (default) implementation supports resolving
-
null.
-
- Typical use cases might include being used to suppress the default
- instantiation of specific target objects, perhaps in favour of creating
- proxies with special
- Application contexts can auto-detect
-
- Typically, post-processors that populate objects via marker interfaces
- or the like will implement
-
- The object will already be populated with property values. - The returned object instance may be a wrapper around the original. -
-- The object will already be populated with property values. The returned object - instance may be a wrapper around the original. -
-- The returned object may be a proxy to use instead of the target - object, effectively suppressing the default instantiation of the - target object. -
-
- If the object is returned by this method is not
-
- This callback will only be applied to object definitions with an - object class. In particular, it will not be applied to - objects with a "factory-method" (i.e. objects that are to be - instantiated via a layer of indirection anyway). -
-null).
- he relevant property infos for the target object (with ignored
- dependency types - which the factory handles specifically - already filtered out)
- The object instance created, but whose properties have not yet
- been set.
- Name of the object.
- null if not predictable.null if none specifiednull if not predictable.null if none specified- The returned object may be a proxy to use instead of the target - object, effectively suppressing the default instantiation of the - target object. -
-
- If the object is returned by this method is not
-
- This callback will only be applied to object definitions with an - object class. In particular, it will not be applied to - objects with a "factory-method" (i.e. objects that are to be - instantiated via a layer of indirection anyway). -
-null).
- he relevant property infos for the target object (with ignored
- dependency types - which the factory handles specifically - already filtered out)
- The object instance created, but whose properties have not yet
- been set.
- Name of the object.
- - The object will already be populated with property values. - The returned object instance may be a wrapper around the original. -
-- The object will already be populated with property values. The returned object - instance may be a wrapper around the original. -
-null).
- The relevant property infos for the target object (with ignored
- dependency types - which the factory handles specifically - already filtered out)
- The object instance created, but whose properties have not yet
- been set.
- Name of the object.
-
- This class contains the bulk of the localizer logic, including implementation
- of the
- All specific localizers need to do is inherit this class and implement
-
- Custom implementations can use whatever type of resource storage they want, - such as standard .NET resource sets, custom XML files, database, etc. -
-- Localizers are used to automatically apply resources to object's members - using reflection. -
-
- Currently only supports conversion from a
-
- This class supports checking the generic arguments count of both - generic methods and constructors. -
-
- This constructor sets the
-
- Note that if the
- This is an example of specifying a context that reads its resources from - an embedded Spring.NET XML object configuration file... -
-
-
-
-
-
-
-
-
-
-
-
-
-
- - This is an example of specifying a context that reads its resources from - a custom configuration section within the same application / web - configuration file and uses case insensitive object lookups. -
-- Please note that you must adhere to the naming - of the various sections (i.e. '<sectionGroup name="spring">' and - '<section name="context">'. -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - And this is an example of specifying a hierarchy of contexts. The - hierarchy in this case is only a simple parent->child hierarchy, but - hopefully it illustrates the nesting of context configurations. This - nesting of contexts can be arbitrarily deep, and is one way... child - contexts know about their parent contexts, but parent contexts do not - know how many child contexts they have (if any), or have references - to any such child contexts. -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This
- If this attribute is not defined it defaults to the
-
- Derived handlers may override this property to change their default case-sensitivity. -
-- Defaults to 'true'. -
-
- Does not have to be fully assembly qualified, but its generally regarded
- as better form if the
- Implementing this interface makes sense when an object requires access - to a set of collaborating objects. Note that configuration via object - references is preferable to implementing this interface just for object - lookup purposes. -
-
- This interface can also be implemented if an object needs access to
- file resources, i.e. wants to call
-
- Note that
-
- For a list of all object lifecycle methods, see the overview for the
-
- Normally this call will be used to initialize the object. -
-
- Invoked after population of normal object properties but before an
- init callback such as
-
- Currently only supports conversion from a
- Based on the Jakarta Commons Pool API. -
-
- By contract, clients must return the borrowed
- instance using
- By contract, the object must have been obtained using
-
- This is an optional operation. AddObject is useful for "pre-loading" a - pool with idle objects. -
-- This is an optional operation. -
-- This is an optional operation. -
-- This is an optional operation. -
-- This may be considered an approximation of the number of objects - that can be borrowed without creating any new instances. -
-- This is an optional operation. -
-
- Subclasses should also override
- Typically applied to a
-
- This class registers each object definition with the given object factory superclass,
- and relies on the latter's implementation of the
-
- It supports singletons, prototypes, and references to either of these kinds of object. -
-
- Can be added to object definitions to explicitly specify
- a target type for a
- This holder just stores the
- Obviously if the
-
<objects>
- level in a standard Spring XML object definition document:
- default-lazy-init, default-autowire, etc.
-
- The 'context' is determined by the appropriate implementation class.
- An example of such a context might be a thread local bound
-
- This is an optional operation and does not need to be implemented - such that it actually does anything useful (i.e. it can be a no-op). -
-- Not intended to be used directly by applications. -
-- This is a utility class, and as such exposes no public constructors. -
-
- If you require special
- Useful in AOP (as an expression of the AspectJ
- Available from
-
- A singleton implementation to access one or more application contexts. Application - context instances are cached. -
-Note that the use of this class or similar is unnecessary except (sometimes) for - a small amount of glue code. Excessive usage will lead to code that is more tightly - coupled, and harder to modify or test. Consider refactoring your code to use standard - Dependency Injection techniques or implement the interface IApplicationContextAware to - obtain a reference to an application context.
-- Explicit static constructor to tell C# compiler - not to mark type as beforefieldinit. -
-
- This is usually called via a
-
- The first call to GetContext will create the context - as specified in the .NET application configuration file - under the location spring/context. -
-- The first call to GetContext will create the context - as specified in the .NET application configuration file - under the location spring/context. -
-
- Note that
- You typically need an
- Invoked after population of normal objects properties but
- before an init callback such as
-
- This class groups validation errors by validator names and allows - access to both the complete errors collection and to the errors for a - certain validator. -
-
- If the supplied
- If there are no errors for the supplied
- If there are no errors for the supplied lookup
- If this returns
- If the supplied
- If there are no errors for the supplied lookup
- If there are no errors for the supplied lookup
- If this returns
This factory method will create a dynamic property with a "safe" wrapper.
-Safe wrapper will attempt to use generated dynamic property if possible, - but it will fall back to standard reflection if necessary.
-
- This class merely marshals the matching of handler methods to the events exposed
- by an event source, and then delegates to a concrete
-
- Note : the order in which handler's are wired up to events is non-deterministic. -
-
- This is the most common type of object definition;
-
- Note that
- This is just a minimal interface: the main intention is to allow
-
- If
- Only applicable to a singleton object. -
-
- If
- This determines whether any automagical detection and setting of
- object references will happen. Default is
-
- The object factory will guarantee that these objects get initialized - before. -
-- Note that dependencies are normally expressed through object properties - or constructor arguments. This property should just be necessary for - other kinds of dependencies like statics (*ugh*) or database - preparation on startup. -
-
- The default is
- The default is
- This method will be invoked with constructor arguments, or with no
- arguments if none are specified. The static method will be invoked on
- the specified
- If
- Only applicable to a singleton object. -
-
- If
- This determines whether any automagical detection and setting of
- object references will happen. Default is
-
- The object factory will guarantee that these objects get initialized - before. -
-- Note that dependencies are normally expressed through object properties - or constructor arguments. This property should just be necessary for - other kinds of dependencies like statics (*ugh*) or database - preparation on startup. -
-
- The default is
- The default is
- This method will be invoked with constructor arguments, or with no
- arguments if none are specified. The static method will be invoked on
- the specified
- This is an
- This is an
- This is an
- Setting the value of this property to
- Setting the value of this property to
- Setting the value of this property to
- Setting the value of this property to
- If
- Only applicable to a singleton object. -
-
- If
- This determines whether any automagical detection and setting of
- object references will happen. The default is
-
- This resolves
-
- The default is
-
- The object factory will guarantee that these objects get initialized - before this object definition. -
-
- The default value is the
- The default value is the
- This method will be invoked with constructor arguments, or with no
- arguments if none are specified. The
- Takes an object class name to avoid eager loading of the object class. -
-- Deep copy constructor. -
-- This class is Spring.NET's implementation of Dependency Lookup via - Method Injection. -
-- This class is reserved for internal use within the framework; it is - not intended to be used by application developers using Spring.NET. -
-- This class is reserved for internal use within the framework; it is - not intended to be used by application developers using Spring.NET. -
-- Encapsulates the notion of the Method-Injection form of Dependency - Injection. -
-
- Methods that are dependency injected with implementations of this
- interface may be (but need not be)
- Do not use this mechanism as a means of AOP. See the reference - manual for examples of appropriate usages of this interface. -
-
- This is an
- Useful for custom .NET .config files targetted at system administrators - that override object properties configured in the application context. -
-
- Two concrete implementations are provided in the Spring.NET core library:
-
-
-
- Please refer to the API documentation for the concrete implementations - listed above for example usage. -
-
- This is an
- Basically, if external locations are specified, ensure that either - one or a like number of config sections are also specified. -
-- When merging conflicting property overrides from several resources, - should append an override with the same key be appended to the - current value, or should the property override from the last resource - processed override previous values? -
-
- The default value is
- These are to be considered defaults, to be overridden by values - loaded from other resources. -
-
-
- Usually, the target object will reside in a different object
- definition file, using this
-
<alias>
- tag is available that effectively achieves the same.
- - The target object may potentially be defined in a different object - definition file. -
-
- Typically used for retrieving shared
- Because the
- The
- The
- This interface encapsulates a resource descriptor that abstracts away - from the underlying type of resource; possible resource types include - files, memory streams, and databases (this list is not exhaustive). -
-
- A
- This interface, when used in tandem with the
-
- Interfaces cannot obviously mandate implementation, but derived classes
- are strongly encouraged to expose a constructor that takes a
- single
- This is the base interface for the abstraction encapsulated by
- Spring.NET's
- If
- Will be
- For safety, always check the value of the
-
- For safety, always check the value of the
-
- The description is typically used for diagnostics and other such - logging when working with the resource. -
-
- Implementations are also encouraged to return this value from their
-
- An example of a resource that physically exists would be a - file on a local filesystem. An example of a resource that does not - physically exist would be an in-memory stream. -
-
- Will be resolved (by those
- For example, in the case of a web application this will (probably) - resolve to the virtual directory of said web application. -
-
- This is an
- This is an
- If the supplied
- GetResourceNameWithoutProtocol("http://www.mycompany.com/resource.txt");
- // returns www.mycompany.com/resource.txt
-
-
- The default implementation simply returns the supplied
-
- This implementation compares
- This implementation returns the hashcode of the
-
- This method can accept either a fully qualified resource name or a - relative resource name as it's parameter. -
-- A fully qualified resource is one that has a protocol prefix and - all elements of the resource name. All other resources are treated - as relative to this resource, and the following rules are used to - locate a relative resource: -
-
- Will be resolved (by those
- For example, in the case of a web application this will (probably) - resolve to the virtual directory of said web application. -
-
- The value of this property may be
- This, the default implementation, always returns
-
- This, the default implementation, always throws a
-
- This, the default implementation, always throws a
-
- This implementation checks whether a
- This will cover both directories and content resources. -
-
- This implementation will also return
- This property is generally to be consulted prior to attempting
- to attempting to access a resource that is relative to this
- resource (via a call to
-
- This, the default implementation, always returns
-
- Where root resource can be taken to mean that part of the resource - descriptor that doesn't change when a relative resource is looked - up. Examples of such a root location would include a drive letter, - a web server name, an assembly name, etc. -
-- An example value of this property would be the name of the - directory containing a filesystem based resource. -
-
- An example value of this property would be the
-
- Any derived classes that override this method are expected to - return a new array for each access of this property. -
-
- Navigates through an XML resource and invokes parsers registered
- with the
RegisterObjectDefinitions
- method, for example global settings that are defined for all object definitions
- in the document.
- The default implementation is empty. Subclasses can override this method to - convert custom elements into standard Spring object definitions, for example. - Implementors have access to the parser's object definition reader and the - underlying XML resource, through the corresponding properties. -
-
- Classes that want to take advantage of method injection must meet some
- stringent criteria. Every method that is to be method injected
- must be defined as either
- Does not support method injection, although it provides hooks for subclasses - to override to add method injection support, for example by overriding methods. -
-
- The default implementation of this method is to throw a
-
- Derived classes can override this method if they can instantiate an object
- with the Method Injection specified in the supplied
-
- The default implementation of this method is to throw a
-
- Derived classes can override this method if they can instantiate an object
- with the Method Injection specified in the supplied
-
- This method dynamically generates a subclass that supports method
- injection for the supplied
- This class is designed as for
- Exists so that clients of this class can use this name to set properties reflectively - on the dynamically generated subclass. -
-- Exists so that clients of this class can use this name to set properties reflectively - on the dynamically generated subclass. -
-- Since we are simply overridding a method (in this method - injection context), all we do here is simply copy the - parameters (since we want a method with the exact same parameters). -
-- Only makes sense in the context of a singleton object. -
-
- Please note that changing the value of this property after
- this factory object instance has been created by an enclosing
- Spring.NET IoC container really is a programming error. This
- property should really only be set once, prior to the invocation
- of the
-
- This value will be used to populate the
- The default is the
-
- Typically not directly used by application code but rather implicitly
- via an
- Implementing classes have the ability to get and set property values - (individually or in bulk), get property descriptors and query the - readability and writability of properties. -
-- This interface supports nested properties enabling the setting - of properties on subproperties to an unlimited depth. -
-
- If a property update causes an exception, a
-
-
- This is the preferred way to update an individual property. -
-
- This method is provided for convenience only. The
-
- This is the preferred way to perform a bulk update. -
-
- Note that performing a bulk update differs from performing a single update,
- in that an implementation of this class will continue to update properties
- if a recoverable error (such as a vetoed property change or a type
- mismatch, but not an invalid property name or the like) is
- encountered, throwing a
-
- Does not allow the setting of unknown fields. Equivalent to
-
- Note that performing a bulk update differs from performing a single update,
- in that an implementation of this class will continue to update properties
- if a recoverable error (such as a vetoed property change or a type
- mismatch, but not an invalid property name or the like) is
- encountered, throwing a
-
Does not allow the setting of unknown fields. -
-- Implementations are required to allow the type of the wrapped - object to change. -
-- The wrapped target instance will need to be set afterwards. -
-
- Please note that the
- This method is provided for convenience only. The
-
- This is the preferred way to update an individual property. -
-
- Does not allow unknown fields. Equivalent to
-
- This method may throw a reflection-based exception, if there is a critical
- failure such as no matching field... less serious exceptions will be accumulated
- and thrown as a single
- Do not use this (convenience) method prior to setting the
-
- The rationale behind the creation of this interface is to centralise
- the resolution of type names to
- Currently only supports conversion from a
-
- Handles conversion from an XML formatted string to a
-
- This converter must be registered before it will be available. Standard
- converters in this namespace are automatically registered by the
-
- Find below some examples of the XML formatted strings that this
- converter will sucessfully convert. Note that the name of the top level
- (document) element is quite arbitrary... it is only the content that
- matters (and which must be in the format
-
-
-
-
- - The following example uses a different top level (document) element - name, but is equivalent to the first example. -
-
-
-
-
-
- Currently only supports conversion from an
- XML formatted
Subclasses must implement the abstract ResolveObject
- method.
Note: By default, message texts are only parsed through - String.Format if arguments have been passed in for the message. In case - of no arguments, message texts will be returned as-is. As a consequence, - you should only use String.Format escaping for messages with actual - arguments, and keep all other messages unescaped. -
-Supports not only IMessageSourceResolvables as primary messages - but also resolution of message arguments that are in turn - IMessageSourceResolvables themselves. -
-This class does not implement caching of messages per code, thus - subclasses can dynamically change messages over time. Subclasses are - encouraged to cache their messages in a modification-aware fashion, - allowing for hot deployment of updated messages. -
-
- If the value of this property is
- If the lookup is not successful, implementations are permitted to - take one of two actions. -
- If the lookup is not successful throw NoSuchMessageException -- If the lookup is not successful throw NoSuchMessageException. -
-- If the lookup is not successful throw NoSuchMessageException -
-- Subclasses must implement this method to resolve an object. -
-- Subclasses must implement this method to apply resources - to an arbitrary object. -
-Note: In case of a IMessageSourceResolvable with multiple codes - (like a FieldError) and a MessageSource that has a parent MessageSource, - do not activate "UseCodeAsDefaultMessage" in the parent: - Else, you'll get the first code returned as message by the parent, - without attempts to check further codes.
-To be able to work with "UseCodeAsDefaultMessage" turned on in the parent,
- AbstractMessageSource contains special checks
- to delegate to the internal GetMessageInternal method if available.
- In general, it is recommended to just use "UseCodeAsDefaultMessage" during
- development and not rely on it in production in the first place, though.
Alternatively, consider overriding the GetDefaultMessage
- method to return a custom fallback message for an unresolvable code.
- If the value of this property is
- The list may contain objects of type
- Spring.NET's own validation error classes implement this interface. -
-- The last code will therefore be the default one. -
-
- The primary motivation of this class is to avoid having a client object
- directly calling the
-
- The object referred to by the value of the
-
- The following XML configuration snippet illustrates the use of this - class... -
-
-
-
-
-
-
-
-
-
-
-
- Because the
-
- The following examples all assume XML based configuration, and use
- inner object definitions to define the custom
-
-
-
-
- The following example illustrates a complete (albeit naieve) use case
- for this class, including a custom
-
- The domain class is a simple data-only object that contains the data
- required to send an email message (such as the host and user account
- name). A developer would prefer to use a string of the form
-
- namespace ExampleNamespace
- {
- public sealed class MailSettings
- {
- private string _userName;
- private string _password;
- private string _host;
-
- public string Host
- {
- get { return _host; }
- set { _host = value; }
- }
-
- public string UserName
- {
- get { return _userName; }
- set { _userName = value; }
- }
-
- public string Password
- {
- get { return _password; }
- set { _password = value; }
- }
- }
-
- public sealed class MailSettingsConverter : TypeConverter
- {
- public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
- {
- if (typeof (string) == sourceType)
- {
- return true;
- }
- return base.CanConvertFrom(context, sourceType);
- }
-
- public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
- {
- string text = value as string;
- if(text != null)
- {
- MailSettings mailSettings = new MailSettings();
- string[] tokens = text.Split(',');
- for (int i = 0; i < tokens.Length; ++i)
- {
- string token = tokens[i];
- string[] settings = token.Split('=');
- typeof(MailSettings).GetProperty(settings[0])
- .SetValue(mailSettings, settings[1], null);
- }
- return mailSettings;
- }
- return base.ConvertFrom(context, culture, value);
- }
- }
-
- // a very naieve class that uses the MailSettings class...
- public sealed class ExceptionLogger
- {
- private MailSettings _mailSettings;
-
- public MailSettings MailSettings {
- {
- set { _mailSettings = value; }
- }
-
- public void Log(object value)
- {
- Exception ex = value as Exception;
- if(ex != null)
- {
- // use _mailSettings instance...
- }
- }
- }
- }
-
- - The attendant XML configuration for the above classes would be... -
-
-
-
-
-
- The
-
- IDictionary converters = new Hashtable();
- converters.Add( "System.Date", new MyCustomDateConverter() );
- // a System.Type instance can also be used as the key...
- converters.Add( typeof(Color), new MyCustomRBGColorConverter() );
-
-
ObjectDefinitionBuilder used to construct a root object definition.
- ObjectDefinitionBuilder instance.ObjectDefinitionBuilder used to construct a root object definition.
- ObjectDefinitionBuilder instance.ObjectDefinitionBuilder used to construct a root object definition.
- ObjectDefinitionBuilder instance.ObjectDefinitionBuilder used to construct a root object definition.
- ObjectDefinitionBuilder instance.ObjectDefinitionBuilder used to construct a child object definition..
- ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.ObjectDefinitionBuilder.
- This constructor sets the
-
Strings in attribute name format (lowercase, hyphens separating words)
- into property name format (camel-cased). For example, transaction-manager is
- converted into transactionManager.
-
- The implementations in this class are appropriate when the base
- implementation does not allow
- Besides basic
- Each of these methods exists in two forms: one throws
- an exception if the operation fails, the other returns a special
- value (either
- Queues typically, but do not necessarily, order elements in a
- FIFO (first-in-first-out) manner. Among the exceptions are
- priority queues, which order elements according to a supplied
- comparator, or the elements' natural ordering, and LIFO queues (or
- stacks) which order the elements LIFO (last-in-first-out).
- Whatever the ordering used, the head of the queue is that
- element which would be removed by a call to
-
- The
- The
- The
- The
-
-
- Based on the back port of JCP JSR-166. -
-
- When using a capacity-restricted queue, this method is generally
- preferable to
- This method differs from
- This method differs from
- This is an abstract class, and as such has no publicly - visible constructors. -
-
- This method differs from
-
- This method differs from
- ALso note that this implementation returns the result of
-
- The queue will be empty after this call returns. -
-
- This implementation repeatedly invokes
-
- Attempts to
-
- This implementation iterates over the specified collection,
- and adds each element returned by the iterator to this queue, in turn.
- An exception encountered while trying to add an element (including,
- in particular, a
- When using a capacity-restricted queue, this method is generally
- preferable to
- When using a capacity-restricted queue, this method is generally
- preferable to
- This attribute allows application developers to specify that each item - from the collection returned by the method should be cached, - but it will not do any caching by itself. -
-
- In order to actually cache the result, an application developer
- must apply a
- Test can be any logical expression that is supported by the Spring.NET logical - expression evaluation engine, and can use any variables that can be resolved - by the variable resolver used by the validation engine. -
-- An object of this class is created at the beginning of the binding - process, and errors added to it as necessary. -
-
- The binding process continues when it encounters application-level
-
- Will return the empty array (not
- Note that this mechanism is not intended as a generic means of - inserting crosscutting code: use AOP for that. -
-- Note that the override mechanism is not intended as a generic means of - inserting crosscutting code: use AOP for that. -
-
- This is an
- By 'match' one means does this particular
-
- This allows for argument list checking as well as method name checking. -
-
- If
- Setting the value of this property to
- If a
- This is a convenience method that registers the
-
- This is a utility class, and as such exposes no public constructors. -
-
- This class provides singleton / prototype determination, singleton caching,
- object definition aliasing,
- This constructor implicitly creates an
-
- This is an
- This is an
- This is an
- The object definition can either define a fully self-contained object, - reusing it's property values, or just property values meant to be used - for existing object instances. -
-- The object definition will already have been merged with the parent - definition in case of a child definition. -
-- All the other methods in this class invoke this method, although objects - may be cached after being instantiated by this method. All object - instantiation within this class is performed by this method. -
-- Must destroy objects that depend on the given object before the object itself, - nor throw an exception. -
-
- Does not consider any hierarchy this factory may participate in.
- Invoked by
-
- To be called for eager registration of singletons, e.g. to be able to - resolve circular references. -
-- Will ask the parent object factory if not found in this instance. -
-GetObject
- to call its ObjectType property. Subclasses are encouraged to optimize
- this, typically by just instantiating the FactoryObject but not populating it yet,
- trying whether its ObjectType property already returns a type.
- If no type found, a full FactoryObject creation as performed by this implementation
- should be used as fallback.
- null otherwisenull if not predictableResolveObjectType method. Subclasses may override this to use
- a differnt strategy.
- Will not consider
- Does not consider any hierarchy this factory may participate in. -
-
- More specifically, checks the
- Please note that (prototype) objects created via a factory method or
-
- This, the default, implementation returns
- Does not consider any hierarchy this factory may participate in. -
-- Does not consider any hierarchy this factory may participate in. -
-
- Delegates to
-
- This method allows an object factory to be used as a replacement for the - Singleton or Prototype design pattern. -
-- Note that callers should retain references to returned objects. There is no - guarantee that this method will be implemented to be efficient. For example, - it may be synchronized, or may need to run an RDBMS query. -
-- Will ask the parent factory if the object cannot be found in this factory - instance. -
-
- The elements of this
class attribute thet can be resolved
- as a type
-
- - Typically happens when constructor autowiring matches the currently - constructed object. -
-- This does not mark this object as being a reference to - another object in any parent factory. -
-- This variant constructor allows a client to specifiy whether or not - this object is a reference to another object in a parent factory. -
-
- Allows simple manipulation of properties, and provides constructors to
- support deep copy and construction from a number of collection types such as
-
- The returned instance is initially empty...
-
- Deep copy constructor. Guarantees
- The returned
- Recognized by
-
- Can also be used for programmatic registration of inner object
- definitions. If you don't care about the functionality offered by the
-
- Guaranteed to never return
- Preparing this object once and reusing it many times for expression - evaluation can result in significant performance improvements, as - expression parsing and reflection lookups are only performed once. -
-
- Currently only supports conversion from a
- Used in the first instance to supply stringified versions of
-
- Other methods can be added here to return different representations, - including XML, CSV, etc.. -
-- It saves the application context reference and provides an - initialization callback method. Furthermore, it offers numerous - convenience methods for message lookup. -
-- There is no requirement to subclass this class: it just makes things - a little easier if you need access to the context, e.g. for access to - file resources or to the message source. Note that many application - objects do not need to be aware of the application context at all, - as they can receive collaborating objects via object references. -
-
- This is an
- This is an
- This is a template method that subclasses can override for custom - initialization behavior. -
-
- Gets called by the
-
- Does not mandate the type of storage used for configuration, but does
- implement common functionality. Uses the Template Method design
- pattern, requiring concrete subclasses to implement
-
- In contrast to a plain vanilla
-
- An
- This
- Basic protocol-to-resource type mappings are also defined by this class, - while others can be added either internally, by application contexts - extending this class, or externally, by the end user configuring the - context. -
-
- Only one resource type can be defined for each protocol, but multiple
- protocols can map to the same resource type (for example, the
-
-
-
-
- The initial value is
- If no
- If no
- This is an
- This is an
- This is an
- This method is invoked by
-
- All object definitions will have been loaded, but no objects
- will have been instantiated yet. This allows for the registration
- of special
-
- Called on initialization of special objects, before instantiation - of singletons. -
-- Uses any parent context's message source if one is not available - in this context. -
-- This method allows an object factory to be used as a replacement for the - Singleton or Prototype design pattern. -
-- Note that callers should retain references to returned objects. There is no - guarantee that this method will be implemented to be efficient. For example, - it may be synchronized, or may need to run an RDBMS query. -
-- Will ask the parent factory if the object cannot be found in this factory - instance. -
-- -
-
- The elements of this list are instances of implementations of the
-
- This is an
- This is an
- The default implementation of this method is a no-op; i.e. it does
- nothing. Can be overridden in subclasses to provide custom
- initialization of the supplied
-
- The lifecycle of the object factory is handled by
-
- The default implementation is empty. Can be overriden in subclassses to customize - DefaultListableBeanFatory's standard settings. -
- Called for each
- Examples of the format of the various strings that would be
- returned by accessing this property can be found in the overview
- documentation of with the
- Intended for use during debugging only. -
-
- Only
- This implementation delegates the call to a base class constructor. -
-- Based on the implementation found in Concurrent Programming in Java, - 2nd ed., by Doug Lea. -
-
- This implementation always throws a
-
- This implementation always throws a
-
- This implementation always throws a
-
- This is an
- This is an
- The target object can be specified directly or via an object name (see - example below). -
-
- Please note that the
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Note that most objects will choose to receive references to collaborating - objects via respective properties. -
-
- For a list of all object lifecycle methods, see the
-
- Invoked after population of normal object properties but before an init
- callback like
- This would most likely be an inner object, but can of course be - any object reference. -
-
- Please note that any leading or trailing whitespace will be
- trimmed from this name prior to resolution. The implication of this is that
- one cannot use the
- Please note that any leading or trailing whitespace will be - trimmed from this path prior to resolution. Whitespace is not a valid - identifier for property names (in part or whole) in CLS-based languages, - so this is a not unreasonable action. Please also note that whitespace - that is embedded within the property path will be left as-is (which may - or may not result in an error being thrown, depending on the context of - the whitespace). -
-- Examples of such property lookup paths can be seen below; note that - property lookup paths can be nested to an arbitrary level. -
-
- name.length
- accountManager.account['the key'].name
- accounts[0].name
-
-
- This is not necessary for directly specified target objects, or
- singleton target objects, where the
- It is permissable to set the value of this property to
-
- The object name of this
-
- This allows for concise object definitions with just an id or name. -
-
- This interface only applies to objects that have been instantiated
- within the context of an
-
- This property will be set by the relevant
-
IObjectDefinition, you may wish to consider
- the simpler convenience extensions of this class, namely
- - This method is never invoked if the parser is namespace aware - and was called to process the root node. -
-- This method is never invoked if the parser is namespace aware - and was called to process the root node. -
-IsNested
- parameter is false, because one typically does not want inner objects
- to be registered as top level objects.
- GetObjectTypeName instad, in order to avoid a direct
- dependence on the object implementation class. The ObjectDefinitionParser
- and its IXmlObjectDefinitionParser (namespace parser) can be used within an
- IDE add-in then, even if the application classses are not available in the add-ins
- AppDomain.
- DoParse version without
- ParameterContext argument.IObjectDefinition.
- IObjectDefinition.
-
-
- Please note that this class does not implement converting
- to a comma separated list of RBG values from a
-
- Currently only supports conversion from a
-
- Obviously supports resolution as a
- Some examples of the strings that can be used to initialize a new
- instance of the
-
-
- Some examples of the values that the
-
-
- This implementation does support relative resource retrieval, and
- so will always return
- Mainly useful for testing. -
-
- This
- Uses a System.ComponentModel.ComponentResourceManager
- internally to apply resources to object properties. Resource key
- names are of the form
- This feature is not currently supported on version 1.0 of the .NET platform. -
-- Type converters are used to convert objects from one type into another - when injecting property values, evaluating expressions, performing data - binding, etc. -
-- They are a very powerful mechanism as they allow Spring.NET to automatically - convert string-based property values from the configuration file into the appropriate - type based on the target property's type or to convert string values submitted - via a web form into a type that is used by your data model when Spring.NET data - binding is used. Because they offer such tremendous help, you should always provide - a type converter implementation for your custom types that you want to be able to use - for injected properties or for data binding. -
-
- The standard .NET mechanism for specifying type converter for a particular type is
- to decorate the type with a
- This mechanism will still work and is a preferred way of defining type converters if - you control the source code for the type that you want to define a converter for. However, - this configuration section allows you to specify converters for the types that you don't - control and it also allows you to override some of the standard type converters, such as - the ones that are defined for some of the types in the .NET Base Class Library. -
-- The following example shows how to configure both this section handler and - how to define type converters within a Spring.NET config section: -
-
-
-
-
-
-
-
-
-
-
- ...
-
-
-
-
- Raising events defensively means that as the raised event is passed to each handler,
- any
- Sample usage. Here are a set of classes that use - a latch as a start signal for a group of worker threads that - are created and started beforehand, and then later enabled. -
-
- The following methods summarize the contract between an
-
- Based on the Jakarta Commons Pool API. -
-
- Invoked on every instance when it is being "dropped"
- from the pool (whether due to the return value from a call to the
-
- Invoked in an implementation-specific fashion to determine if an - instance is still valid to be returned by the pool. - It will only be invoked on an "activated" instance. -
-- Invoked on every instance before it is returned from the pool. -
-- Invoked on every instance when it is returned to the pool. -
-- Typically used for retrieving public property values. -
-- If this property is not set, or the value passed to the setter invocation - is a null or zero-length array, a property with no arguments is assumed. -
-
- Refers to either a
- An example of a situation when this exception would be thrown is - in the case of an XML document containing object definitions being - malformed. -
-null
-
- Because the
- The
- This class allows users to get or set properties, execute methods, and evaluate - logical and arithmetic expressions. -
-
- Methods in this class parse expression on every invocation.
- If you plan to reuse the same expression many times, you should prepare
- the expression once using the static
- This can result in significant performance improvements as it avoids expression - parsing and node resolution every time it is called. -
--
-- Simplifies configuration by allowing aliases to be used instead of - fully qualified type names. -
-
- Comes 'pre-loaded' with a number of convenience alias' for the more
- common types; an example would be the '
- This overload does eager resolution of the
- Typically thrown when attempting to read the value of a write-only - property via reflection. -
-
- Useful when filtering
- A resource path may contain placeholder variables of the form
- Currently only supports conversion from a
- On Win9x boxes, this resource path,
- // assuming a user called Rick, running on a plain vanilla Windows XP setup...
- // this resource path...
-
- ${userprofile}\objects.xml
-
- // will become (after expansion)...
-
- C:\Documents and Settings\Rick\objects.xml
-
- - This implementation resolves environment variables only. -
-
- Performance is much better for very small lists than either
-
- Follows the standard .NET conventions for default values where
- relevant; for example, all numeric types default to the value
-
- [C#]
- Given an array containing the following objects,
- [83, "Foo", new object ()], the [Int32, String, Object].
-
- Includes non-public methods in the methods searched. -
-
- Note that if a non-
- If the
- Used by
<property> tag.
- - Default is true. -
-- owner.(singleton)=true -
-- Default is false. -
-- owner.(lazy-init)=true -
-- Whether this is a reference to a singleton or a prototype - will depend on the definition of the target object. -
-
- Similar syntax as for an
- Ignores ineligible properties. -
-- Ignores ineligible properties. -
-- This is a utility class, and as such has no publicly - visible constructors. -
-
- A direct match, i.e. type MyInteger -> arg of class MyInteger, does not increase
- the result - all direct matches means weight zero (0). A match between the argument type
-
- Therefore, with an argument of type
- All argument weights get accumulated. -
-- The result will contain public constructors first, with a decreasing number - of arguments, then non-public constructors, again with a decreasing number - of arguments. -
-
- Currently only supports conversion from a
- Currently only supports conversion from a
- Can use a given
- This is not meant to be used as a system
-
- Currently only supports conversion from a
-
- If the mapping already exists, the existing mapping will be - silently overwritten with the new mapping. -
-- If the mapping already exists, the existing mapping will be - silently overwritten with the new mapping. -
-
- Supports resolution as both a
- Also supports the use of the
- Consider the example of an application that is running (has been launched
- from) the
- strings.txt C:\App\strings.txt
- ~/strings.txt C:\App\strings.txt
- file://~/strings.txt C:\App\strings.txt
- file://~/../strings.txt C:\strings.txt
- ../strings.txt C:\strings.txt
- ~/../strings.txt C:\strings.txt
-
- // note that only a leading ~ character is resolved to the executing directory...
- stri~ngs.txt C:\App\stri~ngs.txt
-
-
- This implementation does support relative resource retrieval, and
- so will always return
- Simply returns the configuration section as an
- If an object's class implements more than one of the
-
-
-
- Application contexts will automatically register this with their - underlying object factory. Applications should thus never need to use - this class directly. -
-
- In the current implementation, the
-
- The
- Invoked after population of normal object properties but
- before an initializing callback such as the
-
- It is also invoked before the
-
- This attribute allows application developers to specify that an argument - of the method should be cached, but it will not do any caching by itself. -
-
- In order to actually cache the result, an application developer
- must apply a
- You can specify this attribute multiple times on the same method in order to - cache several method parameters. -
-
- This class implements template
- This interface allows us to define the actions that should be executed - after validation in a generic fashion. -
-
- For example, addition of error messages to validation errors collection
- is performed by one specific implementation of this interface,
- This method will never return
- Primary purpose of this method is to allow us to parse and - load configuration sections using the same API regardless - of the .NET framework version. -
-- If Microsoft paid a bit more attention to preserving backwards - compatibility we would not even need it, but... :( -
-- Primary purpose of this method is to allow us to parse and - load configuration sections using the same API regardless - of the .NET framework version. -
-- If Microsoft paid a bit more attention to preserving backwards - compatibility we would not even need it, but... :( -
-- Parses object definitions according to the standard Spring.NET schema. -
-- This schema is typically located at - http://www.springframework.net/xsd/spring-objects.xsd. -
-<property> tag.
- - Object elements specify their canonical name via the "id" attribute - and their aliases as a delimited "name" attribute. -
-- If no "id" is specified, uses the first name in the "name" attribute - as the canonical name, registering all others as aliases. -
-- Called when an object definition has not been explicitly defined - with an id. -
-- Please note that even though this method is named GetPropertyValue, - it is called by both the property and constructor argument element - handlers. -
-- Uses a namespace manager if necessary. -
-- Uses a namespace manager if necessary. -
-
- If the supplied
- If the supplied
- If the supplied
- Methods eligible for lookup override must not have arguments. -
-- Methods eligible for lookup override must not have arguments. -
-
- An object is a factory if it implements (either directly or indirectly
- via inheritance) the
- The default placeholder syntax follows the NAnt style:
- The following example XML context definition defines an object that has
- a number of placeholders. The placeholders can easily be distinguished
- by the presence of the
-
-
- - The associated XML configuration file for the above example containing the - values for the placeholders would contain a snippet such as .. -
-
-
-
-
- - The preceding XML snippet listing the various property keys and their - associated values needs to be inserted into the .NET config file of - your application (or Web.config file for your ASP.NET web application, - as the case may be), like so... -
-
-
-
-
-
-
-
-
-
-
- In contrast to the
-
- If a configurer cannot resolve a placeholder, and the value of the
-
- The default implementation delegates to
-
- This (the default) implementation simply looks up the value of the
- supplied
- Subclasses can override this for customized placeholder-to-key - mappings or custom resolution strategies, possibly just using the - given name value collection as fallback. -
-
- See the overview of the
-
- Defaults to using the
- If you want to provide your own list separator, you can set the value of the
-
- Please note that the individual elements of a string will be passed - through as is (i.e. no conversion or trimming of surrounding - whitespace will be performed). -
-
- This
- public class StringArrayConverterExample
- {
- public static void Main()
- {
- StringArrayConverter converter = new StringArrayConverter();
-
- string csvWords = "This,Is,It";
- string[] frankBoothWords = converter.ConvertFrom(csvWords);
-
- // the 'frankBoothWords' array will have 3 elements, namely
- // "This", "Is", "It".
-
- // please note that extraneous whitespace is NOT trimmed off
- // in the current implementation...
- string csv = " Cogito ,ergo ,sum ";
- string[] descartesWords = converter.ConvertFrom(csv);
-
- // the 'descartesWords' array will have 3 elements, namely
- // " Cogito ", "ergo ", "sum ".
- // notice how the whitespace has NOT been trimmed.
- }
- }
-
-
- Currently only supports conversion from a
- Spring.NET allows the registration of custom configuration parsers that - can be used to create simplified configuration schemas that better - describe object definitions. -
-- For example, Spring.NET uses this facility internally in order to - define simplified schemas for various AOP, Data and Services definitions. -
-- The following example shows how to configure both this section handler - and how to define custom configuration parsers within a Spring.NET - config section. -
-
-
-
-
-
-
-
-
-
-
- ...
-
-
-
-
- The implementation is extremely conservative, serializing critical
- sections to prevent possible deadlocks, and locking on everything. The
- one exception is for enumeration, which is inherently not thread-safe.
- For this, you have to
- The type of array needs to be compatible with the objects in the
-
- In addition to synchronizing reads, this implementation also fixes
- IEnumerator/ICollection issue described at
- http://msdn.microsoft.com/netframework/programming/breakingchanges/runtime/clr.aspx
- (search for SynchronizedHashtable for issue description), by implementing
-
- This class should be used whenever a truly synchronized
- The type of array needs to be compatible with the objects in this - list, obviously. -
-- Enumerators are fail fast. -
-
- This is the indexer for the
-
- Note that enumeration is inherently not thread-safe. Use the
-
- This validator will be valid only when all of the validators in the
- You can specify if you want to validate all of the collection elements regardless of the errors, by
- setting the
- If you set the
- The purpose of this class is to provide a simple abstraction for creating and managing dynamic assemblies. -
-The following excerpt from
- public class DynamicProxyManager
- {
- public const string PROXY_ASSEMBLY_NAME = "Spring.Proxy";
-
- public static TypeBuilder CreateTypeBuilder(string name, Type baseType)
- {
- // Generates type name
- string typeName = String.Format("{0}.{1}_{2}", PROXY_ASSEMBLY_NAME, name, Guid.NewGuid().ToString("N"));
- ModuleBuilder module = DynamicCodeManager.GetModuleBuilder(PROXY_ASSEMBLY_NAME);
- return module.DefineType(typeName, PROXY_TYPE_ATTRIBUTES);
- }
- }
-
-
- Typically implemented by object factories that work with the
-
- Must support
-
- Will ask the parent factory if the object cannot be found in this - factory instance. -
-- Note that non-factory-aware initialization methods like AfterPropertiesSet () - or a custom "init-method" can throw any exception. -
-
- Instances of this class override already existing values, and is
- thus best suited to replacing defaults. If you need to replace
- placeholder values, consider using the
-
- In contrast to the
-
- Each line in a referenced configuration file is expected to take the - following form... -
-
-
-
- The
- Please note that in the case of multiple
-
- The following XML context definition defines an object that has a number - of properties, all of which have default values... -
-
-
-
- - What follows is a .NET config file snippet for the above example (assuming - the need to override one of the default values)... -
-
-
-
-
-
-
-
-
- - All object definitions will have been loaded, but no objects will have - been instantiated yet. This allows for overriding or adding properties - even to eager-initializing objects. -
-
- Provides some additional properties over and above the name of the
- property that has changed (which is inherited from the
-
- Must support
-
Refresh to initialize the
- objects factory and its contained objects with application context
- semantics (autodecting IObjectFactoryPostProcessors, etc).
- This gives good performance for operations on very large data-sets,
- though not as good - asymptotically - as a
-
- Elements that you put into this type of collection must implement
-
- This
- This attribute allows application developers to specify that some - cache items should be evicted from cache when the method is invoked, - but it will not do any eviction by itself. -
-
- In order to actually evict cache items, an application developer
- must apply a
- If the target object returns reference to itself -- 'this' -- - we need to treat it as a special case and return a reference - to a proxy object instead. -
-
- If the
- This class is reserved for internal use within the framework; it is - not intended to be used by application developers using Spring.NET. -
-- Allows for replaceable object definition factories using the Strategy - pattern. -
-null if the
- default have not yet been initialized.
-
- Currently only supports conversion from a
-
- Find below some examples of the XML formatted strings that this - converter will sucessfully convert. -
-
-
-
-
-
- Currently only supports conversion from a
- Non-
- Uses direct evaluation instead of
- If created with the name of a configuration section, then all methods
- aside from the description return
- This implementation always returns
- This implementation always returns
- This implementation always returns
- Introduced to accomodate line info tracking during parsing. -
-- Mainly useful for testing. -
-
- This validator will be valid when one and only one of the validators in the
-
<property> tag.
- id attribute specified are registered
- as separate object definitions within application context.
-
- This value will be used to populate the
- The default is the
- Supports values for a specific index or parameter name (case
- insensitive) in the constructor argument list, and generic matches by
-
- Only necessary for manipulating a registered value, for example in
-
- Applications will typically want to use an
-
- -
-
- It tries to get the
- The 'context' in this implementation is the
-
- Should only be used if no other
- In contrast to other
- This implementation expects any resource name passed to the - constructor to adhere to the following format: -
-- assembly://assemblyName/namespace/resourceName -
-
- This implementation does support relative resource retrieval, and
- so will always return
Base class for counting semaphores based on Semaphore implementation - from Doug Lea.
-Conceptually, a semaphore - maintains a set of permits. Each acquire() blocks if - necessary until a permit is available, and then takes it.
- -Each release adds a permit. However, no actual permit objects are used; - the Semaphore just keeps a count of the number available - and acts accordingly.
- -A semaphore initialized to 1 can serve as a mutual exclusion lock.
- - Used for implementation of aCreate a Semaphore with the given initial number of permits.
-Using a seed of 1 makes the semaphore act as a mutual - exclusion lock.
- -Negative seeds are also allowed, - in which case no acquires will proceed until the number of - releases has pushed the number of permits past 0.
-release(n) is
- equivalent in effect to:
- - for (int i = 0; i < n; ++i) release(); -- But may be more efficient in some semaphore implementations. -
- The
- Delegates to
-
- This class registers each object definition with the
-
- This class is a full-fledged object factory based on object definitions - that is usable straight out of the box. -
-- Can be used as an object factory in and of itself, or as a superclass - for custom object factory implementations. Note that readers for - specific object definition formats are typically implemented separately - rather than as object factory subclasses. -
-
- For an alternative implementation of the
-
- Provides object creation, initialization and wiring, supporting - autowiring and constructor resolution. Handles runtime object - references, managed collections, and object destruction. -
-
- The main template method to be implemented by subclasses is
-
- This is an
- This is an
null if not predictable
- - The returned instance may be a wrapper around the original. -
-- Must use deep copy, so that we don't permanently modify this property. -
-
- These are probably unsatisfied references to other objects in the
- factory. Does not include simple properties like primitives or
-
- To be called on shutdown of a factory. -
-- This is like PicoContainer default, in which there must be exactly one object - of the property type in the object factory. This makes object factories simple - to configure for small namespaces, but doesn't work as well as standard Spring - behavior for bigger applications. -
-
- Delegates to the
-
- The object definition will already have been merged with the parent - definition in case of a child definition. -
-- All the other methods in this class invoke this method, although objects - may be cached after being instantiated by this method. All object - instantiation within this class is performed by this method. -
-- The object definition will already have been merged with the parent - definition in case of a child definition. -
-- All the other methods in this class invoke this method, although objects - may be cached after being instantiated by this method. All object - instantiation within this class is performed by this method. -
-
- The method may be static, if the
- Implementation requires iterating over the static or instance methods
- with the name specified in the supplied
- Also applied if explicit constructor argument values are specified, - matching all remaining arguments with objects from the object factory. -
-- This corresponds to constructor injection: in this mode, a Spring.NET - object factory is able to host components that expect constructor-based - dependency resolution. -
-
- 'Resolve' can be taken to mean that all of the
- These resolved values are plugged into the supplied
-
- This method is also used for handling invocations of static factory methods. -
-
- Dependency checks can be objects (collaborating objects), simple (primitives
- and
- This means checking whether the object implements
-
- Custom init methods are resolved in a case-insensitive manner. -
-- This implementation invokes a no-arg method if found, else checking - for a method with a single boolean argument (passing in "true", - assuming a "force" parameter), else logging an error. -
-- Can be overridden in subclasses for custom resolution of destroy - methods with arguments. -
-- Custom destroy methods are resolved in a case-insensitive manner. -
-- Must destroy objects that depend on the given object before the object itself. - Should not throw any exceptions. -
-
- The value could be :
-
- An
- A
- An
- An ordinary object or
-
-
- Called by autowiring. If a subclass cannot obtain information about object
- names by
PostProcessAfterInitialization callback of all
- registered IObjectPostProcessors, giving them a chance to post-process
- the object obtained from IFactoryObjects (for example, to auto-proxy them)
-
- Called by autowiring. If a subclass cannot obtain information about object
- names by
- Called by the
-
- If
- The default is
- Anything else represents
- Always optional. -
-- Used primarily for user documentation of XML object definition - documents. -
-
- Does not have to be fully assembly qualified, but it is recommended
- that the
- There are constraints on a valid XML id: if you want to reference
- your object in .NET code using a name that's illegal as an XML id,
- use the optional
- Multiple aliases can be separated by any number of spaces,
- semicolons, or commas
- (
- Always optional. -
-- Singletons are most commonly used, and are ideal for multi-threaded - service objects. -
-- Scope can be defined as either application, session or request. It - defines when "singleton" instances are initialized, but has no - effect on prototype definitions. -
-- The object factory will guarantee that these objects - get initialized before this object definition. -
-- The method must have no arguments. -
-
- Valid destroy methods have either of the following signatures...
-
-
-
- Only needed to avoid ambiguities, e.g. in case of 2 single
- argument constructors that can both be converted from a
-
- Only needed to avoid ambiguities, e.g. in case of 2 arguments of - the same type. -
-
- Default is
- Spring.NET supports primitives, references to other objects in the - same or related factories, lists, dictionaries, and name value - collections. -
-- Local references, using the "local" attribute, have to use object - ids; they can be checked by a parser, thus should be preferred for - references within the same object factory XML file. -
-- If this is specified, no type attribute should be used. This should - be set to the name of an object in the current or ancestor - factories that contains the relevant factory method. This allows - the factory itself to be configured using Dependency Injection, and - an instance (rather than static) method to be used. -
-- Use constructor-arg elements to specify arguments to the factory - method, if it takes arguments. Autowiring does not apply to - factory methods. -
-
- If the "type" attribute is present, the factory method will be a
- static method on the type specified by the "type" attribute on
- this object definition. Often this will be the same type as that
- of the constructed object - for example, when the factory method
- is used as an alternative to a constructor. However, it may be on
- a different type. In that case, the created object will *not* be
- of the type specified in the "type" attribute. This is analogous
- to
- If the "factory-object" attribute is present, the "type" attribute
- is not used, and the factory method will be an instance method on
- the object returned from a
-
- The factory method can have any number of arguments. Use indexed - constructor-arg elements in conjunction with the factory-method - attribute. -
-- Setter Injection can be used in conjunction with a factory method. - Method Injection cannot, as the factory method returns an instance, - which will be used when the container creates the object. -
-- Lists are untyped, pending generics support, although references - will be strongly typed. -
-
- A list can also map to an array type. The necessary conversion is
- automatically performed by the
-
- Sets are untyped, pending generics support, although references - will be strongly typed. -
-- Dictionaries may be empty. -
-- This is used by name-value, ctor argument, and property elements. -
-- This is used by name-value element. -
-- Used as a convenience shortcut on property and constructor-arg - elements to refer to other objects. -
-- This is used by ctor argument and property elements. -
-- The name of the property is given by the "key" attribute. -
-
- The property may be a string, or may be converted to the
- required
- Necessary because an empty "value" tag will resolve to an empty
-
- May be empty. -
-- The "key" attribute is the name of the property. -
-
- Defaults to
- This is a form of Method Injection. -
-
- It's particularly useful as an alternative to implementing the
-
- Often this object will be a prototype, in which case the lookup method - will return a distinct instance on every invocation. This is useful - for single-threaded objects. -
-- This (again) is a form of Method Injection. -
-- If this method is not overloaded, there's no need to use arg-type - subelements. -
-
- If this method is overloaded,
- This may be a singleton or prototype. If it's a prototype, a new - instance will be used for each method replacement. Singleton usage - is the norm. -
-
- For convenience, this may be a substring of the FQN. E.g. all the following would match
-
-
-
-
- This is a utility class, and as such has no publicly visible - constructors. -
-- Does not have support for prototype objects, aliases, and post startup object - configuration. -
-
- Serves as a simple example implementation of the
- The
- This method allows an object factory to be used as a replacement for the - Singleton or Prototype design pattern. -
-- Note that callers should retain references to returned objects. There is no - guarantee that this method will be implemented to be efficient. For example, - it may be synchronized, or may need to run an RDBMS query. -
-- Will ask the parent factory if the object cannot be found in this factory - instance. -
-
- That is, will
- More specifically, checks the type of object that
-
- Will not consider
- Does consider objects created by
- Does not consider any hierarchy this factory may participate in. -
-
- Since this implementation of the
-
- This version of the IListableObjectFactory.GetObjectsOfType(type,true,true) .
-
- Deep copy constructoe. -
-
- The returned
- Does not support per
- This value will be used to populate the
- The default is the
- Currently only supports conversion from a
-
- This will give the best lookup, add, and remove performance for very - large data-sets, but iteration will occur in no particular order. -
-- Mainly for internal use within the framework. -
-- This is a utility class, and as such exposes no public constructors. -
-
- If
- If
- If the supplied
- StringUtils.HasLength(null) = false
- StringUtils.HasLength("") = false
- StringUtils.HasLength(" ") = true
- StringUtils.HasLength("Hello") = true
-
-
- More specifically, returns
- StringUtils.HasText(null) = false
- StringUtils.HasText("") = false
- StringUtils.HasText(" ") = false
- StringUtils.HasText("12345") = true
- StringUtils.HasText(" 12345 ") = true
-
-
- More specifically, returns
- StringUtils.IsNullOrEmpty(null) = true
- StringUtils.IsNullOrEmpty("") = true
- StringUtils.IsNullOrEmpty(" ") = true
- StringUtils.IsNullOrEmpty("12345") = false
- StringUtils.IsNullOrEmpty(" 12345 ") = false
-
- - -
-
- The return value of this method call is always guaranteed to be non
-
- The return value of this method call is always guaranteed to be non
-
- Any (back)slashes are converted to forward slashes. -
-
- // true
- PathMatcher.Match("c:/*.bat", @"c:\autoexec.bat");
- PathMatcher.Match("c:\fo*\*.bat", @"c:/foobar/autoexec.bat");
- PathMatcher.Match("c:\fo?\*.bat", @"c:/foo/autoexec.bat");
- // false
- PathMatcher.Match("c:\fo?\*.bat", @"c:/fo/autoexec.bat");
-
- - This is a utility class, and as such exposes no public constructors. -
-- Not intended to be used directly by applications. -
-- This is a utility class, and as such exposes no public constructors. -
-InstantiateType(Type) fails.
-
- As this method doesn't try to instantiate
- As this method doesn't try to instantiate
- Neccessary when dealing with server-activated remote objects, because the
- object is of the type TransparentProxy and regular
- Transparent proxy instances always return
- Considers primitive wrapper classes as assignable to the - corresponding primitive types. -
-- For example used in an object factory's constructor resolution. -
-- Used to determine properties to check for a "simple" dependency-check. -
-- Not intended to be used directly by applications. -
-InvalidOperationException
- if the expression is false.
- false- This is a utility class, and as such exposes no public constructors. -
-
- Will use the
- A
- The remaining settings will always be taken from the child definition:
-
- A common cause of validation failures is a missing value for the
-
- This value is required. -
-- Hopefully this will display enough context so that a user - can pinpoint the cause of the error. -
-- Derived classes can of course override this method in order to implement - validators capable of displaying a full list of errors found in the - definition. -
-- Derived classes can of course override this method in order to implement - validators capable of displaying a full list of errors found in the - definition. -
-- When the <connectionStrings> configuration section is processed by this class, - two variables are defined for each connection string: one for connection string and - the second one for the provider name.
-
- Variable names are generated by appending '.connectionString' and '.providerName'
- literals to the value of the
--- --
- will result in two variables being created: myConn.connectionString and myConn.providerName. - You can reference these variables within your object definitions, just like any other variable.
-- Type parameters can be applied to classes, interfaces, - structures, methods, delegates, etc... -
-- A empty string represents a type parameter that - did not have been substituted by a specific type. -
-- A generic argument can be a type parameter or a type argument. -
-
- Currently only supports conversion to and from a
-
- Currently only supports conversion from a
-
- This class supports checking the parameter count of both methods and - constructors. -
-- Default parameters, etc need to taken into account. -
-
- This constructor sets the
-
- Currently, the resources that are supported are the
- You can provide custom implementations of the
-
- Find below some examples of instantiating an
-
- // an XmlApplicationContext that reads its object definitions from an
- // XML file that has been embedded in an assembly...
- IApplicationContext context = new XmlApplicationContext
- (
- "assembly://AssemblyName/NameSpace/ResourceName"
- );
-
- // an XmlApplicationContext that reads its object definitions from a
- // number of disparate XML resources...
- IApplicationContext context = new XmlApplicationContext
- (
- // from an XML file that has been embedded in an assembly...
- "assembly://AssemblyName/NameSpace/ResourceName",
- // and from a (relative) filesystem-based resource...
- "file://Objects/services.xml",
- // and from an App.config / Web.config resource...
- "config://spring/objects"
- );
-
-
-
- There should not (typically) be a need to instantiate instances of this class;
-
- Consider using
- Provides easy ways to store all the necessary values needed to resolve
- messages from an
- This is the copy constructor for the
-
- The test expression must evaluate to a
- Using an object here, rather than just storing all properties in a - map keyed by property name, allows for more flexibility, and the - ability to handle indexed properties in a special way if necessary. -
-
- Note that the value doesn't need to be the final required
-
- Note that type conversion will not have occurred here.
- It is the responsibility of the
-
- This is usually indicated by any of the variants of the
-
- A circular reference with an
- This is currently the preferred way of injecting resources into view
- tier components (such as Windows Forms GUIs and ASP.NET ASPX pages).
- A GUI component (typically a Windows Form) is injected with
- an
- For example, the root name for the resource file named - "MyResource.en-US.resources" is "MyResource". -
-- Typically used for retrieving public constants. -
-
- The following example retrieves the
-
-
-
- The previous example could also have been written using the convenience
-
-
-
-
- This class also implements the
-
-
-
-
-
-
-
- The usage for retrieving instance fields is similar. No example is shown
- because public instance fields are generally bad practice; but if
- you have some legacy code that exposes public instance fields, or if you
- just really like coding public instance fields, then you can use this
-
- This method allows the object instance to perform initialization only - possible when all object properties have been set and to throw an - exception in the event of misconfiguration. -
-
- In the context of the
-
- If the
-
- Supports the creation of
- Returns the
ResolveStringValue method
- This
- All other resources will be ignored, but you can retrieve them by calling one of
-
- Matches the whole method name. -
-- This leaves it up to the caller to decide what matches, but is obviously less of - an abstraction because the caller must know the exact format of the underlying - stack trace. -
-
- If no parent
- Used as placeholder
- This attribute allows application developers to mark that a result - of the method invocation should be cached, but it will not do any - caching by itself. -
-
- In order to actually cache the result, an application developer
- must apply a
null if none.
- null if none.
- AdoExceptionTranslator to use for flushing the
- Session on transaction synchronization (can be null; only used when actually
- registering a transaction synchronization).
- Throws the orginal HibernateException, in contrast to
-
null if none.
- Spring.Dao hierarchy. Note that it is advisable to
- handle AdoException specifically by using a AdoExceptionTranslator for the
- underlying ADO.NET exception.
- null).
- null).
- - Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-Not intended to be used directly. See HibernateTemplate. -
-null if none
- org.springframework.dao hierarchy. Will automatically detect
- wrapped ADO.NET Exceptions and convert them accordingly.
- org.springframework.dao hierarchy. Can be overridden in subclasses.
- org.springframework.dao hierarchy. Can be overridden in subclasses.
- ISession.Connection().
- null if none specified)
- HibernateTemplate is aware of a corresponding Session bound to the - current thread, for example when using HibernateTransactionManager. - If allowCreate is true, a new non-transactional Session will be created - if none found, which needs to be closed at the end of the operation. - If false, an InvalidOperationException will get thrown in this case. -
-- Default is "false"; if activated, all operations on this template will - work on a new NHibernate ISession even in case of a pre-bound ISession - (for example, within a transaction). -
-Within a transaction, a new NHibernate ISession used by this template - will participate in the transaction through using the same ADO.NET - Connection. In such a scenario, multiple Sessions will participate - in the same database transaction. -
-Turn this on for operations that are supposed to always execute - independently, without side effects caused by a shared NHibernate ISession. -
-close calls and automatically applying
- query cache settings and transaction timeouts.
- Such an interceptor can either be set at the ISessionFactory level, - i.e. on LocalSessionFactoryObject, or at the ISession level, i.e. on - HibernateTemplate, HibernateInterceptor, and HibernateTransactionManager. - It's preferable to set it on LocalSessionFactoryObject or HibernateTransactionManager - to avoid repeated configuration and guarantee consistent behavior in transactions. -
-Requires the object factory to be known, to be able to resolve the object - name to an interceptor instance on session creation. Typically used for - prototype interceptors, i.e. a new interceptor instance per session. -
-Can also be used for shared interceptor instances, but it is recommended - to set the interceptor reference directly in such a scenario. -
-To specify the query region to be used for queries cached - by this template, set the QueryCacheRegion property. -
-The cache region will not take effect unless queries created by this - template are configured to be cached via the CacheQueries property. -
-Default is 0, indicating to use the driver's default.
-Default is 0, indicating to use the driver's default.
-The default exception translator is either a ErrorCodeExceptionTranslator - if a DbProvider is available, or a FalbackExceptionTranslator otherwise -
-
- using (new SessionScope())
- {
- ... do multiple operation, possibly in multiple transactions.
- }
-
- At the end of "using", the session is automatically closed. All transactions within the scope use the same session,
- if you are using Spring's HibernateTemplate or using Spring's implementation of NHibernate 1.2's
- ICurrentSessionContext interface.
- Close(),
- HibernateTemplate (which by default applies the timeouts) or call
- SessionFactoryUtils.applyTransactionTimeout for each created
- Hibernate Query object.
- - An implementation does not need to check the rollback-only flag. -
-
- Called after
- Should not throw any exceptions but just issue warnings on errors. -
-- This method allows the object instance to perform the kind of - initialization only possible when all of it's dependencies have - been injected (set), and to throw an appropriate exception in the - event of misconfiguration. -
-
- Please do consult the class level documentation for the
-
null if none.
- Requires the object factory to be known, to be able to resolve the object - name to an interceptor instance on session creation. Typically used for - prototype interceptors, i.e. a new interceptor instance per session. -
-Can also be used for shared interceptor instances, but it is recommended - to set the interceptor reference directly in such a scenario. -
-DbProvider. Default is "true".
- Can be turned off to deliberately ignore an available IDbProvider, - to not expose Hibernate transactions as ADO.NET transactions for that IDbProvider. -
-Typically used to implement data access or business logic services that - use NHibernate within their implementation but are Hibernate-agnostic in their - interface. The latter or code calling the latter only have to deal with - domain objects.
- -The central method is Execute supporting Hibernate access code - implementing the HibernateCallback interface. It provides NHibernate Session - handling such that neither the IHibernateCallback implementation nor the calling - code needs to explicitly care about retrieving/closing NHibernate Sessions, - or handling Session lifecycle exceptions. For typical single step actions, - there are various convenience methods (Find, Load, SaveOrUpdate, Delete). -
- -Can be used within a service implementation via direct instantiation - with a ISessionFactory reference, or get prepared in an application context - and given to services as an object reference. Note: The ISessionFactory should - always be configured as an object in the application context, in the first case - given to the service directly, in the second case to the prepared template. -
- -This class can be considered as direct alternative to working with the raw - Hibernate Session API (through SessionFactoryUtils.Session). -
- -LocalSessionFactoryObject is the preferred way of obtaining a reference - to a specific NHibernate ISessionFactory. -
-Provides HibernateTemplate's data access methods that mirror - various Session methods. See the NHibernate ISession documentation - for details on those methods. -
-Provides HibernateTemplate's data access methods that mirror - various Session methods. See the NHibernate ISession documentation - for details on those methods. -
-null).
- null)
- Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-null
- Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-null
- null)
- null)
- null)
- null)
- null)
- null)
- null)
- null)
- null if not found.
- null if not found.
- Obtains the specified lock mode if the instance exists.
- null if not found
- null if not found.
- null if not foundnull if not found.
- Obtains the specified lock mode if the instance exists.
- null if not found
- null).
- null)
- Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-null
- null
- null
- Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-null
- null)
- null)
- null)
- null)
- null)
- null)
- null)
- null)
- HibernateTemplate is aware of a corresponding Session bound to the - current thread, for example when using HibernateTransactionManager. - If allowCreate is true, a new non-transactional Session will be created - if none found, which needs to be closed at the end of the operation. - If false, an InvalidOperationException will get thrown in this case. -
-- Default is "false"; if activated, all operations on this template will - work on a new NHibernate ISession even in case of a pre-bound ISession - (for example, within a transaction). -
-Within a transaction, a new NHibernate ISession used by this template - will participate in the transaction through using the same ADO.NET - Connection. In such a scenario, multiple Sessions will participate - in the same database transaction. -
-Turn this on for operations that are supposed to always execute - independently, without side effects caused by a shared NHibernate ISession. -
-Such an interceptor can either be set at the ISessionFactory level, - i.e. on LocalSessionFactoryObject, or at the ISession level, i.e. on - HibernateTemplate, HibernateInterceptor, and HibernateTransactionManager. - It's preferable to set it on LocalSessionFactoryObject or HibernateTransactionManager - to avoid repeated configuration and guarantee consistent behavior in transactions. -
-The cache region will not take effect unless queries created by this - template are configured to be cached via the CacheQueries property. -
-To specify the query region to be used for queries cached - by this template, set the QueryCacheRegion property. -
-Default is 0, indicating to use the driver's default.
-close calls and automatically applying
- query cache settings and transaction timeouts.
- Requires the object factory to be known, to be able to resolve the object - name to an interceptor instance on session creation. Typically used for - prototype interceptors, i.e. a new interceptor instance per session. -
-Can also be used for shared interceptor instances, but it is recommended - to set the interceptor reference directly in such a scenario. -
-Default is 0, indicating to use the driver's default.
-The default exception translator is either a ErrorCodeExceptionTranslator - if a DbProvider is available, or a FalbackExceptionTranslator otherwise -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-
- Unbind Hibernate resources (SessionHolder) from
-
- Rebind Hibernate resources from
-
- Can flush transactional sessions to the database. -
-- Note that exceptions will get propagated to the commit caller and - cause a rollback of the transaction. -
-- Note that exceptions will get propagated to the commit or rollback - caller, although they will not influence the outcome of the transaction. -
-
- Normally starting with 0 or 1, with
- Higher value can be interpreted as lower priority, consequently the first object - has highest priority. -
-In case of an existing ISession, TemplateFlushMode.Never will turn - the hibenrate flush mode - to FlushMode.Never for the scope of the current operation, resetting the previous - flush mode afterwards. -
-In case of an existing Session, TemplateFlushMode.Auto - will participate in the existing flush mode, not modifying - it for the current operation. - This in particular means that this setting will not modify an existing - hibernate flush mode FlushMode.Never, in contrast to TemplateFlushMode.Eager. -
-In case of an existing Session, TemplateFlushMode.Eager - will turn the NHibernate flush mode - to FlushMode.Auto for the scope of the current operation and issue a flush at the - end, resetting the previous flush mode afterwards. -
-In case of an existing Session, TemplateFlushMode.Commit - will turn the NHibernate flush mode - to FlushMode.Commit for the scope of the current operation, resetting the previous - flush mode afterwards. The only exception is an existing flush mode - FlushMode.Never, which will not be modified through this setting. -
-The default implementation creates a new Configuration instance. - A custom implementation could prepare the instance in a specific way, - or use a custom Configuration subclass. -
-The default implementation invokes Configuration's BuildSessionFactory. - A custom implementation could prepare the instance in a specific way, - or use a custom ISessionFactory subclass. -
-Can be used to override values in a NHibernate XML config file, - or to specify all necessary properties locally. -
-Note: Do not specify a transaction provider here when using - Spring-driven transactions. It is also advisable to omit connection - provider settings and use a Spring-set IDbProvider instead. -
-Spring.Dao exceptions.
- - Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-CreateHibernateTemplate.
- Can be overridden in subclasses to provide a HibernateTemplate instance - with different configuration, or a custom HibernateTemplate subclass. -
-org.springframework.dao hierarchy. Will automatically detect
- wrapped ADO.NET Exceptions and convert them accordingly.
- Note that this is not meant to be invoked from HibernateTemplate code - but rather just in plain Hibernate code. Use it in combination with - ReleaseSession. -
-In general, it is recommended to use HibernateTemplate, either with - the provided convenience operations or with a custom HibernateCallback - that provides you with a Session to work on. HibernateTemplate will care - for all resource management and for proper exception conversion. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-The default implementation creates a new Configuration instance. - A custom implementation could prepare the instance in a specific way, - or use a custom Configuration subclass. -
-The default implementation invokes Configuration's BuildSessionFactory. - A custom implementation could prepare the instance in a specific way, - or use a custom ISessionFactory subclass. -
-Can be used to override values in a NHibernate XML config file, - or to specify all necessary properties locally. -
-Note: Do not specify a transaction provider here when using - Spring-driven transactions. It is also advisable to omit connection - provider settings and use a Spring-set IDbProvider instead. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-
- Unbind Hibernate resources (SessionHolder) from
-
- Rebind Hibernate resources from
-
- Can flush transactional sessions to the database. -
-- Note that exceptions will get propagated to the commit caller and - cause a rollback of the transaction. -
-- Note that exceptions will get propagated to the commit or rollback - caller, although they will not influence the outcome of the transaction. -
-
- Normally starting with 0 or 1, with
- Higher value can be interpreted as lower priority, consequently the first object - has highest priority. -
-Not intended to be used directly. See HibernateTemplate. -
-null if none
- org.springframework.dao hierarchy. Will automatically detect
- wrapped ADO.NET Exceptions and convert them accordingly.
- org.springframework.dao hierarchy. Can be overridden in subclasses.
- org.springframework.dao hierarchy. Can be overridden in subclasses.
- ISession.Connection().
- null if none specified)
- HibernateTemplate is aware of a corresponding Session bound to the - current thread, for example when using HibernateTransactionManager. - If allowCreate is true, a new non-transactional Session will be created - if none found, which needs to be closed at the end of the operation. - If false, an InvalidOperationException will get thrown in this case. -
-- Default is "false"; if activated, all operations on this template will - work on a new NHibernate ISession even in case of a pre-bound ISession - (for example, within a transaction). -
-Within a transaction, a new NHibernate ISession used by this template - will participate in the transaction through using the same ADO.NET - Connection. In such a scenario, multiple Sessions will participate - in the same database transaction. -
-Turn this on for operations that are supposed to always execute - independently, without side effects caused by a shared NHibernate ISession. -
-close calls and automatically applying
- query cache settings and transaction timeouts.
- Such an interceptor can either be set at the ISessionFactory level, - i.e. on LocalSessionFactoryObject, or at the ISession level, i.e. on - HibernateTemplate, HibernateInterceptor, and HibernateTransactionManager. - It's preferable to set it on LocalSessionFactoryObject or HibernateTransactionManager - to avoid repeated configuration and guarantee consistent behavior in transactions. -
-Requires the object factory to be known, to be able to resolve the object - name to an interceptor instance on session creation. Typically used for - prototype interceptors, i.e. a new interceptor instance per session. -
-Can also be used for shared interceptor instances, but it is recommended - to set the interceptor reference directly in such a scenario. -
-To specify the query region to be used for queries cached - by this template, set the QueryCacheRegion property. -
-The cache region will not take effect unless queries created by this - template are configured to be cached via the CacheQueries property. -
-Default is 0, indicating to use the driver's default.
-Default is 0, indicating to use the driver's default.
-The default exception translator is either a ErrorCodeExceptionTranslator - if a DbProvider is available, or a FalbackExceptionTranslator otherwise -
-Typically used to implement data access or business logic services that - use NHibernate within their implementation but are Hibernate-agnostic in their - interface. The latter or code calling the latter only have to deal with - domain objects.
- -The central method is Execute() supporting Hibernate access code which - implements the HibernateCallback interface. It provides NHibernate Session - handling such that neither the IHibernateCallback implementation nor the calling - code needs to explicitly care about retrieving/closing NHibernate Sessions, - or handling Session lifecycle exceptions. For typical single step actions, - there are various convenience methods (Find, Load, SaveOrUpdate, Delete). -
- -Can be used within a service implementation via direct instantiation - with a ISessionFactory reference, or get prepared in an application context - and given to services as an object reference. Note: The ISessionFactory should - always be configured as an object in the application context, in the first case - given to the service directly, in the second case to the prepared template. -
- -This class can be considered as a direct alternative to working with the raw - Hibernate Session API (through SessionFactoryUtils.Session). -
- -LocalSessionFactoryObject is the preferred way of obtaining a reference - to a specific NHibernate ISessionFactory. -
-Provides HibernateTemplate's data access methods that mirror - various Session methods. See the NHibernate ISession documentation - for details on those methods. -
-Provides HibernateTemplate's data access methods that mirror - various Session methods. See the NHibernate ISession documentation - for details on those methods. -
-null).
- null)
- Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-null).
- null)
- Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-HibernateTemplate is aware of a corresponding Session bound to the - current thread, for example when using HibernateTransactionManager. - If allowCreate is true, a new non-transactional Session will be created - if none found, which needs to be closed at the end of the operation. - If false, an InvalidOperationException will get thrown in this case. -
-- Default is "false"; if activated, all operations on this template will - work on a new NHibernate ISession even in case of a pre-bound ISession - (for example, within a transaction). -
-Within a transaction, a new NHibernate ISession used by this template - will participate in the transaction through using the same ADO.NET - Connection. In such a scenario, multiple Sessions will participate - in the same database transaction. -
-Turn this on for operations that are supposed to always execute - independently, without side effects caused by a shared NHibernate ISession. -
-close calls and automatically applying
- query cache settings and transaction timeouts.
- Such an interceptor can either be set at the ISessionFactory level, - i.e. on LocalSessionFactoryObject, or at the ISession level, i.e. on - HibernateTemplate, HibernateInterceptor, and HibernateTransactionManager. - It's preferable to set it on LocalSessionFactoryObject or HibernateTransactionManager - to avoid repeated configuration and guarantee consistent behavior in transactions. -
-Requires the object factory to be known, to be able to resolve the object - name to an interceptor instance on session creation. Typically used for - prototype interceptors, i.e. a new interceptor instance per session. -
-Can also be used for shared interceptor instances, but it is recommended - to set the interceptor reference directly in such a scenario. -
-To specify the query region to be used for queries cached - by this template, set the QueryCacheRegion property. -
-The cache region will not take effect unless queries created by this - template are configured to be cached via the CacheQueries property. -
-Default is 0, indicating to use the driver's default.
-Default is 0, indicating to use the driver's default.
-The default exception translator is either a ErrorCodeExceptionTranslator - if a DbProvider is available, or a FalbackExceptionTranslator otherwise -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-CreateHibernateTemplate.
- Can be overridden in subclasses to provide a HibernateTemplate instance - with different configuration, or a custom HibernateTemplate subclass. -
-org.springframework.dao hierarchy. Will automatically detect
- wrapped ADO.NET Exceptions and convert them accordingly.
- Note that this is not meant to be invoked from HibernateTemplate code - but rather just in plain Hibernate code. Use it in combination with - ReleaseSession. -
-In general, it is recommended to use HibernateTemplate, either with - the provided convenience operations or with a custom HibernateCallback - that provides you with a Session to work on. HibernateTemplate will care - for all resource management and for proper exception conversion. -
-
- using (new SessionScope())
- {
- ... do multiple operation, possibly in multiple transactions.
- }
-
- At the end of "using", the session is automatically closed. All transactions within the scope use the same session,
- if you are using Spring's HibernateTemplate or using Spring's implementation of NHibernate 1.2's
- ICurrentSessionContext interface.
- Close(),
- - Allows for returning an IList of result objects created within the callback. - Note that there's special support for single step actions: - see HibernateTemplate.find etc. -
-HibernateTemplate (which by default applies the timeouts) or call
- SessionFactoryUtils.applyTransactionTimeout for each created
- Hibernate Query object.
- - An implementation does not need to check the rollback-only flag. -
-
- Called after
- Should not throw any exceptions but just issue warnings on errors. -
-- This method allows the object instance to perform the kind of - initialization only possible when all of it's dependencies have - been injected (set), and to throw an appropriate exception in the - event of misconfiguration. -
-
- Please do consult the class level documentation for the
-
null if none.
- Requires the object factory to be known, to be able to resolve the object - name to an interceptor instance on session creation. Typically used for - prototype interceptors, i.e. a new interceptor instance per session. -
-Can also be used for shared interceptor instances, but it is recommended - to set the interceptor reference directly in such a scenario. -
-DbProvider. Default is "true".
- Can be turned off to deliberately ignore an available IDbProvider, - to not expose Hibernate transactions as ADO.NET transactions for that IDbProvider. -
-Typically used to implement data access or business logic services that - use NHibernate within their implementation but are Hibernate-agnostic in their - interface. The latter or code calling the latter only have to deal with - domain objects.
- -The central method is Execute supporting Hibernate access code - implementing the HibernateCallback interface. It provides NHibernate Session - handling such that neither the IHibernateCallback implementation nor the calling - code needs to explicitly care about retrieving/closing NHibernate Sessions, - or handling Session lifecycle exceptions. For typical single step actions, - there are various convenience methods (Find, Load, SaveOrUpdate, Delete). -
- -Can be used within a service implementation via direct instantiation - with a ISessionFactory reference, or get prepared in an application context - and given to services as an object reference. Note: The ISessionFactory should - always be configured as an object in the application context, in the first case - given to the service directly, in the second case to the prepared template. -
- -This class can be considered as direct alternative to working with the raw - Hibernate Session API (through SessionFactoryUtils.Session). -
- -LocalSessionFactoryObject is the preferred way of obtaining a reference - to a specific NHibernate ISessionFactory. -
-Provides HibernateTemplate's data access methods that mirror - various Session methods. See the NHibernate ISession documentation - for details on those methods. -
-Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-null
- Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-null
- null)
- null)
- null)
- null)
- null)
- null)
- null)
- null)
- null if not found.
- null if not found.
- Obtains the specified lock mode if the instance exists.
- null if not found
- null if not found.
- null if not foundnull if not found.
- Obtains the specified lock mode if the instance exists.
- null if not found
- null).
- null)
- Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-null
- null
- null
- Note: Callback code is not supposed to handle transactions itself! - Use an appropriate transaction manager like HibernateTransactionManager. - Generally, callback code must not touch any Session lifecycle methods, - like close, disconnect, or reconnect, to let the template do its work. -
-null
- null)
- null)
- null)
- null)
- null)
- null)
- null)
- null)
- HibernateTemplate is aware of a corresponding Session bound to the - current thread, for example when using HibernateTransactionManager. - If allowCreate is true, a new non-transactional Session will be created - if none found, which needs to be closed at the end of the operation. - If false, an InvalidOperationException will get thrown in this case. -
-- Default is "false"; if activated, all operations on this template will - work on a new NHibernate ISession even in case of a pre-bound ISession - (for example, within a transaction). -
-Within a transaction, a new NHibernate ISession used by this template - will participate in the transaction through using the same ADO.NET - Connection. In such a scenario, multiple Sessions will participate - in the same database transaction. -
-Turn this on for operations that are supposed to always execute - independently, without side effects caused by a shared NHibernate ISession. -
-Such an interceptor can either be set at the ISessionFactory level, - i.e. on LocalSessionFactoryObject, or at the ISession level, i.e. on - HibernateTemplate, HibernateInterceptor, and HibernateTransactionManager. - It's preferable to set it on LocalSessionFactoryObject or HibernateTransactionManager - to avoid repeated configuration and guarantee consistent behavior in transactions. -
-The cache region will not take effect unless queries created by this - template are configured to be cached via the CacheQueries property. -
-To specify the query region to be used for queries cached - by this template, set the QueryCacheRegion property. -
-Default is 0, indicating to use the driver's default.
-close calls and automatically applying
- query cache settings and transaction timeouts.
- Requires the object factory to be known, to be able to resolve the object - name to an interceptor instance on session creation. Typically used for - prototype interceptors, i.e. a new interceptor instance per session. -
-Can also be used for shared interceptor instances, but it is recommended - to set the interceptor reference directly in such a scenario. -
-Default is 0, indicating to use the driver's default.
-The default exception translator is either a ErrorCodeExceptionTranslator - if a DbProvider is available, or a FalbackExceptionTranslator otherwise -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-- Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-null if none.
- null if none.
- AdoExceptionTranslator to use for flushing the
- Session on transaction synchronization (can be null; only used when actually
- registering a transaction synchronization).
- Throws the orginal HibernateException, in contrast to
-
null if none.
- Spring.Dao hierarchy. Note that it is advisable to
- handle AdoException specifically by using a AdoExceptionTranslator for the
- underlying ADO.NET exception.
- null).
- null).
- - Allows for returning the result object created within the callback. - Note that there's special support for single step actions: - see HibernateTemplate.find etc. -
-This ICurrentSessionContext implementation can also be specified in - custom ISessionFactory setup through the - "hibernate.current_session_context_class" property, with the fully - qualified name of this class as value.
In case of an existing ISession, TemplateFlushMode.Never will turn - the hibenrate flush mode - to FlushMode.Never for the scope of the current operation, resetting the previous - flush mode afterwards. -
-In case of an existing Session, TemplateFlushMode.Auto - will participate in the existing flush mode, not modifying - it for the current operation. - This in particular means that this setting will not modify an existing - hibernate flush mode FlushMode.Never, in contrast to TemplateFlushMode.Eager. -
-In case of an existing Session, TemplateFlushMode.Eager - will turn the NHibernate flush mode - to FlushMode.Auto for the scope of the current operation and issue a flush at the - end, resetting the previous flush mode afterwards. -
-In case of an existing Session, TemplateFlushMode.Commit - will turn the NHibernate flush mode - to FlushMode.Commit for the scope of the current operation, resetting the previous - flush mode afterwards. The only exception is an existing flush mode - FlushMode.Never, which will not be modified through this setting. -
-Spring.Dao exceptions.
- - Allows for returning a result object created within the callback, i.e. - a domain object or a collection of domain objects. Note that there's - special support for single step actions: see HibernateTemplate.find etc. -
-CreateHibernateTemplate.
- Can be overridden in subclasses to provide a HibernateTemplate instance - with different configuration, or a custom HibernateTemplate subclass. -
-org.springframework.dao hierarchy. Will automatically detect
- wrapped ADO.NET Exceptions and convert them accordingly.
- Note that this is not meant to be invoked from HibernateTemplate code - but rather just in plain Hibernate code. Use it in combination with - ReleaseSession. -
-In general, it is recommended to use HibernateTemplate, either with - the provided convenience operations or with a custom HibernateCallback - that provides you with a Session to work on. HibernateTemplate will care - for all resource management and for proper exception conversion. -
-
- Applications can use this directly, but it is not primarily meant as an API.
- Typically, applications will work with either
-
- For implementers,
- Note that parameters like isolation level or timeout will only be applied - to new transactions, and thus be ignored when participating in active ones. - Furthermore, they aren't supported by every transaction manager: - a proper implementation should throw an exception when custom values - that it doesn't support are specified. -
-- If the transaction has been marked rollback-only programmatically, - perform a rollback. -
-- If the transaction wasn't a new one, omit the commit to take part - in the surrounding transaction properly. -
-- If the transaction wasn't a new one, just set it rollback-only - to take part in the surrounding transaction properly. -
-
- That class contains the necessary calls into Spring.NET's underlying
- transaction API: subclasses such as this are responsible for calling
- superclass methods such as
-
-
- This enables the underlying Spring transaction infrastructure to be used - to easily implement an aspect for any aspect system. -
-- Subclasses are responsible for calling methods in this class in the correct order. -
-
- Uses the Strategy design pattern. A
- A transaction aspect is serializable if its
-
- The
-
- Do nothing if we didn't create a transaction. -
-- We may commit or roll back, depending on our configuration. -
-
- Internally, a
-
- Subclasses must pass it back to method on this class, but not see its internals. -
-- Multiple such rules can be applied to determine whether a transaction should commit - or rollback after an exception has been thrown. -
-
- As always, the
- The exception class must be
- This is the preferred way to construct a
-
- This method allows the object instance to perform the kind of - initialization only possible when all of it's dependencies have - been injected (set), and to throw an appropriate exception in the - event of misconfiguration. -
-
- Please do consult the class level documentation for the
-
Allows you to execute any number of operations - on a single IDbCommand, for example a single ExecuteScalar - call or repeated execute calls with varying parameters. -
-Used internally by AdoTemplate, but also useful for - application code. Note that the passed in IDbCommand - has been created by the framework and will have its - Connection property set and the Transaction property - set based on the transaction context.
-As an alternative to using this interface you can use - the delegate version which is particularly nice when using - anonymous delegates for writing more terse code and having - easy access to the variables in the calling class.
-See
Allows you to execute any number of operations - on a single IDbCommand, for example a single ExecuteScalar - call or repeated execute calls with varying parameters. -
-Used internally by AdoTemplate, but also useful for - application code. Note that the passed in IDbCommand - has been created by the framework.
-- This exception will be thrown either by O/R mapping tools or by custom DAO - implementations. -
-
- The central methods are
-
- Can be used within a service implementation via direct instantiation with - a transaction manager reference, or get prepared in an application context - and given to services as object reference. -
-- Supports setting the propagation behavior and the isolation level by name, - for convenient configuration in context definitions. -
-
- Base class for both
- Note that isolation level, timeout and read-only settings will only
- get applied when starting a new transaction. As only
-
- Only makes sense in combination with
-
- Note that a transaction manager that does not support custom isolation levels
- will throw an exception when given any other level than
-
- Must return a number of seconds, or -1.
- Only makes sense in combination with
-
- This just serves as hint for the actual transaction subsystem, - it will not necessarily cause failure of write accesses. -
-
- Only makes sense in combination with
-
- A transaction manager that cannot interpret the read-only hint
- will not throw an exception when given
- Only makes sense in combination with
-
- Note that a transaction manager that does not support custom isolation levels
- will throw an exception when given any other level than
-
- Must return a number of seconds, or -1.
- Only makes sense in combination with
-
- This just serves as hint for the actual transaction subsystem, - it will not necessarily cause failure of write accesses. -
-
- Only makes sense in combination with
-
- A transaction manager that cannot interpret the read-only hint
- will not throw an exception when given
null if onenull if one- Mainly targeted at configuration by an object factory. -
-- Mainly targeted at configuration by an object factory. -
-null if one
- null if one
-
- Note that savepoints can only work within an active transaction.
- Just use this programmatic savepoint handling for advanced needs;
- else, a subtransaction with a
- Note that most transaction managers will automatically release - savepoints at transaction completion. -
-- Note that most transaction managers will automatically release - savepoints at transaction completion. -
-- Implementations should fail as silently as possible if - proper resource cleanup will still happen at transaction completion. -
-
- The default behavior is to rollback on any exception.
- Consistent with
- The format matches the one used by the
-
- Implementations can be generic (for example, ADO.NET Exceptions) or proprietary (for example, - using SQL Server or Oracle error codes) for greater precision. -
-Provides the following workflow handling: -
- Transaction synchronization is a generic mechanism for registering - callbacks that get invoked at transaction completion time. The same mechanism - can also be used for custom synchronization efforts. -
-
- The state of this class is serializable. It's up to subclasses if
- they wish to make their state to be serializable.
- They should implement
- An implementation does not need to check the rollback-only flag. -
-
- Subclasses can override this to return false, causing a further
- invocation of
-
- Called after
- Should not throw any exceptions but just issue warnings on errors. -
-- Default implementation does nothing. -
-- This implementation handles propagation behavior. -
-
- Delegates to
-
- Note that parameters like isolation level or timeout will only be applied - to new transactions, and thus be ignored when participating in active ones. - Furthermore, they aren't supported by every transaction manager: - a proper implementation should throw an exception when custom values - that it doesn't support are specified. -
-- This implementation handles participating in existing transactions. -
-
- Delegates to
-
- If the transaction wasn't a new one, just set it rollback-only - to take part in the surrounding transaction properly. -
-- Note that transaction synchronization isn't supported for - multiple concurrent transactions by different transaction managers. - Only one transaction manager is allowed to activate it at any time. -
-- Typically initialized with an appropriate default by the - concrete transaction manager subclass. -
-
- Autodetected by
- Thrown for example on specifying bad SQL when using a RDBMS. - Resource-specific subclasses will probably be supplied by data access packages. -
-- For example, this exception or a subclass might be thrown if an ADO.NET - connection couldn't be closed after it had been used successfully. -
-- Note that data access code might perform resource cleanup in a - finally block and therefore log cleanup failure rather than rethrow it, - to keep the original data access exception, if any. -
-- This exception will be thrown either by O/R mapping tools or by custom DAO - implementations. -
-- Resource management code should check for thread-bound resources via GetResource(). - It is normally not supposed - to bind resources to threads, as this is the responsiblity of transaction managers. - A further option is to lazily bind on first use if transaction synchronization - is active, for performing transactions that span an arbitrary number of resources. -
-
- Transaction synchronization must be activated and deactivated by a transaction
- manager via
-
- Resource management code should only register synchronizations when this - manager is active, and perform resource cleanup immediately else. - If transaction synchronization isn't active, there is either no current - transaction, or the transaction manager doesn't support synchronizations. -
- Note that this class uses following naming convention for the - named 'data slots' for storage of thread local data, 'Spring.Transaction:Name' - where Name is either -Note that transaction synchronizations receive the read-only flag
- as argument for the beforeCommit callback, to be able
- to suppress change detection on commit. The present method is meant
- to be used for earlier read-only checks, for example to set the
- flush mode of a Hibernate Session to FlushMode.Never upfront.
-
PROPAGATION_NAME,ISOLATION_NAME,readOnly,timeout_NNNN,+Exception1,-Exception2
where only propagation code is required. For example:
-PROPAGATION_MANDATORY,ISOLATION_DEFAULT
- The tokens can be in any order. Propagation and isolation codes
- must use the names of the values in the
- A "+" before an exception name substring indicates that transactions should commit even - if this exception is thrown; a "-" that they should roll back. -
-- This interface is mainly used within the ADO.NET - framework. An IResultSetExtractor is usually a simpler choice - for result set (DataReader) processing, in particular a - RowMapperResultSetExtractor in combination with a IRowMapper. -
-Implementors should be marked as sealed, to make it clear that
- concrete subclasses are not supposed to override this template method themselves.
-
- This method allows the object instance to perform the kind of - initialization only possible when all of it's dependencies have - been injected (set), and to throw an appropriate exception in the - event of misconfiguration. -
-
- Please do consult the class level documentation for the
-
- This exception will be thrown either by O/R mapping tools or by custom DAO - implementations. -
-
- Supposed to unbind resources from
-
- Supposed to rebind resources from
-
- Can e.g. perform resource cleanup. -
-- Note that exceptions will get propagated to the commit caller - and cause a rollback of the transaction. -
-- Note that exceptions will get propagated to the commit or rollback - caller, although they will not influence the outcome of the transaction. -
-
- Supposed to unbind resources from
-
- Supposed to unbind resources from
-
- Can flush transactional sessions to the database. -
-- Note that exceptions will get propagated to the commit caller and - cause a rollback of the transaction. -
-- Can e.g. perform resource cleanup. -
-- Note that exceptions will get propagated to the commit caller - and cause a rollback of the transaction. -
-- Note that exceptions will get propagated to the commit or rollback - caller, although they will not influence the outcome of the transaction. -
-PROPAGATION_NAME,ISOLATION_NAME,readOnly,timeout_NNNN,+Exception1,-Exception2
where only propagation code is required. For example:
-PROPAGATION_MANDATORY,ISOLATION_DEFAULT
- The tokens can be in any order. Propagation and isolation codes
- must use the names of the values in the
- A "+" before an exception name substring indicates that transactions should commit even - if this exception is thrown; a "-" that they should roll back. -
-Allows you to execute any number of operations - on a single DbCommand, for example a single ExecuteScalar - call or repeated execute calls with varying parameters. -
-Used internally by AdoTemplate, but also useful for - application code. Note that the passed in DbCommand - has been created by the framework and will have its - Connection property set and the Transaction property - set based on the transaction context.
-Allows you to execute any number of operations - on a IDbDataAdapter, for example to Fill a DataSet - or other more advanced operations such as the transfering - data between two different DataSets. -
-Note that the passed in IDbDataAdapter - has been created by the framework and its SelectCommand - will be populated with values for CommandType and Text properties - along with Connection/Transaction properties based on the - calling transaction context. -
-- An implementation does not need to check the rollback-only flag. -
-- Note that most transaction managers will automatically release - savepoints at transaction completion. -
-- Note that most transaction managers will automatically release - savepoints at transaction completion. -
-- Implementations should fail as silently as possible if - proper resource cleanup will still happen at transaction completion. -
-
- The format matches the one used by the
-
- Only makes sense in combination with
-
- Note that a transaction manager that does not support custom isolation levels
- will throw an exception when given any other level than
-
- Must return a number of seconds, or -1.
- Only makes sense in combination with
-
- This just serves as hint for the actual transaction subsystem, - it will not necessarily cause failure of write accesses. -
-
- Only makes sense in combination with
-
- A transaction manager that cannot interpret the read-only hint
- will not throw an exception when given
proxy-target-type' attribute
- order' property/attribute
- <property> tag.
- - This exception will be thrown either by O/R mapping tools or by custom DAO - implementations. -
-To be used with
- Typically used to gather various calls to transaction-unaware low-level - services into a higher-level method implementation with transaction - demarcation. -
-- Implementations know how to source transaction attributes, whether from configuration, - metadata attributes at source level, or anywhere else. -
-
- public PrintGroupMappingDataSet FindAll()
- {
-
- PrintGroupMappingTableAdapter adapter = new PrintGroupMappingTableAdapter();
- PrintGroupMappingDataSet printGroupMappingDataSet = new PrintGroupMappingDataSet();
-
-
- printGroupMappingDataSet = AdoTemplate.Execute(delegate(IDbCommand command)
- {
- TypedDataSetUtils.ApplyConnectionAndTx(adapter, command);
- adapter.Fill(printGroupMappingDataSet.PrintGroupMapping);
- return printGroupMappingDataSet;
- })
- as PrintGroupMappingDataSet;
-
- return printGroupMappingDataSet;
- }
-
- See http://www.code-magazine.com/articleprint.aspx?quickid=0605031 for a
- more complete discussion.
-
- - Features rollback-only support transactions. Can expire after a certain number of - seconds or milliseconds, to determine transactional timeouts. -
-- Rounds up eagerly, e.g. '9.00001' to '10'. -
-- The methods let you set various properties and invoke - methods on the DataSet before and after it gets filled by a DataAdapter. - For example, EnforceConstraints, BeginLoadData, and EndLoadData - can be called to optimize the loading of large DataSets with - many related tables. -
-Vendors may expose other propriety methods on their DataSet - implementation, downcast to access this specific functionality. -
-- Thrown, for example, when we wanted to update 1 row in an RDBMS but actually - updated 3. -
-- This represents a problem in our data access framework, not the underlying data access - infrastructure. -
-- Analogous to System.EnterpriseServices.TransactionOption value of the same name. - This is typically the default setting of a transaction definition. -
-- Analogous to System.EnterpriseServices.TransactionOption.Supported. -
-- No corresponding System.EnterpriseServices.TransactionOption value. -
-- Analogous to System.EnterpriseServices.TransactionOption value of the same name. -
-- Analogous to System.EnterpriseServices.TransactionOption value of the same name. -
-- Analogous to System.EnterpriseServices.TransactionOption.Disabled. -
-- There is no analogous feature in TransactionOption. -
-To be used with
- Typically used to gather various calls to transaction-unaware low-level - services into a higher-level method implementation with transaction - demarcation. -
-Allows you to execute any number of operations - on a single DbCommand, for example a single ExecuteScalar - call or repeated execute calls with varying parameters. -
-Used internally by AdoTemplate, but also useful for - application code. Note that the passed in DbCommand - has been created by the framework and will have its - Connection property set and the Transaction property - set based on the transaction context.
-
- Because the AOP framework caches advice calculations, this is normally
- faster than just letting the
- This is an abstract class, and as such has no publicly - visible constructors. -
-- Typically used for AdoTemplate's query methods (with RowMapperResultSetExtractor - adapters). RowMapper objects are typically stateless and thus - reusable; they are ideal choices for implementing row-mapping logic in a single - place. -
-Alternatively, consider subclassing MappingSqlQuery from the Spring.Data.Object - namespace: Instead of working with separate AdoTemplate and RowMapper objects, - you can have executable query objects (containing row-mapping logic) there. -
-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.
- advice' and
- 'attribute-driven' tags.
- <tx:advice> tag.
- - Note that this is not purely a relational concept; unique primary keys are - required by most database types. -
-- Typically used for AdoTemplate's query methods (with RowMapperResultSetExtractor - adapters). RowMapper objects are typically stateless and thus - reusable; they are ideal choices for implementing row-mapping logic in a single - place. -
-Alternatively, consider subclassing MappingSqlQuery from the Spring.Data.Object - namespace: Instead of working with separate AdoTemplate and RowMapper objects, - you can have executable query objects (containing row-mapping logic) there. -
-- This interface is mainly used within the ADO.NET - framework. An IResultSetExtractor is usually a simpler choice - for result set (DataReader) processing, in particular a - RowMapperResultSetExtractor in combination with a IRowMapper. -
-Allows you to execute any number of operations - on a single IDbCommand, for example a single ExecuteScalar - call or repeated execute calls with varying parameters. -
-Used internally by AdoTemplate, but also useful for - application code. Note that the passed in DbCommand - has been created by the framework and will have its - Connection property set and the Transaction property - set based on the transaction context.
-
- The key values of the supplied
- FQCN.methodName, Assembly.
-
MyNameSpace.MyClass.MyMethod, MyAssembly
-
- Alternative to the standard AOP
- This class is intended to cover the typical case of declarative - transaction demarcation: namely, wrapping a (singleton) target object with a - transactional proxy, proxying all the interfaces that the target implements. -
-
- Internally, a
- The
-
- The target may be any object, in which case a
-
- If left null (the default), the AOP infrastructure works - out which interfaces need proxying by analyzing the target, - proxying all of the interfaces that the target object implements. -
-
- The various transaction attribute descriptors are parsed via
- an instance of the
-
- Internally, a
-
- An example string (method name and transaction attributes) might be: -
-- key = "myMethod", value = "PROPAGATION_REQUIRED,readOnly". -
-
- If specifying a
- Note that this is just necessary if you rely on those interceptors in general. -
-
- The default fallback policy applied by this class is:
-
-
-
- Defaults to using class's transaction attribute if none is associated - with the target method. Any transaction attribute associated with the - target method completely overrides a class transaction attribute. -
-- This implementation caches attributes by method after they are first used. - If it's ever desirable to allow dynamic changing of transaction attributes - (unlikely) caching could be made configurable. Caching is desirable because - of the cost of evaluating rollback rules. -
-
- This is an
null.
- The error code extracted from the generic data access exception for
- a particular provider.
- The exception thrown from a data access operation.
- Allows you to execute any number of operations - on a IDbDataAdapter, for example to Fill a DataSet - or other more advanced operations such as the transfering - data between two different DataSets. -
-Note that the passed in IDbDataAdapter - has been created by the framework and its SelectCommand - will be populated with values for CommandType and Text properties - along with Connection/Transaction properties based on the - calling transaction context. -
-- Note that a RowMapper object is typically stateless and thus reusable; - just the RowMapperResultSetExtractor adapter is stateful. -
-- As an alternative consider subclassing MappingAdoQuery from the - Spring.Data.Objects namespace: Instead of working with separate - AdoTemplate and IRowMapper objects you can have executable - query objects (containing row-mapping logic) there. -
-Allows you to execute any number of operations - on a single IDbCommand, for example a single ExecuteScalar - call or repeated execute calls with varying parameters. -
-Used internally by AdoTemplate, but also useful for - application code. Note that the passed in IDbCommand - has been created by the framework and will have its - Connection property set and the Transaction property - set based on the transaction context.
-
- Holds all status information that
-
- Supports delegating savepoint-related methods to a transaction object
- that implements the
- Transactional code can use this to retrieve status information, - and to programmatically request a rollback (instead of throwing - an exception that causes an implicit rollback). -
-
- Derives from the
- This instructs the transaction manager that the only possible outcome of - the transaction may be a rollback, proceeding with the normal application - workflow though (i.e. no exception). -
-
- For transactions managed by a
-
- Used to associate with the
- Strings must be specified in the following syntax:
- FQCN.methodName=<transaction attribute string> (sans <>).
-
ExampleNamespace.ExampleClass.MyMethod=PROPAGATION_MANDATORY,ISOLATION_DEFAULT
- - This will register all overloaded methods for a given name. Does not support explicit - registration of certain overloaded methods. Supports wildcard style mappings (in - the form "xxx*"), e.g. "Notify*" for "Notify" and "NotifyAll". -
-
- The
- Method names can end with "*" for matching multiple methods. -
-
- The
LogicalThreadContext.SetData("dbProviderName", "database1ProviderName"). The value
- "database1ProviderName" must match a key in the provided TargetDbProviders dictionary.
- - This exception will be thrown either by O/R mapping tools or by custom DAO - implementations. -
-For example, this callback can be used to set the - AcceptChangesDuringFill property, register an event handler - for the FillErrors event, set update batch sizes if your provider - supports such functionality, set the ContinueUpdateOnError property, - or in .NET 2.0 to set the property AcceptChangesDuringUpdate. -
-- Downcast to the appropriate subtype to access vendor specific - functionality.
-- The DataAdapter SelectCommand will be already be - populated with values for CommandType and Text properties - along with Connection/Transaction properties based on the - calling transaction context. -
-
- Because the AOP framework caches advice calculations, this is normally
- faster than just letting the
- Supposed to unbind resources from
-
- Supposed to unbind resources from
-
- Can e.g. perform resource cleanup. -
-- Note that exceptions will get propagated to the commit caller - and cause a rollback of the transaction. -
-- Note that exceptions will get propagated to the commit or rollback - caller, although they will not influence the outcome of the transaction. -
-- Note that a RowMapper object is typically stateless and thus reusable; - just the RowMapperResultSetExtractor adapter is stateful. -
-- As an alternative consider subclassing MappingAdoQuery from the - Spring.Data.Objects namespace: Instead of working with separate - AdoTemplate and IRowMapper objects you can have executable - query objects (containing row-mapping logic) there. -
-- This factory object should be used to obtain reference to a web service - that can be safely cast to a service interface, which allows client code to code - against interface, and not directly against the web service. -
-- The WSDL contract needs to conform to WS-I Basic Profiles. -
-
- This only applies when using an
- The default is to use the system proxy setting. -
-
- This only applies when using an
- As the proxy type does not implement the interface, - we try to find matching methods. -
-- This class will create ServicedComponent wrapper for each of the - specified components and register them with the Component Services. -
-<property> tag.
- - Remoting exporters uses this class as a base proxy class - in order to support lifecycle configuration when exporting - a remote object. -
-
- This method uses property values to configure
- It is very much inspired by Ingo Rammer's example in Chapter 6 of "Advanced .NET Remoting", - but is modified slightly to make it more "Spring-friendly". Basically, the main difference is that - instead of pulling lease configuration from the .NET config file, this implementation relies - on Spring DI to get appropriate values injected, which makes it much more flexible. -
-- Provides a well known location for clients to retrieve - references to CAO references. -
-
- Instances of this class should be used as elements in the Components
- list of the
- This factory object should be used to instantiate and configure
- serviced components created by
- Configuration for this provider requires
null to clear the culture.
- null to clear the culture.
-
- Provides derived classes with a default implementation of
-
- This is an abstract class and as such provides no public constructors. -
-
- Shared state is very useful if you have data that needs to be shared by all instances
- of the same page (or other
- For example,
- This implementation adds support for .aspx pages and scoped objects. -
-
- Uses the
- Pages marked with this attribute will have "close" result predefined. -
-- Developers should call SetResult("close") from the event handler - in order to return control back to the calling page. -
-- This is the most common type of object definition in ASP.Net web applications -
-- Credit: this control uses a slightly modified version of the - Dynarch.com DHTML Calendar, - written by Mihai Bazon. -
-- This is a utility class, and as such exposes no public constructors. -
-- Examples of what would be returned from this method given a url would be: -
-
-
-
-
- If relative path starts with '/' (forward slash), no concatenation will occur - and it will be assumed that the relative path specified is indeed the absolute path - and will be returned verbatim.
-- Otherwise, relative path will be appended to the application path, while making sure that - path separators are not duplicated between the paths.
-
- using( new HttpContextSwitch( "/path" ) )
- {
- Response.Write( Request.FilePath ); // writes "/path/currentcontext.dummy" to response.
- }
- // Request.FilePath has been reset to original url here
-
- The following example shows, how to make a Control support the DI-infrastructure:
-
- class MyControl : Control, ISupportsWebDependencyInjection
- {
- private IApplicationContext _defaultApplicationContext;
-
- public IApplicationContext DefaultApplicationContext
- {
- get { return _defaultApplicationContext; }
- set { _defaultApplicationContext = value; }
- }
-
- override protected AddedControl( Control control, int index )
- {
- WebUtils.InjectDependenciesRecursive( _defaultApplicationContext, control );
- base.AddedControl( control, index );
- }
- }
-
- The following example shows, how to make a ControlCollection support the DI-infrastructure:
-Note, that you MUST implement the single-argument constructor
- class MyControlCollection : ControlCollection, ISupportsWebDependencyInjection
- {
- private IApplicationContext _defaultApplicationContext;
-
- public MyControlCollection( Control owner ) : base( owner )
- {}
-
- public IApplicationContext DefaultApplicationContext
- {
- get { return _defaultApplicationContext; }
- set { _defaultApplicationContext = value; }
- }
-
- override public Add( Control child )
- {
- WebUtils.InjectDependenciesRecursive( _defaultApplicationContext, child );
- base.Add( child );
- }
-
- override public AddAt( int index, Control child )
- {
- WebUtils.InjectDependenciesRecursive( _defaultApplicationContext, child );
- base.AddAt( index, child );
- }
- }
-
-
- Configuration for this provider requires
- This is a utility class, and as such exposes no public constructors. -
-
- As indicated by the exception that can be thrown by this method,
- the ASPX page referred to by the supplied
- Issues a server-side transfer using the
-
- Issues a redirect (to the user-agent - typically a browser) using
- the
- Issues a server-side transfer using the
-
- -
-- This is the most common type of object definition in ASP.Net web applications -
-- Takes an object class name to avoid eager loading of the object class. -
-- Deep copy constructor. -
-
- Configuration for this provider requires
- Configuration for this provider requires
- This class should only be used within the context of an ASP.NET web application. -
-null to clear the culture.
- - The Page class is associated with files that have an .aspx extension. - These files are compiled at run time as Page objects and cached in server memory. -
-
- This class extends
- It also adds support for automatic localization using local page resource file, and - simplifies access to global resources (resources from the message source for the - application context). -
-
- Each validator can itself represent a collection of other validators if it is
- an instance of
- Please see the Validation Framework section in the documentation for more info. -
-- Classes that extend this class are used by Spring.Web client-side - scripting support. -
-- Script blocks are used to insert script code directly into the page, - without references to an external file. -
-- Script file references script code in the external file. -
-- Script file references script code in the external file. -
-- The exporter will create a web service wrapper for the object that is - to be exposed and additionally enable its configuration as a web - service. -
-
- The exported object can be either a standard .NET web service
- implementation, with methods marked using the standard
-
- Defaults to the value of the exporter's object ID. -
-
- Invoked after population of normal object properties but before an init
- callback like
- Invoked after population of normal object properties but before an init
- callback like
- Each validator can itself represent a collection of other validators if it is
- an instance of
- Please see the Validation Framework section in the documentation for more info. -
-- Wizard steps are encapsulated within custom user controls. Wizard - controller takes care of navigation through steps and loading of the - appropriate user control. -
-- Developer implementing wizard needs to inherit from this class and implement - abstract, read-only StepPanel property that will be used as a container - for the wizard steps. Navigation event handlers should call Previous and Next methods - from this class to change current step. -
-
- Parameters can reference variables accessible from the page using the
- standard NAnt style property notation, namely
- The
- [<mode>:]<targetPage>[?param1,param2,...,paramN]
-
-
- Only the
- Examples of valid
-
-
-
- Currently defaults to
- See both the class documentation (
- The supplied
- This is the (relative) path to the target page. -
-- Examples of valid values would be: -
-
-
-
-
- Configuration for this provider requires
- Configuration for this provider requires
- Configuration for this provider requires
null to clear the culture.
- - Parses object definitions according to the standard Spring.NET schema. -
-- The 'various web related properties' currently includes the - intended scope of the object. -
-
- If the supplied
- Each validator can itself represent a collection of other validators if it is
- an instance of
- Please see the Validation Framework section in the documentation for more info. -
-- This strategy checks if objects id ASP.Net page and if it is uses - PageParser to compile and instantiate page instance. Otherwise it - delagates call to its parent. -
-