Component Catalog

Name	Type	Description	Default
port	int	Listen port	80
host	String	Host address	0.0.0.0
ssl	boolean	Enable SSL/TLS	false
sslPort	int	SSL listen port	443
keystorePath	String	Path to keystore file	-
keystorePassword	String	Password for keystore	-

Name	Type	Description	Default
port	int	Listen port	80
host	String	Host address	0.0.0.0
ssl	boolean	Enable SSL/TLS	false
sslPort	int	SSL listen port	443
keystorePath	String	Path to keystore file	-
keystorePassword	String	Password for keystore	-
virtualThreads	boolean	Use virtual threads for request handling	true

HikariCP

HikariCP component provides a high-performance JDBC connection pool.

Usage

<dependency>
  <groupId>net.unit8.enkan</groupId>
  <artifactId>enkan-component-HikariCP</artifactId>
</dependency>

Properties

Properties are passed via OptionMap in the constructor.

Name	Key in OptionMap	Description
jdbcUrl	uri	JDBC connection URL
username	username	Database username
password	password	Database password
autoCommit	autoCommit?	Enable auto-commit
connectionTimeout	connTimeout	Connection timeout in ms
idleTimeout	idleTimeout	Idle timeout in ms
maxPoolSize	maxPoolSize	Maximum pool size
minimumIdle	minIdle	Minimum idle connections

Name	Type	Description	Default
dialect	Dialect	SQL dialect	StandardDialect
naming	Naming	Naming convention	Naming.DEFAULT
useLocalTransaction	boolean	Enable local transactions	true
maxRows	int	Maximum result rows	0
fetchSize	int	Fetch size for queries	0
queryTimeout	int	Query timeout in seconds	0
batchSize	int	Batch size for operations	0

Name	Type	Description	Default
dialect	SQLDialect	SQL dialect	DEFAULT

JPA

JPA component provides a base for JPA entity manager integration.

Usage

<dependency>
  <groupId>net.unit8.enkan</groupId>
  <artifactId>enkan-component-jpa</artifactId>
</dependency>

Properties

Name	Type	Description
name	String	JPA persistence unit name
jpaProperties	Map	JPA configuration properties

Name	Type	Description	Default
sqlLogLevel	String	Logging level for SQL	FINE
managedClasses	List	Entity classes (via registerClass)	[]

Name	Type	Description	Default
locations	String[]	Migration script locations	-
table	String	Migration metadata table name	schema_version
cleanBeforeMigration	boolean	Clean database before migration	false

Freemarker

Freemarker component provides a template engine for rendering HTML.

Usage

<dependency>
  <groupId>net.unit8.enkan</groupId>
  <artifactId>enkan-component-freemarker</artifactId>
</dependency>

Properties

Name	Type	Description	Default
prefix	String	Template directory prefix	templates
suffix	String	Template file suffix	.ftl
encoding	String	File encoding	UTF-8

Thymeleaf

Thymeleaf component provides a template engine for rendering HTML.

Usage

<dependency>
  <groupId>net.unit8.enkan</groupId>
  <artifactId>enkan-component-thymeleaf</artifactId>
</dependency>

Properties

Name	Type	Description	Default
prefix	String	Template directory prefix	templates/
suffix	String	Template file suffix	.html
encoding	String	File encoding	UTF-8

Jackson

Jackson component provides a bean converter using Jackson ObjectMapper.

Usage

<dependency>
  <groupId>net.unit8.enkan</groupId>
  <artifactId>enkan-component-jackson</artifactId>
</dependency>

Micrometer

Micrometer component provides application metrics via the Micrometer facade.
Supports Prometheus, Datadog, CloudWatch, and other backends via pluggable MeterRegistry.

Usage

<dependency>
  <groupId>net.unit8.enkan</groupId>
  <artifactId>enkan-component-micrometer</artifactId>
</dependency>

// Default (SimpleMeterRegistry — suitable for development and REPL inspection)
MicrometerComponent micrometer = new MicrometerComponent();

// With Prometheus registry for production
MicrometerComponent micrometer = new MicrometerComponent(new PrometheusMeterRegistry(...));

Properties

Name	Type	Description	Default
metricPrefix	String	Prefix for all meter names	`enkan`

Tracked Metrics

{prefix}.http.server.requests — request duration (Timer)
{prefix}.http.server.errors — error count (Counter)
{prefix}.http.server.active.requests — in-flight request count (Gauge)

Dependencies

None (standalone component; inject into MicrometerMiddleware via the system)

Metrics (Deprecated)

Deprecated: Use enkan-component-micrometer instead. This module will be removed in a future major release.

Metrics component provides the feature of collecting application metrics using Dropwizard Metrics.

Usage

<dependency>
  <groupId>net.unit8.enkan</groupId>
  <artifactId>enkan-component-metrics</artifactId>
</dependency>

Properties

Name	Type	Description	Default
metricName	String	Base metric name prefix	enkan

OpenTelemetry component wraps an OpenTelemetry instance and exposes a Tracer for use by TracingMiddleware.
Defaults to OpenTelemetry.noop() — no spans are emitted unless an SDK is configured at runtime
(e.g. via the OpenTelemetry Java Agent or an explicit SDK setup).

Usage

<dependency>
  <groupId>net.unit8.enkan</groupId>
  <artifactId>enkan-component-opentelemetry</artifactId>
</dependency>

// No-op (default) — suitable for development
OpenTelemetryComponent otel = new OpenTelemetryComponent();

// With a configured SDK instance
OpenTelemetryComponent otel = new OpenTelemetryComponent(GlobalOpenTelemetry.get());

Properties

Name	Type	Description	Default
openTelemetry	OpenTelemetry	OpenTelemetry instance	`OpenTelemetry.noop()`
instrumentationName	String	Tracer / instrumentation scope name	`"enkan"`