ClassLoaderLeakPreventorFactory (ClassLoader Leak Prevention library 2.7.0 API)

java.lang.Object
- se.jiderhamn.classloader.leak.prevention.ClassLoaderLeakPreventorFactory

```
public class ClassLoaderLeakPreventorFactory
extends Object
```
Orchestrator class responsible for invoking the preventative and cleanup measures. Contains the configuration and can be reused for multiple classloaders (assume it is not itself loaded by the classloader which we want to avoid leaking). In that case, the logger may need to be thread safe.

Author:

Mattias Jiderhamn

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,ClassLoaderPreMortemCleanUp>`	`cleanUps` Map from name to `ClassLoaderPreMortemCleanUp`s with all the actions to invoke to make a `ClassLoader` ready for Garbage Collection.
`protected ClassLoader`	`leakSafeClassLoader` `ClassLoader` to be used when invoking the `PreClassLoaderInitiator`s.
`protected Logger`	`logger` The `Logger` that will be passed on to the different `PreClassLoaderInitiator`s and `ClassLoaderPreMortemCleanUp`s
`protected Map<String,PreClassLoaderInitiator>`	`preInitiators` Map from name to `PreClassLoaderInitiator`s with all the actions to invoke in the `leakSafeClassLoader`.

Constructor Summary

Constructors
Constructor and Description
`ClassLoaderLeakPreventorFactory()` Create new `ClassLoaderLeakPreventorFactory` with `ClassLoader.getSystemClassLoader()` as the `leakSafeClassLoader` and default `PreClassLoaderInitiator`s and `ClassLoaderPreMortemCleanUp`s.
`ClassLoaderLeakPreventorFactory(ClassLoader leakSafeClassLoader)` Create new `ClassLoaderLeakPreventorFactory` with supplied `ClassLoader` as the `leakSafeClassLoader` and default `PreClassLoaderInitiator`s and `ClassLoaderPreMortemCleanUp`s.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCleanUp(ClassLoaderPreMortemCleanUp classLoaderPreMortemCleanUp)` Add a new `ClassLoaderPreMortemCleanUp`, using the class name as name
`void`	`addCleanUp(String name, ClassLoaderPreMortemCleanUp classLoaderPreMortemCleanUp)` Add a new named `ClassLoaderPreMortemCleanUp`
`void`	`addPreInitiator(PreClassLoaderInitiator preClassLoaderInitiator)` Add a new `PreClassLoaderInitiator`, using the class name as name
`void`	`clearCleanUps()` Remove all the currently configured `ClassLoaderPreMortemCleanUp`s
`void`	`clearPreInitiators()` Remove all the currently configured `PreClassLoaderInitiator`s
`void`	`configureDefaults()` Configure default `PreClassLoaderInitiator`s and `ClassLoaderPreMortemCleanUp`s
`<C extends ClassLoaderPreMortemCleanUp> C`	`getCleanUp(Class<C> clazz)` Get instance of `ClassLoaderPreMortemCleanUp` for further configuring.
`<C extends PreClassLoaderInitiator> C`	`getPreInitiator(Class<C> clazz)` Get instance of `PreClassLoaderInitiator` for further configuring.
`ClassLoaderLeakPreventor`	`newLeakPreventor()` Create new `ClassLoaderLeakPreventor` used to prevent the provided `Thread.contextClassLoader` of the `Thread.currentThread()` from leaking.
`ClassLoaderLeakPreventor`	`newLeakPreventor(ClassLoader classLoader)` Create new `ClassLoaderLeakPreventor` used to prevent the provided `ClassLoader` from leaking
`<C extends ClassLoaderPreMortemCleanUp> void`	`removeCleanUp(Class<C> clazz)` Get instance of `ClassLoaderPreMortemCleanUp` for further configuring
`<C extends PreClassLoaderInitiator> void`	`removePreInitiator(Class<C> clazz)` Get instance of `PreClassLoaderInitiator` for further configuring
`void`	`setLogger(Logger logger)` Set logger

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

- Field Detail
  - leakSafeClassLoader
```
protected final ClassLoader leakSafeClassLoader
```
    ClassLoader to be used when invoking the PreClassLoaderInitiators. Defaults to ClassLoader.getSystemClassLoader(), but could be any other framework or app server classloader.
  - logger
```
protected Logger logger
```
    The Logger that will be passed on to the different PreClassLoaderInitiators and ClassLoaderPreMortemCleanUps
  - preInitiators
