1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.message;
18
19 import java.io.Serializable;
20
21
22
23
24 public class StructuredDataId implements Serializable {
25
26 private static final String AT = "@";
27
28
29
30
31 public static final StructuredDataId TIME_QUALITY = new StructuredDataId("timeQuality", null,
32 new String[]{"tzKnown", "isSynced", "syncAccuracy"});
33
34
35
36
37 public static final StructuredDataId ORIGIN = new StructuredDataId("origin", null,
38 new String[]{"ip", "enterpriseId", "software", "swVersion"});
39
40
41
42
43 public static final StructuredDataId META = new StructuredDataId("meta", null,
44 new String[]{"sequenceId", "sysUpTime", "language"});
45
46
47
48
49 public static final int RESERVED = -1;
50
51 private static final long serialVersionUID = 9031746276396249990L;
52 private static final int MAX_LENGTH = 32;
53
54 private final String name;
55 private final int enterpriseNumber;
56 private final String[] required;
57 private final String[] optional;
58
59
60 protected StructuredDataId(final String name, final String[] required, final String[] optional) {
61 int index = -1;
62 if (name != null) {
63 if (name.length() > MAX_LENGTH) {
64 throw new IllegalArgumentException(String.format("Length of id %s exceeds maximum of %d characters",
65 name, MAX_LENGTH));
66 }
67 index = name.indexOf(AT);
68 }
69
70 if (index > 0) {
71 this.name = name.substring(0, index);
72 this.enterpriseNumber = Integer.parseInt(name.substring(index + 1));
73 } else {
74 this.name = name;
75 this.enterpriseNumber = RESERVED;
76 }
77 this.required = required;
78 this.optional = optional;
79 }
80
81
82
83
84
85
86
87
88
89 public StructuredDataId(final String name, final int enterpriseNumber, final String[] required,
90 final String[] optional) {
91 if (name == null) {
92 throw new IllegalArgumentException("No structured id name was supplied");
93 }
94 if (name.contains(AT)) {
95 throw new IllegalArgumentException("Structured id name cannot contain an '" + AT + '\'');
96 }
97 if (enterpriseNumber <= 0) {
98 throw new IllegalArgumentException("No enterprise number was supplied");
99 }
100 this.name = name;
101 this.enterpriseNumber = enterpriseNumber;
102 final String id = enterpriseNumber < 0 ? name : name + AT + enterpriseNumber;
103 if (id.length() > MAX_LENGTH) {
104 throw new IllegalArgumentException("Length of id exceeds maximum of 32 characters: " + id);
105 }
106 this.required = required;
107 this.optional = optional;
108 }
109
110
111
112
113
114
115 public StructuredDataId makeId(final StructuredDataId id) {
116 if (id == null) {
117 return this;
118 }
119 return makeId(id.getName(), id.getEnterpriseNumber());
120 }
121
122
123
124
125
126
127
128 public StructuredDataId makeId(final String defaultId, final int enterpriseNumber) {
129 String id;
130 String[] req;
131 String[] opt;
132 if (enterpriseNumber <= 0) {
133 return this;
134 }
135 if (this.name != null) {
136 id = this.name;
137 req = this.required;
138 opt = this.optional;
139 } else {
140 id = defaultId;
141 req = null;
142 opt = null;
143 }
144
145 return new StructuredDataId(id, enterpriseNumber, req, opt);
146 }
147
148
149
150
151
152 public String[] getRequired() {
153 return required;
154 }
155
156
157
158
159
160 public String[] getOptional() {
161 return optional;
162 }
163
164
165
166
167
168 public String getName() {
169 return name;
170 }
171
172
173
174
175
176 public int getEnterpriseNumber() {
177 return enterpriseNumber;
178 }
179
180
181
182
183
184 public boolean isReserved() {
185 return enterpriseNumber <= 0;
186 }
187
188 @Override
189 public String toString() {
190 return isReserved() ? name : name + AT + enterpriseNumber;
191 }
192 }