io.github.sinri.drydock.common.CommonUnit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of DryDock Show documentation

Prototype Library for Keel Based Java Projects.

There is a newer version: 1.5.7

package io.github.sinri.drydock.common;

import io.github.sinri.keel.logger.event.KeelEventLog;
import io.github.sinri.keel.logger.event.KeelEventLogger;
import io.github.sinri.keel.logger.issue.center.KeelIssueRecordCenter;
import io.github.sinri.keel.logger.issue.record.KeelIssueRecord;
import io.github.sinri.keel.logger.issue.recorder.KeelIssueRecorder;
import io.github.sinri.keel.logger.metric.KeelMetricRecorder;
import io.vertx.core.Handler;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.function.Supplier;

public interface CommonUnit {
    KeelEventLogger getLogger();

    /**
     * @since 1.3.4
     */
    KeelIssueRecordCenter getIssueRecordCenter();

    /**
     * @since 1.3.4
     */
    default > KeelIssueRecorder generateIssueRecorder(@Nonnull String topic, @Nonnull Supplier issueRecordBuilder) {
        return getIssueRecordCenter().generateIssueRecorder(topic, issueRecordBuilder);
    }

    default KeelEventLogger generateEventLogger(@Nonnull String topic) {
        return getIssueRecordCenter().generateEventLogger(topic);
    }

    /**
     * @since 1.4.6
     */
    default KeelEventLogger generateEventLogger(@Nonnull String topic, @Nullable Handler templateEventLogEditor) {
        return getIssueRecordCenter().generateEventLogger(topic, templateEventLogEditor);
    }

    /**
     * @return The instance of KeelMetricRecorder, already started.
     * @since 1.4.2
     */
    @Nonnull
    default KeelMetricRecorder getMetricRecorder() {
        throw new RuntimeException("By default, Metric Recorder is not provided.");
    }
}