Developer synopsis

Purpose: The spring-context dependency provides core components of the Spring Framework, enabling dependency injection, application context management, and other foundational features like event propagation and resource loading.

Usage: Commonly included in Spring applications to manage beans, facilitate dependency injection, and create and configure the ApplicationContext, which serves as the central container for Spring beans and configurations.

Purpose: The spring-web module provides foundational web functionalities within the Spring Framework, enabling the development of RESTful APIs and web applications through essential components like servlets, filters, and REST controllers.

Usage: Commonly used in Spring MVC applications to handle HTTP requests, create REST endpoints with @RestController and @RequestMapping, and support JSON/XML responses, forming the basis for web and API layers in Spring-based projects.

Purpose: The spring-webmvc module is the core component for building web applications with Spring MVC, providing a comprehensive framework for implementing the Model-View-Controller (MVC) design pattern in Java applications.

Usage: Commonly used to create web applications and RESTful APIs by defining controllers, mapping requests with annotations like @Controller and @RequestMapping, and managing views, making it essential for handling and routing HTTP requests and responses in Spring MVC applications.

Purpose: spring-data-jpa is a Spring module that simplifies data access in JPA-based applications by providing repository support, reducing the need for boilerplate code and enhancing interaction with relational databases.

Usage: Commonly used to interact with databases through the JpaRepository interface, which provides CRUD operations, pagination, and query methods, making database access straightforward and allowing developers to focus on business logic rather than data handling.

Purpose: MySQL is an open-source relational database used to store, manage and retrieve structured data efficiently for applications. It’s suitable for both small-scale projects and large, data-intensive systems.

Usage: MySQL uses SQL (Structured Query Language) to interact with databases, supporting CRUD operations (Create, Read, Update, Delete) and advanced features like transactions, indexing and joins for complex data relationships.

Purpose: The servlet-api provides the core classes and interfaces for handling HTTP requests and responses in Java web applications, forming the foundation for Java Servlets, which are essential for creating dynamic web content.

Usage: Used in web applications to define servlets, filters, and listeners, which manage and process HTTP requests and responses, typically serving as a base for frameworks like Spring MVC to build on for handling web interactions.

Purpose: JSTL (JavaServer Pages Standard Tag Library) provides a set of standard tags for JSP (JavaServer Pages) to simplify common tasks like iteration, conditional processing, internationalization, and formatting within web pages.

Usage: Commonly used in JSP pages to streamline dynamic content creation by reducing the amount of Java code, making it easier to work with loops, conditionals, and data formatting directly in HTML templates, improving readability and maintainability.

Purpose: The jsp-api provides the core classes and interfaces necessary for JavaServer Pages (JSP) technology, enabling dynamic content creation in Java web applications.

Usage: Used in web applications to support JSP files, allowing developers to embed Java code within HTML for generating dynamic web content, handling form submissions, and displaying data from backend services in a web-friendly format.

Purpose: JUnit is a widely used testing framework for Java, designed to facilitate the creation and execution of unit tests, allowing developers to test individual components of their applications for correctness.

Usage: Used in Java applications to write repeatable tests for methods and classes, typically annotated with @Test, enabling automated testing to verify code behavior, detect bugs early, and ensure code reliability throughout development.

Purpose: Logging framework for generating log messages.

Usage: Logging information, warnings, errors, etc. during application execution.

Purpose: Springfox Swagger UI is a library that integrates with Spring applications to automatically generate interactive API documentation using the Swagger/OpenAPI specification, providing a user-friendly interface for exploring and testing RESTful APIs.

Usage: Commonly used to annotate controller methods in a Spring application, allowing developers to easily visualize and interact with the API endpoints through a web-based interface, which enhances API usability and improves the developer experience.

Purpose: Springfox Swagger 2 is a library that integrates Swagger support into Spring applications, automatically generating API documentation in the Swagger format, making it easy to document and test RESTful endpoints.

Usage: Used in Spring applications to generate interactive API documentation by annotating controllers and models. This documentation is accessible through the Swagger UI, allowing developers and clients to visualize, test, and understand API endpoints.

Purpose: Apache POI is a Java library that enables reading, writing, and manipulating Microsoft Office file formats, such as Excel (XLSX, XLS), Word (DOCX, DOC), and PowerPoint (PPTX, PPT).

Usage: Commonly used for generating reports, automating document handling, reading or writing spreadsheet data, and creating or modifying Word documents and presentations programmatically in Java applications.

Purpose: Keikai JSP is an integration library that allows the Keikai spreadsheet to be embedded in JavaServer Pages (JSP) applications, enabling interactive, Excel-like spreadsheet functionality within web applications.

Usage: Used in JSP-based web applications to display and edit spreadsheet data in a browser, allowing users to interact with spreadsheet cells, formulas, and data directly in the web interface, ideal for applications requiring complex data entry or calculations.

Purpose: Keikai JSF is a library that integrates the Keikai spreadsheet into JavaServer Faces (JSF) applications, enabling developers to embed Excel-like spreadsheet functionalities within JSF web applications.

Usage: Used in JSF applications to provide users with an interactive spreadsheet experience, allowing them to manipulate data, perform calculations, and utilize rich spreadsheet features directly in the browser, which is beneficial for applications that require extensive data management capabilities.

Purpose: Keikai EX is a library designed to extend the capabilities of the Keikai spreadsheet component, providing advanced features for embedding and manipulating spreadsheets within Java applications.

Usage: Used in Java applications to offer enhanced spreadsheet functionalities, such as importing and exporting data in various formats (like Excel), advanced data visualization, and improved performance, making it suitable for applications that require sophisticated spreadsheet handling and integration.

