Modifier and Type	Class and Description
private class	SimpleTransactionScope.CleanupSynchronization
pack-priv static class	SimpleTransactionScope.ScopedObjectsHolder Holder for scoped objects.

Access	Constructor and Description
public	SimpleTransactionScope()

Method Summary

Modifier and Type	Method and Description
public Object	get(String the name of the object to retrieve name, ObjectFactory<?> the `ObjectFactory` to use to create the scoped object if it is not present in the underlying storage mechanism objectFactory) Implements org.springframework.beans.factory.config.Scope.get. Return the object with the given name from the underlying scope, `creating it` if not found in the underlying storage mechanism.
public String	getConversationId() Implements org.springframework.beans.factory.config.Scope.getConversationId. Return the conversation ID for the current underlying scope, if any.
public void	registerDestructionCallback(String the name of the object to execute the destruction callback for name, Runnable the destruction callback to be executed. Note that the passed-in Runnable will never throw an exception, so it can safely be executed without an enclosing try-catch block. Furthermore, the Runnable will usually be serializable, provided that its target object is serializable as well. callback) Implements org.springframework.beans.factory.config.Scope.registerDestructionCallback. Register a callback to be executed on destruction of the specified object in the scope (or at destruction of the entire scope, if the scope does not destroy individual objects but rather only terminates in its entirety).
public Object	remove(String the name of the object to remove name) Implements org.springframework.beans.factory.config.Scope.remove. Remove the object with the given `name` from the underlying scope.
public Object	resolveContextualObject(String the contextual key key) Implements org.springframework.beans.factory.config.Scope.resolveContextualObject. Resolve the contextual object for the given key, if any.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

SimpleTransactionScope	back to summary
public SimpleTransactionScope()

Method Detail

get back to summary

get	back to summary
public Object get(String name, ObjectFactory<?> objectFactory) Implements org.springframework.beans.factory.config.Scope.get. Doc from org.springframework.beans.factory.config.Scope.get. Return the object with the given name from the underlying scope, `creating it` if not found in the underlying storage mechanism. This is the central operation of a Scope, and the only operation that is absolutely required. Parameters name:String the name of the object to retrieve objectFactory:ObjectFactory<?> the `ObjectFactory` to use to create the scoped object if it is not present in the underlying storage mechanism Returns:Object the desired object (never `null`) Annotations @Override

public Object get(String name, ObjectFactory<?> objectFactory)

Implements org.springframework.beans.factory.config.Scope.get.

Doc from org.springframework.beans.factory.config.Scope.get.

Return the object with the given name from the underlying scope, creating it if not found in the underlying storage mechanism.

This is the central operation of a Scope, and the only operation that is absolutely required.

Parameters

name:String: the name of the object to retrieve
objectFactory:ObjectFactory<?>: the ObjectFactory to use to create the scoped object if it is not present in the underlying storage mechanism

Returns:Object

the desired object (never null)

Annotations

@Override

getConversationId back to summary

getConversationId	back to summary
public String getConversationId() Implements org.springframework.beans.factory.config.Scope.getConversationId. Doc from org.springframework.beans.factory.config.Scope.getConversationId. Return the conversation ID for the current underlying scope, if any. The exact meaning of the conversation ID depends on the underlying storage mechanism. In the case of session-scoped objects, the conversation ID would typically be equal to (or derived from) the `session ID`; in the case of a custom conversation that sits within the overall session, the specific ID for the current conversation would be appropriate. Note: This is an optional operation. It is perfectly valid to return `null` in an implementation of this method if the underlying storage mechanism has no obvious candidate for such an ID. Returns:String the conversation ID, or `null` if there is no conversation ID for the current scope Annotations @Override @Nullable

public String getConversationId()

Implements org.springframework.beans.factory.config.Scope.getConversationId.

Doc from org.springframework.beans.factory.config.Scope.getConversationId.

Return the conversation ID for the current underlying scope, if any.

The exact meaning of the conversation ID depends on the underlying storage mechanism. In the case of session-scoped objects, the conversation ID would typically be equal to (or derived from) the session ID; in the case of a custom conversation that sits within the overall session, the specific ID for the current conversation would be appropriate.

Note: This is an optional operation. It is perfectly valid to return null in an implementation of this method if the underlying storage mechanism has no obvious candidate for such an ID.

Returns:String

the conversation ID, or null if there is no conversation ID for the current scope

Annotations

@Override
@Nullable

registerDestructionCallback back to summary

