framework.adoc

Colesico Framework Documentation - {version}

Table of Contents

• 1. What is Colesico Framework?
• 2. Getting started
• 3. Framework modules
  • 3.1. Core modules
  • 3.2. Service modules
  • 3.3. Database interaction modules
  • 3.4. Web modules

1. What is Colesico Framework?

Colesico Framework is a lightweight microframework for creating backend and server side web applications in Java. It is inspired by Spring and EJB frameworks but uses more simplified approach to construct the applications.

The purpose of this framework is to provide simpler and lightweight alternative.

Colesico Framework does not almost use the reflection at runtime. The approach used is the generation of extra auxiliary code at compile time using the annotation processors.

Colesico framework is also an analog of such frameworks as Quarkus and Micronaut but is lighter and faster.

2. Getting started

The best way to start learning something is to study by examples :)

• Hello world example

• RESTful service example

See other examples in the source code

3. Framework modules

Colesico-framework consists of highly specialized micromodules.

3.1. Core modules

• Colesico-ioc - Lightweight dependency injection container

• Colesico-config - Configuration assistant

• Colesico-teleapi - Unified API for remote services invocation

• Colesico-service - Business logic beans automation

3.2. Service modules

• Colesico-transaction - Unified transaction control for services

• Colesico-security - Security service

• Colesico-profile - localization profile assistant service

• Colesico-translation - Simple text translation support for services

• Colesico-resource - Provides an ability of resource rewriting and localization

• Colesico-validation - DSL style extendable data validator

• Colesico-eventbus - Simple even bus for services

• Colesico-asynctask - Async tasks background execution (task queue, schedule)

• Colesico-slf4j - Slf4j integration

• Colesico-HOCON - HOCON configs integration

• Colesico-RPC - Lightweight RPC (remote procedure call) for services

3.3. Database interaction modules

• Colesico-jdbc - Jdbc integration (transactions support, etc.)

• Colesico-hikaricp - HikariCP integration (database connection pool)

• Colesico-jdbi - Jdbi integration (transactions support, etc.)

• Colesico-jdbirec - Jdbi data mapping/binding assistant

3.4. Web modules

• Colesico-http - Unified HTTP API

• Colesico-router - HTTP requests dispatcher

• Colesico-telehttp - Unified TeleAPI for HTTP interaction

• Colesico-httpserver - HTTP server unified API

• Colesico-weblet - HTTP requests handling support (servlets analogue)

• Colesico-webstatic - Static files (*.js, *.css etc) sharing helper

• Colesico-restlet - Simplified RESTful Web services support

• Colesico-pebble - Pebble templating engine integration

• Colesico-undertow - Undertow web server integration