# apache/commons-pool architecture

> Architecture diagram of the GitHub repository apache/commons-pool, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/apache/commons-pool
- Repository: https://github.com/apache/commons-pool

## Overview

##### Main Components Structure

a) Core API Layer
- Main interfaces: `ObjectPool`, `KeyedObjectPool`, `PooledObjectFactory`, `KeyedPooledObjectFactory`
- Base abstract classes: `BaseObjectPool`, `BasePooledObjectFactory`, `BaseKeyedPooledObjectFactory`

b) Implementation Layer
- Feature the primary implementations: `GenericObjectPool`, `GenericKeyedObjectPool`
- Supporting components: `DefaultPooledObject`, `EvictionPolicy`

c) Proxy Layer
- Proxy mechanism: `ProxiedObjectPool`, `ProxiedKeyedObjectPool`
- Proxy sources: `JdkProxySource`, `CglibProxySource`

##### Component Relationships

**[Client Application]**
- ↓
**[ObjectPool Interface] ←→ [PooledObjectFactory Interface]**
- ↓                         ↓
**[GenericObjectPool] ←→ [DefaultPooledObject]**
- ↓
**[Proxy Layer]**

##### Key Elements to Highlight

a) Pool Management:
- Lifecycle management flow
- Eviction policies
- Abandoned object tracking

b) Configuration:
- `GenericObjectPoolConfig`
- `AbandonedConfig`
- `EvictionConfig`

##### Monitoring & Management

A section showing:
- JMX integration (`GenericObjectPoolMXBean`)
- Usage tracking components
- Statistics collection

##### Implementation Details

Important implementation features:
- Thread safety mechanisms
- Resource management
- Exception handling
- Performance optimizations

Remember to include notes about:
- Thread safety considerations
- Performance characteristics
- Extension points
- Common usage patterns

This will provide a comprehensive view of the Commons Pool architecture while maintaining clarity about its core purpose of object pooling.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Client Application"
        Client[Client Application]:::client
    end

    subgraph "Core API Layer"
        ObjectPool["ObjectPool Interface"]:::interface
        KeyedObjectPool["KeyedObjectPool Interface"]:::interface
        PooledObjectFactory["PooledObjectFactory Interface"]:::interface
        KeyedPooledObjectFactory["KeyedPooledObjectFactory Interface"]:::interface
        BaseObjectPool["BaseObjectPool"]:::abstract
        BasePooledObjectFactory["BasePooledObjectFactory"]:::abstract
        BaseKeyedPooledObjectFactory["BaseKeyedPooledObjectFactory"]:::abstract
    end

    subgraph "Implementation Layer"
        GenericObjectPool["GenericObjectPool"]:::implementation
        GenericKeyedObjectPool["GenericKeyedObjectPool"]:::implementation
        DefaultPooledObject["DefaultPooledObject"]:::implementation
        EvictionPolicy["EvictionPolicy"]:::implementation
    end

    subgraph "Proxy Layer"
        ProxiedObjectPool["ProxiedObjectPool"]:::proxy
        ProxiedKeyedObjectPool["ProxiedKeyedObjectPool"]:::proxy
        JdkProxySource["JdkProxySource"]:::proxy
        CglibProxySource["CglibProxySource"]:::proxy
    end

    subgraph "Configuration"
        GenericObjectPoolConfig["GenericObjectPoolConfig"]:::config
        AbandonedConfig["AbandonedConfig"]:::config
        EvictionConfig["EvictionConfig"]:::config
    end

    subgraph "Monitoring"
        GenericObjectPoolMXBean["GenericObjectPoolMXBean"]:::monitoring
        GenericKeyedObjectPoolMXBean["GenericKeyedObjectPoolMXBean"]:::monitoring
    end

    %% Relationships
    Client --> ObjectPool
    Client --> KeyedObjectPool
    ObjectPool --> PooledObjectFactory
    KeyedObjectPool --> KeyedPooledObjectFactory
    BaseObjectPool --> ObjectPool
    BasePooledObjectFactory --> PooledObjectFactory
    BaseKeyedPooledObjectFactory --> KeyedPooledObjectFactory
    GenericObjectPool --> BaseObjectPool
    GenericKeyedObjectPool --> KeyedObjectPool
    GenericObjectPool --> DefaultPooledObject
    GenericObjectPool --> EvictionPolicy
    ProxiedObjectPool --> ObjectPool
    ProxiedKeyedObjectPool --> KeyedObjectPool
    JdkProxySource --> ProxiedObjectPool
    CglibProxySource --> ProxiedObjectPool
    GenericObjectPoolConfig --> GenericObjectPool
    AbandonedConfig --> GenericObjectPool
    EvictionConfig --> EvictionPolicy
    GenericObjectPoolMXBean --> GenericObjectPool
    GenericKeyedObjectPoolMXBean --> GenericKeyedObjectPool

    %% Click Events
    click ObjectPool "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/ObjectPool.java"
    click KeyedObjectPool "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/KeyedObjectPool.java"
    click PooledObjectFactory "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/PooledObjectFactory.java"
    click KeyedPooledObjectFactory "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/KeyedPooledObjectFactory.java"
    click BaseObjectPool "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/BaseObjectPool.java"
    click BasePooledObjectFactory "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/BasePooledObjectFactory.java"
    click BaseKeyedPooledObjectFactory "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/BaseKeyedPooledObjectFactory.java"
    click GenericObjectPool "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/impl/GenericObjectPool.java"
    click GenericKeyedObjectPool "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java"
    click DefaultPooledObject "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObject.java"
    click EvictionPolicy "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/impl/EvictionPolicy.java"
    click ProxiedObjectPool "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/proxy/ProxiedObjectPool.java"
    click ProxiedKeyedObjectPool "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/proxy/ProxiedKeyedObjectPool.java"
    click JdkProxySource "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/proxy/JdkProxySource.java"
    click CglibProxySource "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/proxy/CglibProxySource.java"
    click GenericObjectPoolConfig "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/impl/GenericObjectPoolConfig.java"
    click AbandonedConfig "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/impl/AbandonedConfig.java"
    click EvictionConfig "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/impl/EvictionConfig.java"
    click GenericObjectPoolMXBean "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/impl/GenericObjectPoolMXBean.java"
    click GenericKeyedObjectPoolMXBean "https://github.com/apache/commons-pool/blob/master/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPoolMXBean.java"

    %% Styles
    classDef client fill:#f9f,stroke:#333,stroke-width:2px
    classDef interface fill:#a7c7e7,stroke:#333,stroke-width:2px
    classDef abstract fill:#b19cd9,stroke:#333,stroke-width:2px
    classDef implementation fill:#90ee90,stroke:#333,stroke-width:2px
    classDef proxy fill:#ffeb99,stroke:#333,stroke-width:2px
    classDef config fill:#ffa07a,stroke:#333,stroke-width:2px
    classDef monitoring fill:#98fb98,stroke:#333,stroke-width:2px
```