registerDestructionCallback	back to summary
public void registerDestructionCallback(String name, Runnable callback) Implements org.springframework.beans.factory.config.Scope.registerDestructionCallback. Doc from org.springframework.beans.factory.config.Scope.registerDestructionCallback. Register a callback to be executed on destruction of the specified object in the scope (or at destruction of the entire scope, if the scope does not destroy individual objects but rather only terminates in its entirety). Note: This is an optional operation. This method will only be called for scoped beans with actual destruction configuration (DisposableBean, destroy-method, DestructionAwareBeanPostProcessor). Implementations should do their best to execute a given callback at the appropriate time. If such a callback is not supported by the underlying runtime environment at all, the callback must be ignored and a corresponding warning should be logged. Note that 'destruction' refers to automatic destruction of the object as part of the scope's own lifecycle, not to the individual scoped object having been explicitly removed by the application. If a scoped object gets removed via this facade's `remove(String)` method, any registered destruction callback should be removed as well, assuming that the removed object will be reused or manually destroyed. Parameters name:String the name of the object to execute the destruction callback for callback:Runnable the destruction callback to be executed. Note that the passed-in Runnable will never throw an exception, so it can safely be executed without an enclosing try-catch block. Furthermore, the Runnable will usually be serializable, provided that its target object is serializable as well. Annotations @Override

public void registerDestructionCallback(String name, Runnable callback)

Implements org.springframework.beans.factory.config.Scope.registerDestructionCallback.

Doc from org.springframework.beans.factory.config.Scope.registerDestructionCallback.

Register a callback to be executed on destruction of the specified object in the scope (or at destruction of the entire scope, if the scope does not destroy individual objects but rather only terminates in its entirety).

Note: This is an optional operation. This method will only be called for scoped beans with actual destruction configuration (DisposableBean, destroy-method, DestructionAwareBeanPostProcessor). Implementations should do their best to execute a given callback at the appropriate time. If such a callback is not supported by the underlying runtime environment at all, the callback must be ignored and a corresponding warning should be logged.

Note that 'destruction' refers to automatic destruction of the object as part of the scope's own lifecycle, not to the individual scoped object having been explicitly removed by the application. If a scoped object gets removed via this facade's remove(String) method, any registered destruction callback should be removed as well, assuming that the removed object will be reused or manually destroyed.

Parameters

name:String: the name of the object to execute the destruction callback for
callback:Runnable: the destruction callback to be executed. Note that the passed-in Runnable will never throw an exception, so it can safely be executed without an enclosing try-catch block. Furthermore, the Runnable will usually be serializable, provided that its target object is serializable as well.

Annotations

@Override

remove back to summary

remove	back to summary
public Object remove(String name) Implements org.springframework.beans.factory.config.Scope.remove. Doc from org.springframework.beans.factory.config.Scope.remove. Remove the object with the given `name` from the underlying scope. Returns `null` if no object was found; otherwise returns the removed `Object`. Note that an implementation should also remove a registered destruction callback for the specified object, if any. It does, however, not need to execute a registered destruction callback in this case, since the object will be destroyed by the caller (if appropriate). Note: This is an optional operation. Implementations may throw `UnsupportedOperationException` if they do not support explicitly removing an object. Parameters name:String the name of the object to remove Returns:Object the removed object, or `null` if no object was present Annotations @Override @Nullable

public Object remove(String name)

Implements org.springframework.beans.factory.config.Scope.remove.

Doc from org.springframework.beans.factory.config.Scope.remove.

Remove the object with the given name from the underlying scope.

Returns null if no object was found; otherwise returns the removed Object.

Note that an implementation should also remove a registered destruction callback for the specified object, if any. It does, however, not need to execute a registered destruction callback in this case, since the object will be destroyed by the caller (if appropriate).

Note: This is an optional operation. Implementations may throw UnsupportedOperationException if they do not support explicitly removing an object.

Parameters

name:String: the name of the object to remove

Returns:Object

the removed object, or null if no object was present

Annotations

@Override
@Nullable

resolveContextualObject back to summary

resolveContextualObject	back to summary
public Object resolveContextualObject(String key) Implements org.springframework.beans.factory.config.Scope.resolveContextualObject. Doc from org.springframework.beans.factory.config.Scope.resolveContextualObject. Resolve the contextual object for the given key, if any. E.g. the HttpServletRequest object for key "request". Parameters key:String the contextual key Returns:Object the corresponding object, or `null` if none found Annotations @Override @Nullable

public Object resolveContextualObject(String key)

Implements org.springframework.beans.factory.config.Scope.resolveContextualObject.

Doc from org.springframework.beans.factory.config.Scope.resolveContextualObject.

Resolve the contextual object for the given key, if any. E.g. the HttpServletRequest object for key "request".

Parameters

key:String: the contextual key

