org.apache.flink.runtime.rest.handler.RestHandlerConfiguration Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.11 Show documentation
There is a newer version: 1.13.6
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.flink.runtime.rest.handler;

import org.apache.flink.api.common.time.Time;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.configuration.WebOptions;
import org.apache.flink.util.Preconditions;

import java.io.File;

/**
 * Configuration object containing values for the rest handler configuration.
 */
public class RestHandlerConfiguration {

	private final long refreshInterval;

	private final int maxCheckpointStatisticCacheEntries;

	private final Time timeout;

	private final File webUiDir;

	private final boolean webSubmitEnabled;

	public RestHandlerConfiguration(
			long refreshInterval,
			int maxCheckpointStatisticCacheEntries,
			Time timeout,
			File webUiDir,
			boolean webSubmitEnabled) {
		Preconditions.checkArgument(refreshInterval > 0L, "The refresh interval (ms) should be larger than 0.");
		this.refreshInterval = refreshInterval;

		this.maxCheckpointStatisticCacheEntries = maxCheckpointStatisticCacheEntries;

		this.timeout = Preconditions.checkNotNull(timeout);
		this.webUiDir = Preconditions.checkNotNull(webUiDir);
		this.webSubmitEnabled = webSubmitEnabled;
	}

	public long getRefreshInterval() {
		return refreshInterval;
	}

	public int getMaxCheckpointStatisticCacheEntries() {
		return maxCheckpointStatisticCacheEntries;
	}

	public Time getTimeout() {
		return timeout;
	}

	public File getWebUiDir() {
		return webUiDir;
	}

	public boolean isWebSubmitEnabled() {
		return webSubmitEnabled;
	}

	public static RestHandlerConfiguration fromConfiguration(Configuration configuration) {
		final long refreshInterval = configuration.getLong(WebOptions.REFRESH_INTERVAL);

		final int maxCheckpointStatisticCacheEntries = configuration.getInteger(WebOptions.CHECKPOINTS_HISTORY_SIZE);

		final Time timeout = Time.milliseconds(configuration.getLong(WebOptions.TIMEOUT));

		final String rootDir = "flink-web-ui";
		final File webUiDir = new File(configuration.getString(WebOptions.TMP_DIR), rootDir);

		final boolean webSubmitEnabled = configuration.getBoolean(WebOptions.SUBMIT_ENABLE);

		return new RestHandlerConfiguration(
			refreshInterval,
			maxCheckpointStatisticCacheEntries,
			timeout,
			webUiDir,
			webSubmitEnabled);
	}
}