BigFatLock (DellRoad Stuff Spring Classes 2.0.3 API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.springframework.web.filter.GenericFilterBean
- - org.springframework.web.filter.OncePerRequestFilter
  - - org.dellroad.stuff.servlet.BigFatLock

All Implemented Interfaces:

Filter, Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, ServletContextAware
```
public final class BigFatLock
extends OncePerRequestFilter
```
Class for serializing processing using a big fat lock.
The lock can be acquired using runWithLock(java.lang.Runnable). This class can also be used as a servlet filter.
Trace-level logging for displaying lock acquire and release events is included.

Field Summary
- Fields inherited from class org.springframework.web.filter.OncePerRequestFilter
  ALREADY_FILTERED_SUFFIX
- Fields inherited from class org.springframework.web.filter.GenericFilterBean
  logger

Constructor Summary

Constructors
Constructor and Description

BigFatLock()

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)`
`static boolean`	`isLockHeld()` Verify that the current thread is holding the big fat lock.
`static <V> V`	`runWithLock(Callable<V> action)` Invoke the given action after acquiring the big fat lock.
`static void`	`runWithLock(Runnable action)` Invoke the given action after acquiring the big fat lock.
`String`	`toString()`

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter
doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean
addRequiredProperty, afterPropertiesSet, destroy, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BigFatLock
```
public BigFatLock()
```
- Method Detail
  - doFilterInternal
```
protected void doFilterInternal(HttpServletRequest request,
                    HttpServletResponse response,
                    FilterChain filterChain)
                         throws ServletException,
                                IOException
```
    Specified by:
    
    doFilterInternal in class OncePerRequestFilter
    
    Throws:
    
    ServletException
    
    IOException
  - runWithLock
```
public static void runWithLock(Runnable action)
```
    Invoke the given action after acquiring the big fat lock.
    
    Parameters:
    action - action to perform while locked
  - runWithLock
```
public static <V> V runWithLock(Callable<V> action)
                     throws Exception
```
    Invoke the given action after acquiring the big fat lock.
    
    Type Parameters:
    V - action return type
    Parameters:
    action - action to perform while locked
    
    Returns:
    result from action
    
    Throws:
    
    Exception - if action throws an exception
  - isLockHeld
```
public static boolean isLockHeld()
```
    Verify that the current thread is holding the big fat lock.
    
    Returns:
    true if lock is held
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2016. All rights reserved.