Returns:Object

the corresponding object, or null if none found

Annotations

@Override
@Nullable

org.springframework.transaction.support back to summary

private Class SimpleTransactionScope.CleanupSynchronization

Class Inheritance

extends Object
implements TransactionSynchronization

java.lang.Object
org.springframework.transaction.support.SimpleTransactionScope.CleanupSynchronization

All Implemented Interfaces

org.springframework.transaction.support.TransactionSynchronization, java.io.Flushable, org.springframework.core.Ordered

Field Summary

Modifier and Type	Field and Description
private final SimpleTransactionScope.ScopedObjectsHolder	scopedObjects

Constructor Summary

Access	Constructor and Description
public	CleanupSynchronization(SimpleTransactionScope.ScopedObjectsHolder scopedObjects)

Method Summary

Modifier and Type	Method and Description
public void	afterCompletion(int completion status according to the `STATUS_*` constants status) Overrides default org.springframework.transaction.support.TransactionSynchronization.afterCompletion. Invoked after transaction commit/rollback.
public void	resume() Overrides default org.springframework.transaction.support.TransactionSynchronization.resume. Resume this synchronization.
public void	suspend() Overrides default org.springframework.transaction.support.TransactionSynchronization.suspend. Suspend this synchronization.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

scopedObjects	back to summary
private final SimpleTransactionScope.ScopedObjectsHolder scopedObjects

Constructor Detail

CleanupSynchronization	back to summary
public CleanupSynchronization(SimpleTransactionScope.ScopedObjectsHolder scopedObjects)

Method Detail

afterCompletion back to summary

afterCompletion	back to summary
public void afterCompletion(int status) Overrides default org.springframework.transaction.support.TransactionSynchronization.afterCompletion. Doc from org.springframework.transaction.support.TransactionSynchronization.afterCompletion. Invoked after transaction commit/rollback. Can perform resource cleanup after transaction completion. Note The transaction will have been committed or rolled back already, but the transactional resources might still be active and accessible. As a consequence, any data access code triggered at this point will still "participate" in the original transaction, allowing to perform some cleanup (with no commit following anymore!), unless it explicitly declares that it needs to run in a separate transaction. Hence: Use `PROPAGATION_REQUIRES_NEW` for any transactional operation that is called from here. Parameters status:int completion status according to the `STATUS_*` constants Annotations @Override

public void afterCompletion(int status)

Overrides default org.springframework.transaction.support.TransactionSynchronization.afterCompletion.

Doc from org.springframework.transaction.support.TransactionSynchronization.afterCompletion.

Invoked after transaction commit/rollback. Can perform resource cleanup after transaction completion.

Note

The transaction will have been committed or rolled back already, but the transactional resources might still be active and accessible. As a consequence, any data access code triggered at this point will still "participate" in the original transaction, allowing to perform some cleanup (with no commit following anymore!), unless it explicitly declares that it needs to run in a separate transaction. Hence: Use PROPAGATION_REQUIRES_NEW for any transactional operation that is called from here.

Parameters

status:int: completion status according to the STATUS_* constants

Annotations

@Override

resume	back to summary
public void resume() Overrides default org.springframework.transaction.support.TransactionSynchronization.resume. Doc from org.springframework.transaction.support.TransactionSynchronization.resume. Resume this synchronization. Supposed to rebind resources to TransactionSynchronizationManager if managing any. Annotations @Override

resume

back to summary

public void resume()

Overrides default org.springframework.transaction.support.TransactionSynchronization.resume.

Doc from org.springframework.transaction.support.TransactionSynchronization.resume.

Resume this synchronization. Supposed to rebind resources to TransactionSynchronizationManager if managing any.

Annotations

@Override

suspend	back to summary
public void suspend() Overrides default org.springframework.transaction.support.TransactionSynchronization.suspend. Doc from org.springframework.transaction.support.TransactionSynchronization.suspend. Suspend this synchronization. Supposed to unbind resources from TransactionSynchronizationManager if managing any. Annotations @Override

suspend

back to summary

public void suspend()

Overrides default org.springframework.transaction.support.TransactionSynchronization.suspend.

Doc from org.springframework.transaction.support.TransactionSynchronization.suspend.

Suspend this synchronization. Supposed to unbind resources from TransactionSynchronizationManager if managing any.

Annotations

@Override

Modifier and Type	Field and Description
pack-priv final Map<String, Runnable>	destructionCallbacks
pack-priv final Map<String, Object>	scopedInstances

public Class SimpleTransactionScope

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class SimpleTransactionScope.CleanupSynchronization

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class SimpleTransactionScope.ScopedObjectsHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail