The Programmer's Guide
  • About
  • AI
  • Algorithm
    • Big O Notation
      • Tree
      • Problems
    • Basic Notes
    • Data Structure Implementation
      • Custom LinkedList
      • Custom Stack
      • Custom Queue
      • Custom Tree
        • Binary Tree Implementation
        • Binary Search Tree Implementation
        • Min Heap Implementation
        • Max Heap Implementation
        • Trie Implementation
      • Custom Graph
        • Adjacency List
        • Adjacency Matrix
        • Edge List
        • Bidirectional Search
    • Mathematical Algorithms
      • Problems - Set 1
      • Problems - Set 2
    • Bit Manipulation
      • Representation
      • Truth Tables
      • Number System
        • Java Program
      • Problems - Set 1
    • Searching
    • Sorting
    • Array Algorithms
    • String Algorithms
      • Problems - Set 1
    • Sliding Window Programming
      • Problems - Set 1
    • Tree
      • Tree Traversal Techniques
      • Tree Implementation
      • AVL Tree
      • Red-Black Trees
      • Applications of Trees
      • Problems - Set 1
    • Graph
      • Graph Traversal Techniques
      • Shortest Path Algorithms
        • Dijkstra’s Algorithm
      • Minimum Spanning Tree (MST) Algorithms
      • Topological Sort
    • Dynamic Programming
      • Problems - Set 1
    • Greedy Programming
    • Recursion
    • Parallel Programming
      • Problems - Set 1
    • Miscellaneous
      • Problems - Set 1
  • API
    • API Fundamentals
      • Terminology
      • What is an API ?
      • Consumers & Providers
      • Request & Response
      • Types of API
    • API Communication Patterns
      • Synchronous Communication
        • Request-Response Pattern (Blocking)
        • Request-Response Pattern (Non-blocking)
        • Client Polling
      • Asynchronous Communication
        • Request-Response Pattern (Truly Asynchronous)
        • Event-Driven Pattern
        • Publish-Subscribe Pattern
        • Streaming & Real-Time APIs
          • Server-Sent Events (SSE)
          • WebSockets
          • gRPC Streaming
        • Webhooks (HTTP Callbacks)
      • Hybrid or Adaptive Patterns
        • Async Requests with Sync Feedback
        • Request-Response with Async Push Updates
        • Sync-Async Failover Patterns
    • API Styles & Protocols
      • REST API
        • RESTful API Principles
        • HTTP Status Code
        • HTTP Verbs or Methods
        • HTTP Headers
          • Content Type
          • Content-Disposition
        • Query Parameters & Path Parameters
          • Handling Special Characters in URL
    • API Lifecycle Management
      • API Compatibility
        • Backward Compatibility
        • Forward Compatibility
      • API Versioning Strategies
        • REST API Versioning Approaches
        • GraphQL API Versioning Approaches
      • API Deprecation
        • REST API Deprecation Approach
    • Data Handling
      • Pagination
      • Filtering
      • Sorting
      • Field Selection (Projection)
    • Naming Guidelines
      • API Endpoint Naming
      • Parameter Naming
      • Field and Property Naming
      • Error Codes and Messages
      • Versioning Naming
    • API Testing
      • Tools
        • Postman
        • SoapUI
        • Curl
  • Database
    • DBMS
      • Types of DBMS
        • Relational DBMS (RDBMS)
        • NoSQL DBMS
        • Object-Oriented DBMS (OODBMS)
        • Columnar DBMS
        • In-Memory DBMS
        • Distributed DBMS
        • Cloud-Based DBMS
        • Hierarchical DBMS
      • DBMS Architecture
      • DBMS Structure
    • SQL Databases
      • Terminology
      • RDBMS Concepts
        • Entity Relationship Diagram (ERD)
          • ERD Examples
        • Normalization
        • Denormalization
        • ACID Properties
        • Locking and Unlocking
      • SQL Fundamentals
        • SQL Commands
          • DDL (Data Definition Language)
          • DML (Data Manipulation Language)
          • DCL (Data Control Language)
          • TCL (Transaction Control Language)
          • DQL (Data Query Language)
        • SQL Operators
          • INTERSECT
          • EXCEPT
          • MINUS
          • IN and NOT IN
          • EXISTS and NOT EXISTS
        • SQL Clauses
          • Joins
          • OVER
          • WITH
          • CONNECT BY
          • MODEL
          • FETCH FIRST
          • KEEP
          • OFFSET with FETCH
        • SQL Functions
          • Oracle Specific
        • SQL Data Types
          • Numeric Types
          • Character Types
          • Date & Time Types
          • Large Object Types
      • Vendor Specific Concepts
        • Oracle Specific
          • Data Types
            • BLOB
            • Use Case
          • Character Set
          • Rownum, Rowid, Urowid
          • Order of Execution of the query
          • Execution Plan
            • Understand Execution Plan
          • Keys
          • Tablespace
          • Partition
        • Oracle Examples
        • MYSQL Specific
          • Collation
          • Character Set
        • MYSQL Examples
      • Best Practice
      • Resources & References
        • O’Reilly SQL Cookbook (2nd Edition)
          • 1. Retrieving Records
          • 2. Sorting Query Results
          • 3. Working with Multiple Tables
          • 4. Inserting, Updating, and Deleting
          • 5. Metadata Queries
          • 6. Working with Strings
          • 7. Working with Numbers
          • 8. Date Arithmetic
          • 9. Date Manipulation
          • 10. Working with Ranges
          • 11. Advanced Searching
          • 12. Reporting and Reshaping
          • 13. Hierarchical Queries
          • 14. Odds 'n' Ends
    • NoSQL Databases
      • Concepts
        • Characteristics
        • BASE Properties
        • Eventual Consistency
        • Schema-less Design
        • Sharding
        • Partitioning
        • Transactions
        • Aggregation
        • Projections
        • CRUD Operations
      • Data Models
        • Document Store
        • Key-Value Store
        • Column-Family Store
        • Graph Database
        • Multi-Model Database
    • SQL vs NoSQL
      • ACID & BASE Properties
    • Query Concepts & Performance
      • count(1) vs count(*)
      • Access Multiple Schemas in Single Query
      • Subquery vs Joins
      • Single SQL vs PLSQL Query
  • Git
    • Commands
      • Setup and Configuration Commands
      • Getting and Creating Projects
      • Tracking Changes
      • Branching and Merging
      • Sharing and Updating Projects
      • Inspection and Comparison
      • Debugging
      • Patching
      • Stashing and Cleaning
      • Advanced Manipulations
    • Workflows
      • Branching Strategies
        • Git Flow
        • Trunk-Based Development
        • GitHub Flow
        • Comparison
      • Merge Strategies
        • Merge
        • Rebase
        • Squash
        • Fast-forward vs No-fast-forward
        • MR vs PR
      • Conflict Resolution
        • Handling Merge Conflicts
        • Merge Conflicts
        • Rebase Conflicts
        • Divergent Branches After git pull
        • Force Push
      • Patch & Recovery
        • Cherry-pick strategies
        • Revert vs Reset
        • Recover from a bad rebase
      • Rebasing Practices
        • Merge vs Rebase
        • Rebase develop branch on main branch
      • Repository Management
        • Working Directory
        • Mirror a repository
        • Convert a local folder to a Git repo
        • Backup and restore a Git repository
    • Platforms
      • GitHub
      • GitLab
        • Freeze a branch
      • Bitbucket
  • Identity and Access Management (IAM)
    • Authentication
      • Authentication Methods
    • Keycloak
      • Terminologies
      • Token Verification
      • User Federation
        • Settings
          • Provider - LDAP
        • Integrating OpenLDAP
    • LDAP
      • Local OpenLDAP Setup
    • Single Sign-On (SSO)
  • Java
    • Installation & Setup
      • Installation
      • Java Distributions
      • Java Platform Editions
        • Java SE
        • Java EE
        • Jakarta EE
        • Java ME
        • JavaFX
    • Java Evolution
      • Java Feature Introduction Process
      • Java Version History
        • Java 8
        • Java 9
      • FAQ
    • Java Basics
      • OOP Principles
        • Encapsulation
        • Inheritance
          • Method Overriding
          • Constructor Chaining
          • Dynamic Method Dispatch
          • Inheritance vs. Composition
          • Diamond Problem
        • Polymorphism
          • Rules for Polymorphism
        • Abstraction
          • Abstract Class & Method
          • Interface
            • Functional Interfaces
            • Marker Interfaces
          • Abstract Class vs Interface
          • Model as an Interface or abstract class ?
      • OOP Basics
        • What is a Class?
          • Types of Classes
        • What is an Object?
          • Equals and HashCode
            • FAQ
          • Shallow Copy and Deep Copy
          • Ways to Create Object
          • Serialization & Deserialization
        • Methods & Fields
          • Method Signature & Header
          • Method Overriding & Overloading
          • Variables
        • Constructors
        • Access Modifiers
      • Java Keywords
        • this
        • super
        • null
          • Handle Null Value
        • Access Modifiers
      • Java Data Types
        • Default Values
        • Primitive Types
          • byte
          • short
          • int
          • long
          • float
          • double
          • char
          • boolean
        • Non-Primitive (Reference) Types
          • String
            • StringBuilder
            • StringBuffer
              • Problems
            • Multiline String
            • Comparison - String, StringBuilder & StringBuffer
          • Array
          • Collections
            • List
              • Array vs List
              • ArrayList
              • Vector
                • Stack
                  • Problems
              • LinkedList
              • Examples
            • Queue
              • PriorityQueue
              • Deque (Double-Ended Queue)
                • ArrayDeque
            • Map
              • HashMap
              • Hashtable
                • Collision Resolution
              • LinkedHashMap
              • ConcurrentHashMap
              • TreeMap
              • EnumMap
              • WeakHashMap
            • Set
              • HashSet
              • LinkedHashSet
              • TreeSet
              • EnumSet
              • ConcurrentSkipListSet
              • CopyOnWriteArraySet
        • Specialized Classes
          • BigInteger
          • BigDecimal
            • Examples
          • BitSet
          • Date and Time
            • Comparison
            • Examples
          • Optional
          • Math
          • UUID
          • Scanner
          • Formatter
            • Examples
          • Properties
          • Regex (Pattern and Matcher)
            • Examples
          • Atomic Classes
          • Random
          • Format
            • NumberFormat
            • DateFormat
            • DecimalFormat
        • Others
          • Object
          • Enum
            • Pre-Defined Enum
            • Custom Enum
            • EnumSet and EnumMap
            • Enum Comparison
          • Record
          • Optional
          • System
          • Runtime
          • ProcessBuilder
          • Class
          • Void
          • Throwable
            • Error
            • Exception
              • Custom Exception Handling
              • Best Practice
            • Error vs Exception
            • StackTraceElement
      • Java Operators
        • Operator Precedence
        • Problems
      • Parallelism & Concurrency
        • Ways to Identify Thread Concurrency or Parallelism
        • Thread Fundamentals
          • Thread vs Process
          • Creating Threads
            • Runnable & Callable
            • Comparison
            • Examples
          • Thread Context Switching
          • Thread Lifecycle & States
          • Types of Threads
          • Thread Priority
          • Memory Sharing Between Threads
          • Thread Completion & JVM Exit
    • Java Internals
      • JVM Overview
        • Architecture
        • Components
        • Lifecycle
        • Command Line Arguments
      • Memory Management
        • References
        • Types of Memory
    • Java Concepts
      • Language Essentials
        • Annotation
          • Annotation Processing
          • Types of Annotations
            • Custom Annotation
              • Use Case
            • Meta Annotation
        • Generics
          • Covariance and Invariance
        • Scoped Values
        • Unnamed Variables & Patterns
      • Concurrency & Multithreading
        • Thread Management & Synchronisation
          • Thread Resource Sharing
          • Thread Synchronization
            • Why is Synchronization Needed ?
            • Synchronized Blocks & Methods
          • Thread Lock
            • Types of Locks
            • Intrinsic Lock (Monitor Lock)
            • Reentrant Lock
          • Semaphore
          • Thread Starvation
          • Thread Contention
          • Thread Deadlock
          • Best Practices for Avoiding Thread Issues
        • Executor Framework
          • ExecutorService
            • Types of Work Queues
            • Rejection Policies
            • ExecutorService Implementations
            • ExecutorService Usage
        • Asynchronous Programming
          • Future
          • CompletableFuture
          • Future v/s CompletableFuture
      • Functional Programming
        • Functional Interfaces
          • Standard Built-In Interfaces
          • Custom Interfaces
        • Streams
          • flatmap
          • Collectors Utility Class
          • Problems
      • Utilities
        • Date Time Formatter
        • Validation
        • Input Handling
        • Comparing & Ordering
          • Object Equality Check
          • Comparable and Comparator
            • Comparator Interface
          • Sorting of Objects
          • Insertion Ordering
      • Specifications & Standards
        • ISO Standards
        • JSR
          • JSR 303, 349, 380 (Bean Validation)
    • Java Packages
      • Core Packages
        • java.lang
          • java.lang.System
          • java.lang.Thread
        • java.net
          • java.net.InetAddress
        • java.nio
          • java.nio.charset
      • Jakarta Packages
        • jakarta.validation
        • javax.validation
      • Third-party Packages
    • Infrastructure & Deployment
      • Java Servers
        • Application Server
        • Web Server
        • Web Server vs Application Server
        • Server vs Container
      • Java Deployment Models
      • Build & Packaging Tools
        • Maven
    • Troubleshooting Java Code
      • Thread Dump
      • Heap Dump
      • Artifact Analysis
    • Code Quality & Analysis
      • Code Smells
        • Types of Code Smells
        • Code Smells to Avoid
      • Anti-Patterns
        • Types of Anti-Patterns
        • Cyclic dependencies
    • Code Style Guidelines
      • Naming Convention
      • Package Structure
      • Formatting
      • Comments and Documentation
      • Imports
      • Exception Handling
      • Class Structure
      • Method Guidelines
      • Lambdas and Streams Style
      • Code Style Tools
    • Java Development Tools
      • IntelliJ IDEA
        • Shortcuts for MAC
      • Apache JMeter
        • Examples
      • Thread Dump Capture
        • jstack
      • Heap Dump Capture
        • jmap
      • Wireshark
        • Search Filters
    • Best Practices
      • Method Chaining
  • Maven
    • Installation
    • Local Repository & Configuration
    • Command-line Options
    • Artifact Coordinates
      • Classifier
    • POM File
    • Build & Lifecycle
    • Dependency Management
      • Dependency
        • Transitive Dependency
        • Optional Dependency
      • Dependency Scope
        • Maven Lifecycle and Dependency Scope
      • Dependency Exclusions & Overrides
      • Bill of Materials (BOM)
      • Dependency Conflict Resolution
      • Dependency Tree & Analysis
      • Dependency Versioning Strategies
        • Artifact and BOM Versioning
    • Plugins
      • Build Lifecycle Management
      • Dependency Management
      • Code Quality and Analysis
      • Documentation Generation
      • Code Generation
      • Packaging and Deployment
      • Reporting
      • Integration and Testing
      • Customization and Enhancement
        • build-helper-maven-plugin
        • properties-maven-plugin
        • ant-run plugin
        • exec-maven-plugin
        • gmavenplus-plugin
      • Performance Optimization
    • FAQs
      • Fixing Maven SSL Issues: Unable to Find Valid Certification Path
  • Miscellaneous
    • Image
    • Mac
      • Mac Shortcuts
      • Running Oracle DB
  • Spring
    • Spring Basics
      • What is Spring ?
      • Why Use Spring
      • Spring Ecosystem
      • Versioning
      • Setting Up a Spring Project
      • Spring vs Spring Boot
    • General Concepts
      • Spring Boot Artifact Packaging
      • Classpath and Resource Loading
      • REGEX
        • Core Classes
      • Validations in Spring Framework
        • Jakarta Validation
          • Jakarta Bean Validation Annotations
    • Core Concepts
      • Spring Core
        • Dependency Injection (DI)
          • @Autowired
          • @Qualifier
          • @Primary
        • Stereotype Annotation
      • Spring Beans
        • How Spring Beans Differ from Java Beans ?
        • Bean Definition & Naming
        • Bean Lifecycle
        • Bean Scope
          • Singleton Bean
          • Use Case
        • Lazy & Eager Initialization
          • Use Case of Lazy Initialization
        • BeanFactory
        • ApplicationContext
      • Spring Profiles
      • Spring Annotations
        • Annotation Inheritance
        • Commonly Used Annotations
          • Spring Boot Specific
          • Controller Layer (Web & REST Controllers)
      • Spring Configuration
        • Custom Package Scanning
        • @Value for Property Injection
        • Mapping Properties to Java Class
    • Spring Features
      • Auto Configuration
        • Spring Boot 2: spring.factories
        • Spring Boot 3: spring.factories
      • Spring Caching
        • In-Memory Caching
      • Spring AOP
        • Before Advice
        • After Returning Advice
        • After Throwing Advice
        • After (finally) Advice
        • Around Advice
        • Use Cases
      • Spring File Handling
        • Reading a File
      • Reactive Programming
        • Reactive System
        • Reactive Stream Specification
        • Project Reactor
          • Mono & Flux
      • Asynchronous Processing
        • @Async annotation
          • Common Issues
        • ThreadPoolExecutor and Queue Management
      • Inter-Service Communication
        • REST Communication
          • 1. RestTemplate
            • Usage
            • Request Customization
            • Handling Responses
            • Exception Handling
            • Asynchronous Execution
            • Configuration
              • Configuring Request Factories
              • Types of Timeouts
            • HTTP Clients with SSL
            • OpenAPI-Generated Clients
              • Use Case: Internal API Calls with OpenAPI Clients
              • Use Case: Internal API Calls with Manual Clients
            • Transition to WebClient
          • 2. WebClient
            • Usage
            • Request Customization
            • Handling Responses
            • Exception Handling
            • Asynchronous Execution
            • Configuration
            • HTTP Clients with SSL
              • Examples
            • OpenAPI-Generated Clients
              • Use Case: Internal API Calls with OpenAPI Clients
              • Use Case: Internal API Calls with Manual Clients
          • 3. OpenFeign
            • Usage
            • Request Customization
            • Handling Responses
            • Exception Handling
            • Asynchronous Execution
            • Configuration
            • HTTP Client with SSL
            • OpenAPI-Generated Clients
              • Use Case: Internal API Calls with OpenAPI Clients
              • Use Case: Internal API Calls with Manual Clients
          • When to Use Which ?
        • Messaging Communication
          • ActiveMQ
            • Architecture Details
            • Version Overview
            • Naming Convention
            • Message Delivery Guarantee
            • Queues and Topics
            • Configuration Properties
            • Concepts
            • ActiveMQ with Spring Boot
            • Common Issues
      • Resilience Patterns
        • Retry Mechanism
          • @Retryable annotation
            • Example
      • Spring Security
        • Authentication
          • Core Components
            • Security Filter Chain
              • HttpSecurity
              • Example
            • AuthenticationManager
            • AuthenticationProvider
            • UserDetailsService
              • UserDetails
              • PasswordEncoder
            • SecurityContext
            • SecurityContextHolder
            • GrantedAuthority
            • Security Configuration (Spring Security DSL)
          • Authentication Models
            • One-Way Authentication
            • Mutual Authentication
          • Authentication Mechanism
            • Basic Authentication
            • Form-Based Authentication
            • Token-Based Authentication (JWT)
            • OAuth2 Authentication
            • Multi-Factor Authentication (MFA)
            • SAML Authentication
            • X.509 Certificate Authentication
            • API Key Authentication
            • Remember-Me Authentication
            • Custom Authentication
          • Logout Handling
        • Authorization
        • Security Filters and Interceptors
        • CSRF
          • Real-World CSRF Attacks & Prevention
        • CORS
        • Session Management and Security
        • Best Practices
      • Spring Persistence
        • JDBC
          • JDBC Components
          • JDBC Template
          • Transaction Management
          • Best Practices in JDBC Usage
          • Datasource
            • Connection Pooling
              • HikariCP
            • Caching
        • JPA (Java Persistence API)
          • JPA Fundamentals
          • ORM Mapping Annotations
            • 1. Entity and Table Mappings
            • 2. Field/Column Mappings
            • 3. Relationship Mappings
            • 4. Inheritance Mappings
            • 5. Additional Configuration Annotations
          • Querying Data
            • JPQL
            • Criteria API
            • JPA Specification
              • Example - Employee Portal
            • Native SQL Queries
            • Named Queries
            • Query Return Types
            • Pagination & Sorting
              • Example - Employee Portal
            • Projection
          • Fetch Strategies in JPA
        • JPA Implementation
          • Hibernate
            • SQL AST
            • Properties
            • CRUD API Using Hibernate
        • Spring Data JPA
          • Repository Abstractions
          • Entity-to-Table Mapping
          • Derived Query Methods
        • Cross-Cutting Concerns
          • Transactions
          • Caching
          • Concurrency
        • Common Issues
          • Dead Lock
        • Liquibase
          • Installation & Setup
          • Change Tracking & Locking
          • Liquibase with Spring Boot
          • Liquibase CLI
          • Use Case
        • Examples
          • Employee Portal
            • API
      • Spring Scheduling
        • Cron Expression
        • Distributed Scheduling
          • ShedLock
      • Thymeleaf Integration
    • Security & Data Protection
      • Encoding | Decoding
        • Base Encoding
          • Base32
            • Encoding and Decoding in Java
        • Text Encoding
          • Extended ASCII
          • ASCII
            • Encoding and Decoding in Java
        • Base Encoding Decoding Examples
        • Text Encoding Decoding Examples
        • Best Practices and Concepts
      • Cryptography
        • Terminology
        • Java Cryptography Architecture (JCA)
        • Key Management
          • Key Generation
            • Tools and Libraries
              • OpenSSL
              • Java Keytool
                • Concept
                • Use Cases
            • Key & Certificate File Formats
          • Key Distribution
          • Key Storage
          • Key Rotation
          • Key Revocation
        • Encryption & Decryption
          • Symmetric Encryption
            • Algorithm
            • Modes of Operation
            • Examples
          • Asymmetric Encryption
            • Algorithm
            • Mode of Operation
            • Examples
        • MAC & HMAC
        • KDF
          • Salt & Nonce
        • Pseudorandom Number Generators (PRNGs)
    • Utilities & Libraries
      • Jackson ObjectMapper
      • Apache Libraries
        • Apache Camel
          • Camel Architecture
            • Camel Context
            • Camel Endpoints
            • Camel Components
            • Camel Exchange & MEP
          • Spring Dependency
          • Different Components
            • Camel SFTP
        • Apache Commons Lang
          • StringUtils
          • ArrayUtils
          • NumberUtils
          • SystemUtils
          • RandomStringUtils
          • DateUtils
          • EqualsBuilder & HashCodeBuilder
          • StopWatch
        • Apache Commons IO
          • FileUtils
        • Apache Commons Validator
      • MapStruct Mapper
      • Lombok
        • Logging with Lombok
      • Utilities by Spring framework
        • StopWatch
      • ArchUnit
    • Deployment & Packaging
      • Inspecting Docker Images
    • Microservices
      • Load Balancing
        • Client-Side Load Balancing Example
        • Server-Side Load Balancing Example
    • Practical Guidelines
      • Spring Coding Conventions
        • Layered Architecture Rules
        • Package & Class Location Rules
        • Dependency Rules
        • Naming Convention Rules
        • Annotation Usage Rules
        • Forbidden API Usage Rules
        • Dependency Cycle Rules
        • Test Layer Rules
        • Documentation & Logging Rules
      • Spring Configuration
      • Spring Code Design
  • Software Testing
    • Testing Fundamentals
      • Software Testing Methodologies
        • Functional Testing
          • Unit Testing
            • Scenario Matrix Template
          • Integration Testing
            • Scenario Matrix Template
          • System Testing
            • Scenario Matrix Template
          • Acceptance Testing
            • Scenario Matrix Template
        • Non Functional Testing
          • Performance Testing
            • Load Testing
              • Terminology
              • Process
              • Strategy
              • Preparation Checklist
              • Metrics to Measure
              • Scenario Matrix Template
            • Stress Testing
              • Scenario Matrix Template
            • Spike Testing
              • Scenario Matrix Template
            • Soak Testing
              • Scenario Matrix Template
            • Scalability Testing
              • Scenario Matrix Template
          • Security Testing
            • Scenario Matrix Template
          • Usability Testing
            • Scenario Matrix Template
          • Reliability Testing
            • Scenario Matrix Template
          • Compatibility Testing
            • Scenario Matrix Template
          • Maintainability Testing
            • Scenario Matrix Template
          • Portability Testing
            • Scenario Matrix Template
          • Recovery Testing
            • Scenario Matrix Template
          • Compliance Testing
            • Scenario Matrix Template
          • Localization Testing
            • Scenario Matrix Template
      • Software Testing Life Cycle (STLC)
    • Levels of Testing
    • Java Test Framework
      • JUnit
        • JUnit 4
        • JUnit 5
          • Parameterized Test
          • Single and Multiple Assertions
        • JUnit 4 vs JUnit 5
      • MockServer
    • Test Automation
      • Manual vs Automated Testing
      • Test Automation Strategies
      • CI/CD Integration
  • System Design
    • Design Foundations
      • Programming Paradigms
      • System Characteristics
      • Object-Oriented Design
        • SOLID Principles
        • GRASP Principles
        • Composition
        • Aggregation
        • Association
      • Design Thinking & Process
        • Problem Framing
        • Use Case Analysis
        • Requirements Gathering
        • Iterative Design Process
      • Workload Types
    • Design Principles & Patterns
      • Software Design Principles
        • DRY
        • KISS
        • YAGNI
        • Separation of Concerns
        • Encapsulation & Abstraction
        • Modularity & Reusability
      • Design Pattern
        • Creational Pattern
        • Structural Pattern
        • Behavioral Pattern
        • Examples
          • Data Collector
          • Payment Processor
          • Transaction Dispute
          • Payment Validation
        • Design Enhancements
          • Fluent API Design
            • Examples
      • Design Metrics
        • Coupling
        • Cohesion
        • Cyclomatic Complexity
        • Lines of Code (LOC)
        • Halstead Metrics
        • Maintainability Index
    • System Design Methodology
      • Design Layers
        • Low-Level Design (LLD)
        • High-Level Design (HLD)
      • Design Diagrams
        • UML Diagrams
          • PlantUML
            • Class Diagram
            • Object Diagram
            • Sequence Diagram
            • Use Case Diagram
            • Activity Diagram
            • State Diagram
            • Architecture Diagram
            • Component Diagram
            • Timing Diagram
            • ER Diagram (Entity-Relationship)
            • Network Diagram
    • Architectural Styles
      • System-Level
        • Monolith
        • Microservices
        • Event Driven Architecture
        • Serverless
      • Application-Level
        • Layered Architecture
        • Hexagonal Architecture
        • Clean Architecture
      • How System-Level and Application-Level Work Together ?
      • Trends in Practice
        • Spring Boot Microservice with Clean Architecture
        • Spring Boot Microservice with Hexagonal Architecture
    • Architecture Principles
      • Twelve-Factor App Principles
      • Cloud-Native Principles
      • Reactive Manifesto
      • Infrastructure as Code (IaC)
      • DevOps Principles
      • Design for Failure
      • CAP Theorem
    • Architectural Building Blocks
      • Load Balancer
        • Load Balancer Architecture
        • Load Balancer Monitoring Tool
      • Caching
        • Pod-Level vs Distributed Caching
    • Scalability & Reliability
      • Scaling
        • Vertical Scaling (Scaling Up)
        • Horizontal Scaling (Scaling Out)
        • Auto-Scaling
        • Database Scaling via Sharding
      • Resilience & Failure Handling
    • Delivery & Deployment Strategy
      • Feature Flags
      • Traffic Shifting
      • Deployment Patterns
    • Observability
      • Distributed Tracing
        • Fundamentals
        • Tracing Modes
    • Data Handling & Processing
      • MapReduce
        • Example
    • Performance Engineering
      • Why Is My API Sometimes Slow ?
      • Networking Metrics
        • Types of Delay
        • Scenario
    • Security
      • Security Principles
        • CIA
        • Least Privilege Principle
        • Defense in Depth
        • Zero Trust Security Model
        • Security by Design
        • Zero Trust Architecture
      • Security Threats & Mitigations
        • OWASP
          • Top 10 Security Threats
          • Application Security Verification Standard
          • Software Assurance Maturity Model
          • Dependency Check
          • CSRFGuard
          • Cheat Sheets
          • Security Testing Guide
          • Threat Dragon
        • Threat Modeling
        • Cyber Attacks
      • Application-Level Security
        • CORS (Cross-Origin Resource Sharing)
      • Secure Software Development Lifecycle
        • Secure Coding Practices
        • DevSecOps
      • Compliance & Regulation
        • GDPR
        • PCI DSS
    • Operational Issues
      • Common Runtime Errors
        • OOM: Unable to Create Native Thread
        • OOM: Requested array size exceeds VM limit
  • Interview Guide
    • Non-Technical
      • Behavioural or Introductory Guide
      • Project Specific
    • Technical
      • Java Interview Companion
        • Java Key Concepts
          • Set 1
          • Set 2
          • Set 3
        • Java Code Snippets
        • Java Practice Programs
          • Set 3 - Strings
          • Set 4 - Search
          • Set 5 - Streams and Collection
      • SQL Interview Companion
        • SQL Practice Problems
          • Set 1
      • Spring Interview Companion
        • Spring Key Concepts
          • Set 1 - General
          • Set 2 - Core Spring
        • Spring Code Snippets
          • JPA
      • Application Server
      • Maven
      • Containerized Application
      • Microservices
    • General
      • Applicant Tracking System (ATS)
      • Flowchart - How to Solve Coding Problem?
