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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
// 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.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.SortedMap;
import java.util.TreeMap;
/**
* 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,
String title, List<String> messages, Optional<MailContent> mailContent) {
public Notification(Instant at, Type type, Level level, NotificationSource source, String title, List<String> messages) {
this(at, type, level, source, title, messages, Optional.empty());
}
public Notification(Instant at, Type type, Level level, NotificationSource source, List<String> messages) {
this(at, type, level, source, "", messages);
}
public Notification {
Objects.requireNonNull(at, "at cannot be null");
Objects.requireNonNull(type, "type cannot be null");
Objects.requireNonNull(level, "level cannot be null");
Objects.requireNonNull(source, "source cannot be null");
Objects.requireNonNull(title, "title cannot be null");
messages = List.copyOf(Objects.requireNonNull(messages, "messages cannot be null"));
// Allowing empty title temporarily until all notifications have a title
// if (title.isBlank()) throw new IllegalArgumentException("title cannot be empty");
if (messages.isEmpty() && title.isBlank()) throw new IllegalArgumentException("messages cannot be empty when title is empty");
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 MailTemplating.Template template;
private final SortedMap<String, Object> values;
private final String subject;
private MailContent(Builder b) {
template = Objects.requireNonNull(b.template);
values = new TreeMap<>(b.values);
subject = b.subject;
}
public MailTemplating.Template template() { return template; }
public SortedMap<String, Object> values() { return Collections.unmodifiableSortedMap(values); }
public Optional<String> subject() { return Optional.ofNullable(subject); }
public static Builder fromTemplate(MailTemplating.Template template) { return new Builder(template); }
public static class Builder {
private final MailTemplating.Template template;
private final Map<String, Object> values = new HashMap<>();
private String subject;
private Builder(MailTemplating.Template template) {
this.template = template;
}
public Builder with(String name, String value) { values.put(name, value); return this; }
public Builder with(String name, Collection<String> items) { values.put(name, List.copyOf(items)); return this; }
public Builder subject(String s) { this.subject = s; return this; }
public MailContent build() { return new MailContent(this); }
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
MailContent that = (MailContent) o;
return Objects.equals(template, that.template) && Objects.equals(values, that.values) && Objects.equals(subject, that.subject);
}
@Override
public int hashCode() {
return Objects.hash(template, values, subject);
}
@Override
public String toString() {
return "MailContent{" +
"template='" + template + '\'' +
", values=" + values +
", subject='" + subject + '\'' +
'}';
}
}
}
|
