1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.notification;
import java.time.Instant;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
/**
* Represents an event that we want to notify the tenant about. The message(s) should be short
* and only describe event details: the final presentation will prefix the message with general
* information from other metadata in this notification (e.g. links to relevant console views
* and/or relevant documentation.
*
* @author freva
*/
public record Notification(Instant at, Notification.Type type, Notification.Level level, NotificationSource source,
List<String> messages, Optional<MailContent> mailContent) {
public Notification(Instant at, Type type, Level level, NotificationSource source, List<String> messages) {
this(at, type, level, source, messages, Optional.empty());
}
public Notification {
at = Objects.requireNonNull(at, "at cannot be null");
type = Objects.requireNonNull(type, "type cannot be null");
level = Objects.requireNonNull(level, "level cannot be null");
source = Objects.requireNonNull(source, "source cannot be null");
messages = List.copyOf(Objects.requireNonNull(messages, "messages cannot be null"));
if (messages.size() < 1) throw new IllegalArgumentException("messages cannot be empty");
mailContent = Objects.requireNonNull(mailContent);
}
public enum Level {
// Must be ordered in order of importance
info, warning, error
}
public enum Type {
/**
* Related to contents of application package, e.g., usage of deprecated features/syntax
*/
applicationPackage,
/**
* Related to contents of application package detectable by the controller on submission
*/
submission,
/**
* Related to contents of application test package, e.g., mismatch between deployment spec and provided tests
*/
testPackage,
/**
* Related to deployment of application, e.g., system test failure, node allocation failure, internal errors, etc.
*/
deployment,
/**
* Application cluster is (near) external feed blocked
*/
feedBlock,
/**
* Application cluster is reindexing document(s)
*/
reindex,
/**
* Account, e.g. expiration of trial plan
*/
account
}
public static class MailContent {
private final String template;
private final Map<String, Object> values;
private final String subject;
private MailContent(Builder b) {
template = Objects.requireNonNull(b.template);
values = Map.copyOf(b.values);
subject = b.subject;
}
public String template() { return template; }
public Map<String, Object> values() { return Map.copyOf(values); }
public Optional<String> subject() { return Optional.ofNullable(subject); }
public static Builder fromTemplate(String template) { return new Builder(template); }
public static class Builder {
private final String template;
private final HashMap<String, Object> values = new HashMap<>();
private String subject;
private Builder(String template) {
this.template = template;
}
public Builder with(String name, Object value) { values.put(name, value); return this; }
public Builder subject(String s) { this.subject = s; return this; }
public MailContent build() { return new MailContent(this); }
}
}
}
|