Powered by GitBook
On this page
  1. Spring
  2. Spring Features
  3. Spring Persistence
  4. JDBC
  5. Datasource
  6. Connection Pooling

HikariCP

PreviousConnection PoolingNextCaching

Last updated 3 months ago

CtrlK
  • About
  • What is HikariCP ?
  • Key Features
  • Default in Spring Boot
  • Properties
  • Commonly Used HikariCP Properties
  • Other Useful Properties
  • Validation Settings
  • Best Practices for HikariCP in Spring Boot

About

HikariCP is a fast, lightweight, reliable JDBC connection pool library. It is the default connection pool implementation used in Spring Boot (from version 2.x onwards). HikariCP is known for its performance, low overhead, and minimal configuration needs, yet it provides powerful tuning options.

What is HikariCP ?

HikariCP is a JDBC connection pool implementation designed to be extremely fast and simple to use. It manages a pool of active database connections that can be reused, avoiding the cost of establishing a new connection for every request.

Hikari means "light" in Japanese, reflecting the library’s goal to be lightweight and fast.

Key Features

  • Minimal footprint with low latency and high throughput

  • Asynchronous house-keeping

  • Fast connection acquisition

  • Leak detection support

  • Built-in connection health checks

  • JDBC4-compliant

  • Excellent performance under load