```
protected final Map<String,PreClassLoaderInitiator> preInitiators
```
    Map from name to PreClassLoaderInitiators with all the actions to invoke in the leakSafeClassLoader. Maintains insertion order. Thread safe.
  - cleanUps
```
protected final Map<String,ClassLoaderPreMortemCleanUp> cleanUps
```
    Map from name to ClassLoaderPreMortemCleanUps with all the actions to invoke to make a ClassLoader ready for Garbage Collection. Maintains insertion order. Thread safe.
- Constructor Detail
  - ClassLoaderLeakPreventorFactory
```
public ClassLoaderLeakPreventorFactory()
```
    Create new ClassLoaderLeakPreventorFactory with ClassLoader.getSystemClassLoader() as the leakSafeClassLoader and default PreClassLoaderInitiators and ClassLoaderPreMortemCleanUps.
  - ClassLoaderLeakPreventorFactory
```
public ClassLoaderLeakPreventorFactory(ClassLoader leakSafeClassLoader)
```
    Create new ClassLoaderLeakPreventorFactory with supplied ClassLoader as the leakSafeClassLoader and default PreClassLoaderInitiators and ClassLoaderPreMortemCleanUps.
- Method Detail
  - configureDefaults
```
public void configureDefaults()
```
    Configure default PreClassLoaderInitiators and ClassLoaderPreMortemCleanUps
  - newLeakPreventor
```
public ClassLoaderLeakPreventor newLeakPreventor()
```
    Create new ClassLoaderLeakPreventor used to prevent the provided Thread.contextClassLoader of the Thread.currentThread() from leaking. Please be aware that ClassLoaderLeakPreventors created by the same factory share the same PreClassLoaderInitiator and ClassLoaderPreMortemCleanUp instances, in case their config is changed.
  - newLeakPreventor
```
public ClassLoaderLeakPreventor newLeakPreventor(ClassLoader classLoader)
```
    Create new ClassLoaderLeakPreventor used to prevent the provided ClassLoader from leaking
  - setLogger
```
public void setLogger(Logger logger)
```
    Set logger
  - addPreInitiator
```
public void addPreInitiator(PreClassLoaderInitiator preClassLoaderInitiator)
```
    Add a new PreClassLoaderInitiator, using the class name as name
  - addCleanUp
```
public void addCleanUp(ClassLoaderPreMortemCleanUp classLoaderPreMortemCleanUp)
```
    Add a new ClassLoaderPreMortemCleanUp, using the class name as name
  - addCleanUp
```
public void addCleanUp(String name,
                       ClassLoaderPreMortemCleanUp classLoaderPreMortemCleanUp)
```
    Add a new named ClassLoaderPreMortemCleanUp
  - clearPreInitiators
```
public void clearPreInitiators()
```
    Remove all the currently configured PreClassLoaderInitiators
  - clearCleanUps
```
public void clearCleanUps()
```
    Remove all the currently configured ClassLoaderPreMortemCleanUps
  - getPreInitiator
```
public <C extends PreClassLoaderInitiator> C getPreInitiator(Class<C> clazz)
```
    Get instance of PreClassLoaderInitiator for further configuring. Please be aware that ClassLoaderLeakPreventors created by the same factory share the same PreClassLoaderInitiator and ClassLoaderPreMortemCleanUp instances, in case their config is changed.
  - getCleanUp
```
public <C extends ClassLoaderPreMortemCleanUp> C getCleanUp(Class<C> clazz)
```
    Get instance of ClassLoaderPreMortemCleanUp for further configuring. Please be aware that ClassLoaderLeakPreventors created by the same factory share the same PreClassLoaderInitiator and ClassLoaderPreMortemCleanUp instances, in case their config is changed.
  - removePreInitiator
```
public <C extends PreClassLoaderInitiator> void removePreInitiator(Class<C> clazz)
```
    Get instance of PreClassLoaderInitiator for further configuring
  - removeCleanUp
```
public <C extends ClassLoaderPreMortemCleanUp> void removeCleanUp(Class<C> clazz)
```
    Get instance of ClassLoaderPreMortemCleanUp for further configuring

Class ClassLoaderLeakPreventorFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

leakSafeClassLoader

logger

preInitiators

cleanUps

Constructor Detail

ClassLoaderLeakPreventorFactory

ClassLoaderLeakPreventorFactory

Method Detail

configureDefaults

newLeakPreventor

newLeakPreventor

setLogger

addPreInitiator

addCleanUp

addCleanUp

clearPreInitiators

clearCleanUps

getPreInitiator

getCleanUp

removePreInitiator

removeCleanUp