de.codecentric.boot.admin.server.domain.values.StatusInfo Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014-2018 the original author or authors.
 *
 * 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 de.codecentric.boot.admin.server.domain.values;

import java.io.Serializable;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.annotation.Nullable;

import com.fasterxml.jackson.annotation.JsonIgnore;
import org.springframework.util.Assert;

import static java.util.Arrays.asList;

/**
 * Instance status with details fetched from the info endpoint.
 *
 * @author Johannes Edmeier
 */
@lombok.Data
public final class StatusInfo implements Serializable {

	public static final String STATUS_UNKNOWN = "UNKNOWN";

	public static final String STATUS_OUT_OF_SERVICE = "OUT_OF_SERVICE";

	public static final String STATUS_UP = "UP";

	public static final String STATUS_DOWN = "DOWN";

	public static final String STATUS_OFFLINE = "OFFLINE";

	public static final String STATUS_RESTRICTED = "RESTRICTED";

	private static final List STATUS_ORDER = asList(STATUS_DOWN, STATUS_OUT_OF_SERVICE, STATUS_OFFLINE,
			STATUS_UNKNOWN, STATUS_RESTRICTED, STATUS_UP);

	private final String status;

	private final Map details;

	private StatusInfo(String status, @Nullable Map details) {
		Assert.hasText(status, "'status' must not be empty.");
		this.status = status.toUpperCase();
		this.details = (details != null) ? new HashMap<>(details) : Collections.emptyMap();
	}

	public static StatusInfo valueOf(String statusCode, @Nullable Map details) {
		return new StatusInfo(statusCode, details);
	}

	public static StatusInfo valueOf(String statusCode) {
		return valueOf(statusCode, null);
	}

	public static StatusInfo ofUnknown() {
		return valueOf(STATUS_UNKNOWN, null);
	}

	public static StatusInfo ofUp() {
		return ofUp(null);
	}

	public static StatusInfo ofDown() {
		return ofDown(null);
	}

	public static StatusInfo ofOffline() {
		return ofOffline(null);
	}

	public static StatusInfo ofUp(@Nullable Map details) {
		return valueOf(STATUS_UP, details);
	}

	public static StatusInfo ofDown(@Nullable Map details) {
		return valueOf(STATUS_DOWN, details);
	}

	public static StatusInfo ofOffline(@Nullable Map details) {
		return valueOf(STATUS_OFFLINE, details);
	}

	public Map getDetails() {
		return Collections.unmodifiableMap(details);
	}

	@JsonIgnore
	public boolean isUp() {
		return STATUS_UP.equals(status);
	}

	@JsonIgnore
	public boolean isOffline() {
		return STATUS_OFFLINE.equals(status);
	}

	@JsonIgnore
	public boolean isDown() {
		return STATUS_DOWN.equals(status);
	}

	@JsonIgnore
	public boolean isUnknown() {
		return STATUS_UNKNOWN.equals(status);
	}

	public static Comparator severity() {
		return Comparator.comparingInt(STATUS_ORDER::indexOf);
	}

	@SuppressWarnings("unchecked")
	public static StatusInfo from(Map body) {
		return StatusInfo.valueOf((String) (body).get("status"), (Map) body.get("details"));
	}

}