ICL Library

This library can help you to write less code and speedup the development of your next great application. It is particularly designed to accomplish most of the common tasks required by backend services.

Goal

Provide the best implementation or wrap the best libraries to make it easier to accomplish most common development tasks (like web applications, database connections, security, etc).

What is in it?

With this library you can:

• Simplify your code by using GroovyExtend library (already included)
• Use configuration files easily, log and rotate logs, start your application in a more elegant way and more (core module and log module)
• Set up back-end web services (HTTP or WebSockets, using Spark-Java Web Framework) (web module)
• Create specialized threads, analyze them and manage them easily (thread module)
• Manage databases using only Java objects or interact with them using a simple fluid SQL query builder (using JDBC) (db module)
• Send emails with attachments through SMTP, create FTP, UDP or TCP servers and clients (net module)
• Encrypt data or hash passwords easily and safely (using BountyCastle library) (crypt module)
• Create a terminal application in which you can interact using commands (using JLine) (term module)
• Communicate through a serial port (JSSC wrapper) (serial module)
• Use cache, monitor your hardware or automate configuration changes (using Jedis or BerkeleyDB) (etc module)

NOTE : This library was designed using Groovy, but it can be used in Java and Kotlin (however, all the examples in the documentation are in Groovy).

Usage

How to use it in your project:

Maven:

<dependency>
  <groupId>com.intellisrc</groupId>
  <artifactId>MODULE</artifactId>
  <version>VERSION</version>
</dependency>

Gradle:

dependencies {
    implementation 'com.intellisrc:MODULE:VERSION'
    // or extended annotation:
    implementation group: 'com.intellisrc', name: 'MODULE', version: 'VERSION'
}

Follow the instructions on the last published version for each module in maven repository

In which VERSION is for example: 2.8.x, and MODULE any of these:

• core
• crypt
• db
• etc
• img
• log
• net
• serial
• term
• thread
• web

You can find some examples for each module here: https://gitlab.com/intellisrc/common_examples/

Modules

For more detailed explanation, click on the module title.

Notes:

• classes marked with ★ are the most commonly used classes for that module.
• classes marked with @, are unlikely to be used directly, but may be of your interest.

core

Basic functionality that is usually needed in any project. For example, configuration, logging, executing commands, controlling services and displaying colors in the console. read more...

Documentation / JavaDoc

log

Includes : core

SLF4J colorful logger with many options and easy to use. You can add customized loggers and personalize the way your logs look. Generally you will use this module through core.Log class. read more...

Documentation / JavaDoc

etc

Includes : core

Extra functionality which is usually very useful in any project. For example, monitoring Hardware, compressing or decompressing data, store data in memory cache, manage system configuration in a multithreading safe environment (using Redis or BerkeyleyDB), simple operations with bytes, etc. read more...

Documentation / JavaDoc

db

Includes : core, etc

Manage SQL databases, such as MySQL, SQLite, Postgresql. (for no-sql databases, see etc module) Create, store and perform CRUD operations to data without having to use SQL (a light-weight implementation as an alternative to Hibernate). read more...

NOTE : You may need to include your database driver as dependency in order to use this module.

Documentation / JavaDoc

net

Includes : core, etc, crypt

Classes related to networking. For example, sending emails through SMTP, connecting or creating TCP/UDP servers, getting network interfaces and perform netmask calculations, etc. read more...

Documentation / JavaDoc

serial

Includes : core, etc

Manage serial communication easily. It uses the JSSC library in the background. read more...

Documentation / JavaDoc

web

Includes : core, etc, net

Create restful HTTP (GET, POST, PUT, DELETE, etc) or WebSocket application services. Manage JSON data from and to the server easily. It is build on top of Spark-Java Web Framework, so it is very flexible and powerful, but designed to be elegant and easier to use. read more...

Documentation / JavaDoc

crypt

Includes : core, etc

Offers methods to encode, decode, hash and encrypt information. It is built using the amazing BouncyCastle library by simplifying its usage without reducing its safety. read more...

Documentation / JavaDoc

thread

Includes : core

Manage Tasks (Threads) with priority and watch its performance. You can create parallel processes easily, processes which are executed in an interval, as a service or after a specified amount of time. This module is very useful to help you to identify bottlenecks and to manage your main threads in a single place. read more...

Documentation / JavaDoc

term

Includes : core

Anything related to terminal is in this module (except AnsiColor, which is in core). It uses JLine to help you create interactive terminal (console) applications easily. It also contains some tools to display progress with colors. read more...

Documentation / JavaDoc

img

Includes : core

Classes for using Images (BufferedImage, File, FrameShot) and non-opencv related code, trying to keep dependencies to a minimum. It also includes common geometric operations. read more...

Documentation / JavaDoc

Dependencies

Starting from 2.8, this library no longer includes some dependencies, so you need to add them separately as you need. This was done to make this library more flexible by allowing you to choose your library versions, reduce the compilation time and your project jar size.

Below each module, I'm including the recommended version (the one used during compilation).

• core : Groovy version is now up to you (required by any module).
  • org.codehaus.groovy:groovy-all:3.0.12
• db : Database drivers need to be included (Choose the one(s) which match(es) your database(s)):
  • com.microsoft.sqlserver:mssql-jdbc:10.2.1.jre11
  • com.oracle.database.jdbc:ojdbc11:21.7.0.0
  • mysql:mysql-connector-java:8.0.30
  • org.apache.derby:derby:10.15.2.0
  • org.firebirdsql.jdbc:jaybird:4.0.7.java11
  • org.mariadb.jdbc:mariadb-java-client:3.0.6
  • org.postgresql:postgresql:42.5.0
  • org.xerial:sqlite-jdbc:3.39.4.1
• etc :
  • Jedis (redis.clients:jedis:4.3.1)
  • BerkeleyDB (com.sleepycat:je:18.3.12)

The following modules are already included in the specified modules:

• crypt
  • Bounty Castle (org.bouncycastle:bcprov-jdk15on:1.70, org.bouncycastle:bcpg-jdk15on:1.70, org.bouncycastle:bcprov-ext-jdk15on:1.70)
• net
  • Apache Common Net (commons-net:commons-net:3.8.0)
  • JavaX Mail(com.sun.mail:javax.mail:1.6.2)
• serial
  • JSSC library (org.scream3r:jssc:2.8.0)
• term
  • JLine library (org.jline:jline:3.21.0)
• web
  • Spark Framework (com.intellisrc:spark-core:2.9.4-unofficial-4)

Recommendations

If you need a library to build your web-based user interfaces (using javascript), check M2D2

Acknowledgments

Developed with IntelliJ Ultimate Edition. I would like to thank JetBrains for their support.