Default in Spring Boot

Starting from Spring Boot 2.0, HikariCP is the default DataSource. Spring Boot will automatically configure it when it detects spring.datasource.* properties.

Minimal setup via application.properties:

spring.datasource.url=jdbc:mysql://localhost:3306/test_db
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

Spring Boot will detect HikariCP in the classpath and configure it automatically.

Properties

Commonly Used HikariCP Properties

Property
Description
Best Practice

spring.datasource.hikari.pool-name

Name of the connection pool

Use meaningful names for easier debugging/logging

spring.datasource.hikari.maximum-pool-size

Maximum number of connections in the pool (default: 10)

Set based on DB capacity and concurrent load; typically 10–30

spring.datasource.hikari.minimum-idle

Minimum number of idle connections in the pool

Set equal to maximum-pool-size to avoid pool shrinking

spring.datasource.hikari.idle-timeout

Maximum idle time (ms) for a connection before it's removed

Set lower for low-traffic apps; 30000 (30s) is good

spring.datasource.hikari.connection-timeout

Max time (ms) to wait for a connection from the pool

Keep between 20000–30000; too low may cause exceptions under load

spring.datasource.hikari.max-lifetime

Maximum lifetime (ms) of a connection before it’s recycled

Set slightly less than DB’s timeout (e.g. 1800000 = 30 min)

