io.rxmicro.rest.server.HttpServerConfig Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2020. https://rxmicro.io
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.rxmicro.rest.server;

import io.rxmicro.common.meta.BuilderMethod;
import io.rxmicro.http.HttpConfig;
import io.rxmicro.http.ProtocolSchema;

import static io.rxmicro.http.ProtocolSchema.HTTP;

/**
 * Allows configuring HTTP server options.
 *
 * @author nedis
 * @since 0.1
 */
@SuppressWarnings("UnusedReturnValue")
public class HttpServerConfig extends HttpConfig {

    /**
     * Default HTTP port.
     */
    public static final int DEFAULT_HTTP_PORT = 8080;

    private boolean startTimeTrackerEnabled = true;

    /**
     * Creates a HTTP server config instance with default settings.
     */
    public HttpServerConfig() {
        setSchema(HTTP);
        setHost("0.0.0.0");
        setPort(DEFAULT_HTTP_PORT);
    }

    /**
     * Returns {@code true} if start time tracking is enabled.
     *
     * @return {@code true} if start time tracking is enabled
     */
    public boolean isStartTimeTrackerEnabled() {
        return startTimeTrackerEnabled;
    }

    /**
     * Allows enabling/disabling a start time tracking.
     *
     * 
     * If enable, the RxMicro framework displays a time which HTTP server spent during start.
     *
     * @param startTimeTrackerEnabled enabling/disabling flag
     * @return the reference to this {@link HttpServerConfig} instance
     */
    @BuilderMethod
    public HttpServerConfig setStartTimeTrackerEnabled(final boolean startTimeTrackerEnabled) {
        this.startTimeTrackerEnabled = startTimeTrackerEnabled;
        return this;
    }

    @Override
    public HttpServerConfig setSchema(final ProtocolSchema schema) {
        return (HttpServerConfig) super.setSchema(schema);
    }

    @Override
    public HttpServerConfig setHost(final String host) {
        return (HttpServerConfig) super.setHost(host);
    }

    @Override
    public HttpServerConfig setPort(final int port) {
        return (HttpServerConfig) super.setPort(port);
    }

    @Override
    public HttpServerConfig setConnectionString(final String connectionString) {
        return (HttpServerConfig) super.setConnectionString(connectionString);
    }
}