Purpose: Spark Core is the foundational module of Apache Spark, providing essential functionalities for distributed data processing, including task scheduling, memory management, and fault tolerance.

Usage: Commonly used to build data processing applications and pipelines that can efficiently handle large-scale data across clusters, supporting operations like transformations and actions on distributed datasets with high performance and ease of use.

Purpose: The gson dependency provides support for JSON serialization and deserialization in Java applications. It allows you to convert Java objects to JSON format and vice versa, making it easy to work with JSON data in your Java applications.

Usage: Include the gson dependency in your project to use Gson’s functionality for handling JSON data. You can use Gson’s APIs to parse JSON strings into Java objects, serialize Java objects to JSON strings and perform various operations on JSON data. This library is commonly used in Java projects to interact with RESTful APIs, process JSON data from web services and more.

Purpose: Hibernate EntityManager bridges the gap between JPA and Hibernate, allowing developers to use the standard JPA EntityManager API while leveraging Hibernate’s powerful ORM features. It manages the lifecycle of persistent entities and allows data manipulation through object-oriented principles rather than direct SQL.

Usage: Provides methods to manage entities, enables transaction management and supports both JPQL (Java Persistence Query Language) and native SQL queries, allowing complex data retrieval through createQuery() and createNativeQuery().

Purpose: Apache Commons Codec provides simple encoding and decoding utilities for data formats like Base64, Hex, and cryptographic hashes in Java.

Usage: Commonly used for Base64 and Hex encoding/decoding of binary data and hashing with algorithms like MD5 or SHA-256 for security and data integrity.

Purpose: C3P0 is a Java library providing database connection pooling, which optimizes resource management by reusing database connections rather than opening a new connection for each database request.

Usage: Integrated with Hibernate or JDBC configurations to manage database connections more efficiently, improving performance and scalability in applications by reducing the overhead of frequent connection creation and closing.

Purpose: CGLIB (Code Generation Library) is a Java library used to generate dynamic proxy classes at runtime, primarily for method interception and class enhancement.

Usage: Often used in frameworks like Spring for creating proxies of classes without interfaces (through subclassing), enabling features like lazy loading, AOP (Aspect-Oriented Programming), and method caching by intercepting method calls dynamically.

Purpose: Apache Commons Collections is a library that extends Java’s native collections framework, providing additional collection types, utilities, and algorithms to simplify data handling and manipulation.

Usage: Commonly used for advanced collection types (e.g., Bag, BidiMap, MultiMap), decorators, and utility methods that facilitate tasks like filtering, transformation, and ordering of collection elements in Java applications.

Purpose: Apache Commons Logging provides a lightweight, standardized logging interface that acts as a bridge between different logging frameworks (like Log4j, Logback, and java.util.logging), allowing for flexible logging in Java applications.

Usage: Commonly used to enable logging without committing to a specific logging framework, making it easy to switch between logging implementations by configuring the underlying logging framework (e.g., Log4j or SLF4J) without changing application code.

Purpose: DOM4J is a Java library used for working with XML, providing an easy-to-use and flexible API for parsing, creating, modifying, and navigating XML documents.

Usage: Often used to handle XML data in Java applications where complex XML document processing is required, supporting XPath, XSLT, and integration with SAX and DOM parsers for versatile XML manipulation.

Purpose: Hibernate Core is the primary module of Hibernate, a popular Java-based ORM (Object-Relational Mapping) framework, allowing seamless mapping between Java objects and database tables.

Usage: Used to manage database interactions by mapping Java classes to database tables and handling CRUD operations, relationships, caching, and lazy loading, making data persistence in Java applications more intuitive and reducing the need for extensive SQL code.

Purpose: ModelMapper is a Java library designed to simplify the process of mapping between objects, particularly for converting data transfer objects (DTOs) to entity objects and vice versa.

Usage: Commonly used in applications to reduce boilerplate code associated with manual object mapping, allowing for straightforward configuration and automatic handling of nested properties and collections, improving code maintainability and readability.

Purpose: Jackson Databind is a component of the Jackson library that provides functionality for converting Java objects to JSON and vice versa, enabling easy serialization and deserialization of data.

Usage: Commonly used in Java applications to facilitate JSON processing, especially in RESTful web services, allowing seamless conversion of Java objects to JSON responses and parsing JSON requests into Java objects.

Purpose: The lombok dependency simplifies Java development by providing annotations that automatically generate boilerplate code, such as getters, setters, constructors, and toString methods.

Usage: Use to annotate Java classes with lombok annotations to reduce the amount of boilerplate code they need to write, resulting in cleaner and more maintainable codebases.

ACTUS provide open, royalty-free standards for the combined data and algorithmic representation of financial contracts in order to promote efforts for transparent interoperability of financial contract information as well as support the use of the ACTUS standards and open source software in developing a broad range of applications and systems that utilize the forward-looking cash flow analysis that ACTUS enables and which can provide major benefits for both private and public sectors of the financial industry.

Example

Common levels include DEBUG, INFO, WARN, ERROR and FATAL. Each level indicates the importance or severity of a message.

For example, INFO level logging is used with logger.info("enter into counterparty create"); to track entry into the method. INFO is typically used for general messages that confirm the application is functioning as expected.

Configuring loggers by module or functionality allows for finer control over what is logged and at what level, which can be customized in an external configuration file (e.g., log4j.properties or application.properties).

Spring applications often use SLF4J (Simple Logging Facade for Java) with Logback or Log4j as the underlying logging implementations.

Using SLF4J with Logback or Log4j is generally preferred as they offer flexible configuration, log file rotation and asynchronous logging capabilities.

Avoid Logging sensitive data

Structured logs

Log contextual information

Error Logging