spring.datasource.hikari.leak-detection-threshold

Logs a warning if a connection is held longer than this (ms)

Use 15000–30000 in dev/test to detect leaks

spring.datasource.hikari.validation-timeout

Timeout (ms) for validating a connection

Default is 5000; reduce if you see slow validation

Other Useful Properties

Property
Description
Best Practice

spring.datasource.hikari.auto-commit

Auto-commit behavior for connections (default: true)

Set to false if you use transactions explicitly

spring.datasource.hikari.read-only

Set connections to read-only if you're not modifying data

Use in read-heavy/reporting apps

spring.datasource.hikari.initialization-fail-timeout

Time (ms) to wait before failing startup if DB is down (default: 1ms)

Set to -1 to disable fail-fast during startup

spring.datasource.hikari.isolate-internal-queries

If true, internal queries run in their own connection state

Keep false unless you suspect conflicts

spring.datasource.hikari.allow-pool-suspension

Allows pool to be suspended and resumed

Rarely used; keep false unless required

spring.datasource.hikari.keepalive-time

Prevents idle connections from being closed if they haven’t timed out

Set if your DB closes idle connections before max-lifetime

spring.datasource.hikari.catalog

Sets the default catalog for connections

Use only if your app needs a specific catalog

spring.datasource.hikari.schema

