org.hertsstack.http.HertsHttpEngineBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of herts-http Show documentation

Herts real time framework for Http

There is a newer version: 1.1.4

package org.hertsstack.http;

import org.hertsstack.core.context.HertsMetricsSetting;
import org.hertsstack.core.service.HertsService;

import javax.annotation.Nullable;
import java.util.List;
import java.util.Map;

/**
 * Herts http server engine builder
 *
 * @author Herts Contributer
 */
public interface HertsHttpEngineBuilder {

    /**
     * Add implementation service
     * Not interface
     *
     * @param hertsRpcService HertsCoreService
     * @param interceptor Interceptor
     * @return HertHttpEngineBuilder
     */
    HertsHttpEngineBuilder registerHertsHttpService(HertsService hertsRpcService, @Nullable HertsHttpInterceptor interceptor);

    /**
     * Add implementation service
     * Not interface
     *
     * @param hertsRpcService HertsCoreService
     * @return HertHttpEngineBuilder
     */
    HertsHttpEngineBuilder registerHertsHttpService(HertsService hertsRpcService);


    /**
     * Set port
     *
     * @param port Port
     * @return HertHttpEngineBuilder
     */
    HertsHttpEngineBuilder setPort(int port);

    /**
     * Set ssl for Jetty.
     *
     * @param sslContextFactory SslContextFactory
     * @param port              Port
     * @return HertHttpEngineBuilder
     */
    HertsHttpEngineBuilder setSsl(org.eclipse.jetty.util.ssl.SslContextFactory sslContextFactory, int port);

    /**
     * Set metrics setting information
     *
     * @param metricsSetting HertsHttpMetricsSetting
     * @return HertHttpEngineBuilder
     */
    HertsHttpEngineBuilder setMetricsSetting(HertsMetricsSetting metricsSetting);

    /**
     * Get registered HertsRpcService
     *
     * @return HertsRpcService of List
     */
    List getHertsRpcServices();

    /**
     * Get interceptor
     *
     * @return HertsHttpInterceptor
     */
    Map getInterceptors();

    /**
     * Get Metrics setting
     *
     * @return HertsMetricsSetting
     */
    HertsMetricsSetting getMetricsSetting();

    /**
     * Get ssl context
     *
     * @return SslContextFactory
     */
    org.eclipse.jetty.util.ssl.SslContextFactory getSslContextFactory();

    /**
     * Get port number
     *
     * @return integer port
     */
    int getPort();

    /**
     * Build
     *
     * @return HertsHttpEngine
     */
    HertsHttpEngine build();
}