-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Added Webex Notifier * Added Webex Notifier doc * updated webex notifier doc --------- Co-authored-by: Stephan Köninger <stephan.koeninger@codecentric.de>
- Loading branch information
Showing
5 changed files
with
380 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
191 changes: 191 additions & 0 deletions
191
...oot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/WebexNotifier.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| /* | ||
| * Copyright 2014-2024 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 | ||
| * | ||
| * https://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.notify; | ||
|
|
||
| import java.net.URI; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.springframework.context.expression.MapAccessor; | ||
| import org.springframework.expression.Expression; | ||
| import org.springframework.expression.ParserContext; | ||
| import org.springframework.expression.spel.standard.SpelExpressionParser; | ||
| import org.springframework.expression.spel.support.DataBindingPropertyAccessor; | ||
| import org.springframework.expression.spel.support.SimpleEvaluationContext; | ||
| import org.springframework.http.HttpEntity; | ||
| import org.springframework.http.HttpHeaders; | ||
| import org.springframework.http.MediaType; | ||
| import org.springframework.lang.Nullable; | ||
| import org.springframework.web.client.RestTemplate; | ||
| import reactor.core.publisher.Mono; | ||
|
|
||
| import de.codecentric.boot.admin.server.domain.entities.Instance; | ||
| import de.codecentric.boot.admin.server.domain.entities.InstanceRepository; | ||
| import de.codecentric.boot.admin.server.domain.events.InstanceEvent; | ||
|
|
||
| // The following class, `WebexNotifier`, is responsible for sending notifications through the Webex API | ||
| // whenever events related to the state of instances within the Spring Boot Admin server occur. | ||
|
|
||
| /** | ||
| * `WebexNotifier` sends notifications via Webex API when instance events occur. It is | ||
| * part of the spring-boot-admin-server which is used for monitoring and managing Spring | ||
| * Boot applications. | ||
| */ | ||
| public class WebexNotifier extends AbstractStatusChangeNotifier { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(WebexNotifier.class); | ||
|
|
||
| private static final URI DEFAULT_URL = URI.create("https://webexapis.com/v1/messages"); | ||
|
|
||
| private static final String DEFAULT_MESSAGE = "<strong>#{instance.registration.name}</strong>/#{instance.id} is <strong>#{event.statusInfo.status}</strong>"; | ||
|
|
||
| private RestTemplate restTemplate; | ||
|
|
||
| /** | ||
| * base url for Webex API (i.e. https://webexapis.com/v1/messages) | ||
| */ | ||
| private URI url = DEFAULT_URL; | ||
|
|
||
| /** | ||
| * Bearer authentication token for Webex API | ||
| */ | ||
| @Nullable | ||
| private String authToken; | ||
|
|
||
| /** | ||
| * Room identifier in Webex where the message will be sent | ||
| */ | ||
| @Nullable | ||
| private String roomId; | ||
|
|
||
| private final SpelExpressionParser parser = new SpelExpressionParser(); | ||
|
|
||
| /** | ||
| * Template for the message to be sent | ||
| */ | ||
| private Expression message; | ||
|
|
||
| /** | ||
| * Creates a new WebexNotifier with the given repository and restTemplate. | ||
| * @param repository the instance repository responsible for storing instances | ||
| * @param restTemplate the restTemplate used to make HTTP requests | ||
| */ | ||
| public WebexNotifier(InstanceRepository repository, RestTemplate restTemplate) { | ||
| super(repository); | ||
| this.restTemplate = restTemplate; | ||
| this.message = parser.parseExpression(DEFAULT_MESSAGE, ParserContext.TEMPLATE_EXPRESSION); | ||
| } | ||
|
|
||
| /** | ||
| * Sends a notification with the given event and instance. | ||
| * @param event the instance event to notify | ||
| * @param instance the instance associated with the event | ||
| * @return a Mono representing the completion of the notification | ||
| * @throws IllegalStateException if 'authToken' is null | ||
| */ | ||
| @Override | ||
| protected Mono<Void> doNotify(InstanceEvent event, Instance instance) { | ||
|
|
||
| if (authToken == null) { | ||
| return Mono.error(new IllegalStateException("'authToken' must not be null.")); | ||
| } | ||
|
|
||
| HttpHeaders headers = new HttpHeaders(); | ||
| headers.setContentType(MediaType.APPLICATION_JSON); | ||
| headers.setBearerAuth(authToken); | ||
|
|
||
| LOGGER.debug("Event: {}", event.getInstance()); | ||
|
|
||
| return Mono.fromRunnable(() -> restTemplate.postForEntity(url, | ||
| new HttpEntity<>(createMessage(event, instance), headers), Void.class)); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a message object containing the parameters required for sending a | ||
| * notification. | ||
| * @param event the instance event for which the message is being created | ||
| * @param instance the instance associated with the event | ||
| * @return a Map object containing the parameters for sending a notification | ||
| */ | ||
| protected Object createMessage(InstanceEvent event, Instance instance) { | ||
| Map<String, Object> parameters = new HashMap<>(); | ||
| parameters.put("roomId", this.roomId); | ||
| parameters.put("markdown", getText(event, instance)); | ||
| return parameters; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the text for the given event and instance. | ||
| * @param event the instance event for which the text is being retrieved | ||
| * @param instance the instance associated with the event | ||
| * @return the text for the event and instance, or null if not available | ||
| */ | ||
| @Nullable | ||
| protected String getText(InstanceEvent event, Instance instance) { | ||
| Map<String, Object> root = new HashMap<>(); | ||
| root.put("event", event); | ||
| root.put("instance", instance); | ||
| root.put("lastStatus", getLastStatus(event.getInstance())); | ||
| SimpleEvaluationContext context = SimpleEvaluationContext | ||
| .forPropertyAccessors(DataBindingPropertyAccessor.forReadOnlyAccess(), new MapAccessor()) | ||
| .withRootObject(root) | ||
| .build(); | ||
|
|
||
| return message.getValue(context, String.class); | ||
| } | ||
|
|
||
| public void setRestTemplate(RestTemplate restTemplate) { | ||
| this.restTemplate = restTemplate; | ||
| } | ||
|
|
||
| public URI getUrl() { | ||
| return url; | ||
| } | ||
|
|
||
| public void setUrl(URI url) { | ||
| this.url = url; | ||
| } | ||
|
|
||
| @Nullable | ||
| public String getAuthToken() { | ||
| return authToken; | ||
| } | ||
|
|
||
| public void setAuthToken(@Nullable String authToken) { | ||
| this.authToken = authToken; | ||
| } | ||
|
|
||
| @Nullable | ||
| public String getRoomId() { | ||
| return roomId; | ||
| } | ||
|
|
||
| public void setRoomId(@Nullable String roomId) { | ||
| this.roomId = roomId; | ||
| } | ||
|
|
||
| public Expression getMessage() { | ||
| return message; | ||
| } | ||
|
|
||
| public void setMessage(String message) { | ||
| this.message = parser.parseExpression(message, ParserContext.TEMPLATE_EXPRESSION); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.