Top Description Fields Constructors Methods
org.springframework.aop.framework

public final Class AopContext

extends Object
Class Inheritance
Imports
org.springframework.core.NamedThreadLocal, org.springframework.lang.Nullable
Class containing static methods used to obtain information about the current AOP invocation.

The currentProxy() method is usable if the AOP framework is configured to expose the current proxy (not the default). It returns the AOP proxy in use. Target objects or advice can use this to make advised calls, in the same way as getEJBObject() can be used in EJBs. They can also use it to find advice configuration.

Spring's AOP framework does not expose proxies by default, as there is a performance cost in doing so.

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 AOP framework in particular.

Authors
Rod Johnson, Juergen Hoeller
Since
13.03.2003

Field Summary

Modifier and TypeField and Description
private static final ThreadLocal<Object>
currentProxy

ThreadLocal holder for AOP proxy associated with this thread.

Constructor Summary

AccessConstructor and Description
private
AopContext()

Method Summary

Modifier and TypeMethod and Description
public static Object

Returns:

the current AOP proxy (never returns null)
currentProxy()

Try to return the current AOP proxy.

pack-priv static Object

Returns:

the old proxy, which may be null if none was bound
setCurrentProxy(Object
the proxy to expose (or null to reset it)
proxy)

Make the given proxy available via the currentProxy() method.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

currentProxyback to summary
private static final ThreadLocal<Object> currentProxy

ThreadLocal holder for AOP proxy associated with this thread. Will contain null unless the "exposeProxy" property on the controlling proxy configuration has been set to "true".

See Also
ProxyConfig#setExposeProxy

Constructor Detail

AopContextback to summary
private AopContext()

Method Detail

currentProxyback to summary
public static Object currentProxy() throws IllegalStateException

Try to return the current AOP proxy. This method is usable only if the calling method has been invoked via AOP, and the AOP framework has been set to expose proxies. Otherwise, this method will throw an IllegalStateException.

Returns:Object

the current AOP proxy (never returns null)

Exceptions
IllegalStateException:
if the proxy cannot be found, because the method was invoked outside an AOP invocation context, or because the AOP framework has not been configured to expose the proxy
setCurrentProxyback to summary
pack-priv static Object setCurrentProxy(Object proxy)

Make the given proxy available via the currentProxy() method.

Note that the caller should be careful to keep the old value as appropriate.

Parameters
proxy:Object

the proxy to expose (or null to reset it)

Returns:Object

the old proxy, which may be null if none was bound

Annotations
@Nullable
See Also
currentProxy()