Sets the default schema

Set when multiple schemas are used in the DB

spring.datasource.hikari.connection-init-sql

SQL executed after a connection is created

Useful for DB-level session parameters (e.g. SET timezone)

Validation Settings

HikariCP doesn't use testOnBorrow, testWhileIdle, etc. like other pools. Instead:

Property
Description
Best Practice

spring.datasource.hikari.connection-test-query

Custom query to test connection validity

HikariCP auto-detects based on driver; override if needed

spring.datasource.hikari.validation-timeout

Timeout (ms) to complete a validation query

Keep 1000–5000ms depending on DB response time

Best Practices for HikariCP in Spring Boot

  1. Set the pool size based on database and application capacity

    • maximum-pool-size should reflect the concurrency your database can handle.

    • Start with 10–30 depending on expected load.

    • Never exceed the database’s allowed max connections.

  2. Match minimum-idle to maximum-pool-size in high-throughput systems

    • Prevents idle connections from being closed and recreated constantly.

    • Helps maintain performance during sudden traffic spikes.

  3. Use max-lifetime below the database’s timeout

    • If your database closes idle connections after 30 minutes, set max-lifetime to 25–28 minutes.

    • Prevents "connection closed" errors due to backend timeout.

  4. Set idle-timeout lower than max-lifetime

    • Prevents unnecessary long-held idle connections.

    • Example: idle-timeout = 30000, max-lifetime = 1800000.

  5. Enable leak-detection-threshold during development

    • Helps identify when connections are not being closed.

    • Example: leak-detection-threshold = 15000 (15 seconds).

  6. Use connection-timeout based on SLA and latency

    • Set it reasonably low to avoid users waiting too long.

    • Default is 30 seconds; values between 10,000–20,000 ms work well in most cases.

  7. Avoid using long-living transactions

    • These hold connections longer and reduce pool availability.

    • Always close EntityManagers, JDBC connections, or Sessions properly.

  8. Set auto-commit wisely

    • Default is true; disable only if you manage transactions explicitly.

    • Mismatched auto-commit settings can cause silent data issues.

  9. Avoid unnecessary validation queries

    • Hikari automatically chooses efficient methods (e.g., JDBC’s isValid()).

    • Only use connection-test-query if absolutely necessary.

  10. Monitor pool behavior using Spring Boot Actuator

    • Enable management.endpoints.web.exposure.include=* and inspect metrics like:

      • hikaricp.connections.active

      • hikaricp.connections.idle

      • hikaricp.connections.pending

      • hikaricp.connections.usage

  11. Avoid frequent restart of the application or forcing pool shutdown

    • Closing pools too often (especially in microservices) leads to socket issues or DB throttling.

    • Let the pool recycle connections naturally.

  12. Consider using a separate pool or datasource for batch/long-running jobs

    • This avoids blocking web requests while a few threads hold connections for long-running tasks.

  13. Use the latest HikariCP and JDBC drivers

    • Keeps your app secure, stable, and compatible with database enhancements.

  14. Avoid having too many pools in a microservice environment

    • One well-tuned pool per service is ideal.

    • Multiple small pools can starve the DB if misconfigured.

  15. Use profiling tools like VisualVM, JConsole, or Spring Boot Micrometer

    • Helps understand real-time pool usage, bottlenecks, and leak points.