Skip to content

Add missing factory and helper methods for OUT_OF_SERVICE and RESTRICTED status #5012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SteKoe merged 1 commit into from
Jan 26, 2026
+63 −0
Merged

Add missing factory and helper methods for OUT_OF_SERVICE and RESTRICTED status #5012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions ...admin-server/src/main/java/de/codecentric/boot/admin/server/domain/values/StatusInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,14 @@ public static StatusInfo ofOffline() {
return ofOffline(null);
}

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

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

public static StatusInfo ofUp(@Nullable Map<String, Object> details) {
return valueOf(STATUS_UP, details);
}
Expand All @@ -97,6 +105,14 @@ public static StatusInfo ofOffline(@Nullable Map<String, Object> details) {
return valueOf(STATUS_OFFLINE, details);
}

public static StatusInfo ofOutOfService(@Nullable Map<String, Object> details) {
return valueOf(STATUS_OUT_OF_SERVICE, details);
}

public static StatusInfo ofRestricted(@Nullable Map<String, Object> details) {
return valueOf(STATUS_RESTRICTED, details);
}

public Map<String, Object> getDetails() {
return Collections.unmodifiableMap(details);
}
Expand All @@ -117,6 +133,14 @@ public boolean isUnknown() {
return STATUS_UNKNOWN.equals(status);
}

public boolean isOutOfService() {
return STATUS_OUT_OF_SERVICE.equals(status);
}

public boolean isRestricted() {
return STATUS_RESTRICTED.equals(status);
}

public static Comparator<String> severity() {
return Comparator.comparingInt(STATUS_ORDER::indexOf);
}
Expand Down
39 changes: 39 additions & 0 deletions ...n-server/src/test/java/de/codecentric/boot/admin/server/domain/values/StatusInfoTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,26 +47,50 @@ void test_isMethods() {
assertThat(StatusInfo.valueOf("FOO").isDown()).isFalse();
assertThat(StatusInfo.valueOf("FOO").isUnknown()).isFalse();
assertThat(StatusInfo.valueOf("FOO").isOffline()).isFalse();
assertThat(StatusInfo.valueOf("FOO").isOutOfService()).isFalse();
assertThat(StatusInfo.valueOf("FOO").isRestricted()).isFalse();

assertThat(StatusInfo.ofUp().isUp()).isTrue();
assertThat(StatusInfo.ofUp().isDown()).isFalse();
assertThat(StatusInfo.ofUp().isUnknown()).isFalse();
assertThat(StatusInfo.ofUp().isOffline()).isFalse();
assertThat(StatusInfo.ofUp().isOutOfService()).isFalse();
assertThat(StatusInfo.ofUp().isRestricted()).isFalse();

assertThat(StatusInfo.ofDown().isUp()).isFalse();
assertThat(StatusInfo.ofDown().isDown()).isTrue();
assertThat(StatusInfo.ofDown().isUnknown()).isFalse();
assertThat(StatusInfo.ofDown().isOffline()).isFalse();
assertThat(StatusInfo.ofDown().isOutOfService()).isFalse();
assertThat(StatusInfo.ofDown().isRestricted()).isFalse();

assertThat(StatusInfo.ofUnknown().isUp()).isFalse();
assertThat(StatusInfo.ofUnknown().isDown()).isFalse();
assertThat(StatusInfo.ofUnknown().isUnknown()).isTrue();
assertThat(StatusInfo.ofUnknown().isOffline()).isFalse();
assertThat(StatusInfo.ofUnknown().isOutOfService()).isFalse();
assertThat(StatusInfo.ofUnknown().isRestricted()).isFalse();

assertThat(StatusInfo.ofOffline().isUp()).isFalse();
assertThat(StatusInfo.ofOffline().isDown()).isFalse();
assertThat(StatusInfo.ofOffline().isUnknown()).isFalse();
assertThat(StatusInfo.ofOffline().isOffline()).isTrue();
assertThat(StatusInfo.ofOffline().isOutOfService()).isFalse();
assertThat(StatusInfo.ofOffline().isRestricted()).isFalse();

assertThat(StatusInfo.ofOutOfService().isUp()).isFalse();
assertThat(StatusInfo.ofOutOfService().isDown()).isFalse();
assertThat(StatusInfo.ofOutOfService().isUnknown()).isFalse();
assertThat(StatusInfo.ofOutOfService().isOffline()).isFalse();
assertThat(StatusInfo.ofOutOfService().isOutOfService()).isTrue();
assertThat(StatusInfo.ofOutOfService().isRestricted()).isFalse();

assertThat(StatusInfo.ofRestricted().isUp()).isFalse();
assertThat(StatusInfo.ofRestricted().isDown()).isFalse();
assertThat(StatusInfo.ofRestricted().isUnknown()).isFalse();
assertThat(StatusInfo.ofRestricted().isOffline()).isFalse();
assertThat(StatusInfo.ofRestricted().isOutOfService()).isFalse();
assertThat(StatusInfo.ofRestricted().isRestricted()).isTrue();
}

@Test
Expand All @@ -78,6 +102,21 @@ void from_map_should_return_same_result() {
assertThat(StatusInfo.from(map)).isEqualTo(StatusInfo.ofUp(singletonMap("foo", "bar")));
}

@Test
void factory_methods_with_details() {
Map<String, Object> details = singletonMap("reason", "maintenance");

StatusInfo outOfService = StatusInfo.ofOutOfService(details);
assertThat(outOfService.getStatus()).isEqualTo(STATUS_OUT_OF_SERVICE);
assertThat(outOfService.getDetails()).containsEntry("reason", "maintenance");
assertThat(outOfService.isOutOfService()).isTrue();

StatusInfo restricted = StatusInfo.ofRestricted(details);
assertThat(restricted.getStatus()).isEqualTo(STATUS_RESTRICTED);
assertThat(restricted.getDetails()).containsEntry("reason", "maintenance");
assertThat(restricted.isRestricted()).isTrue();
}

@Test
void when_first_level_key_is_components() {
Map<String, Object> map = new HashMap<>();
Expand Down