org.glassfish.hk2.api

Interface TwoPhaseResource

public interface TwoPhaseResource

Implementations of this interface can be added to a DynamicConfiguration in order to atomically participate in the changes being made to the ServiceLocator. No changes to the ServiceLocator can be made from any method of this interface, otherwise the ServiceLocator can be left in an inconsistent state

Author:

jwells

Method Summary

Modifier and Type	Method and Description
void	activateDynamicConfiguration(TwoPhaseTransactionData dynamicConfiguration) Once all TwoPhaseResource prepare methods have completed successfully the activate method will be called on all registered TwoPhaseResource implementations.
void	prepareDynamicConfiguration(TwoPhaseTransactionData dynamicConfiguration) This method is called prior to any changes being made to the ServiceLocator but after the IdempotentFilters are called.
void	rollbackDynamicConfiguration(TwoPhaseTransactionData dynamicConfiguration) If any TwoPhaseResource fails then all TwoPhaseResources that successfully completed their prepare method will get this method invoked.

Method Detail

prepareDynamicConfiguration

void prepareDynamicConfiguration(TwoPhaseTransactionData dynamicConfiguration)
                          throws MultiException

This method is called prior to any changes being made to the ServiceLocator but after the IdempotentFilters are called. If this method throws any exception the entire transaction will not go forward and the thrown exception will be thrown back to the caller. If this method completes successfully then either the commit or rollback methods will be called eventually once the final outcome of the transaction has been established. This method is called with the write lock of the ServiceLocator held

Parameters:

dynamicConfiguration - Information about the dynamic configuration for which this resource was registered

Throws:

MultiException - If for some reason the transaction can not go through the expected exception is a MultiException with enclosed exceptions detailing the reasons why the transaction cannot complete. No subsequent TwoPhaseResource listeners will be invoked once any TwoPhaseResource throws any exception

activateDynamicConfiguration

void activateDynamicConfiguration(TwoPhaseTransactionData dynamicConfiguration)

Once all TwoPhaseResource prepare methods have completed successfully the activate method will be called on all registered TwoPhaseResource implementations. Any exception from this method will be ignored (though they will be logged if debug logging is turned on). This method is called after the write lock has been released and all other listeners have been called

Parameters:

dynamicConfiguration - Information about the dynamic configuration for which this resource was registered

rollbackDynamicConfiguration

void rollbackDynamicConfiguration(TwoPhaseTransactionData dynamicConfiguration)

If any TwoPhaseResource fails then all TwoPhaseResources that successfully completed their prepare method will get this method invoked. Any exceptions from this method will be ignored (though they will be logged if debugging is turned on). This method is called with the write lock of the ServiceLocator held

Parameters:

dynamicConfiguration - Information about the dynamic configuration for which this resource was registered