org.springframework.transaction.interceptor
Class RollbackRuleAttribute

java.lang.Object
  org.springframework.transaction.interceptor.RollbackRuleAttribute

Direct Known Subclasses:

NoRollbackRuleAttribute

public class RollbackRuleAttribute

extends java.lang.Object

Rule determining whether or not a given exception (and any subclasses) should cause a rollback. Multiple such rules can be applied to determine whether a transaction should commit or rollback after an exception has been thrown.

Since:

09-Apr-2003

Version:

$Id: RollbackRuleAttribute.java,v 1.6 2004/03/18 02:46:05 trisberg Exp $

Author:

Rod Johnson

See Also:

NoRollbackRuleAttribute

Field Summary

static RollbackRuleAttribute

ROLLBACK_ON_RUNTIME_EXCEPTIONS

Constructor Summary

RollbackRuleAttribute(java.lang.Class clazz)
Preferred way to construct a RollbackRule, matching the exception class and subclasses.

RollbackRuleAttribute(java.lang.String exceptionName)
Construct a new RollbackRule for the given exception name.

Method Summary

int	getDepth(java.lang.Throwable t) Return the depth to the superclass matching.
java.lang.String	getExceptionName() Return the pattern for the exception name.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ROLLBACK_ON_RUNTIME_EXCEPTIONS

public static final RollbackRuleAttribute ROLLBACK_ON_RUNTIME_EXCEPTIONS

Constructor Detail

RollbackRuleAttribute

public RollbackRuleAttribute(java.lang.Class clazz)

Preferred way to construct a RollbackRule, matching the exception class and subclasses. The exception class must be Throwable or a subclass of Throwable.

Parameters:

clazz - throwable class

RollbackRuleAttribute

public RollbackRuleAttribute(java.lang.String exceptionName)

Construct a new RollbackRule for the given exception name. This can be a substring, with no wildcard support at present. A value of "ServletException" would match ServletException and subclasses, for example.

NB: Consider carefully how specific the pattern is, and whether to include package information (which isn't mandatory). For example, "Exception" will match nearly anything, and will probably hide other rules. "java.lang.Exception" would be correct if "Exception" was meant to define a rule for all checked exceptions. With more unusual Exception names such as "BaseBusinessException" there's no need to use a FQN.

Parameters:

exceptionName - the exception pattern

Method Detail

getExceptionName

public java.lang.String getExceptionName()

Return the pattern for the exception name.

getDepth

public int getDepth(java.lang.Throwable t)

Return the depth to the superclass matching. 0 means t matches. Return -1 if there's no match. Otherwise, return depth. Lowest depth wins.

toString

public java.lang.String toString()