/
Api.java
232 lines (203 loc) · 6.23 KB
/
Api.java
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/*
* Copyright © 2015 The Gravitee team (http://gravitee.io)
*
* 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
*
* http://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 io.gravitee.apim.core.api.model;
import io.gravitee.apim.core.datetime.TimeProvider;
import io.gravitee.definition.model.DefinitionContext;
import io.gravitee.definition.model.DefinitionVersion;
import io.gravitee.definition.model.v4.ApiType;
import io.gravitee.definition.model.v4.property.Property;
import java.time.ZonedDateTime;
import java.util.List;
import java.util.Set;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.experimental.Accessors;
import lombok.experimental.SuperBuilder;
@Data
@NoArgsConstructor
@AllArgsConstructor
@SuperBuilder(toBuilder = true)
@Accessors(chain = true)
public class Api {
/**
* The api ID.
*/
private String id;
/**
* The ID of the environment the api is attached to
*/
private String environmentId;
/**
* The api crossId uniquely identifies an API across environments.
* Apis promoted between environments will share the same crossId.
*/
private String crossId;
/**
* The api name.
*/
private String name;
/**
* the api description.
*/
private String description;
/**
* The api version.
*/
private String version;
/**
* the API definition context.
*/
@Builder.Default
private DefinitionContext definitionContext = new DefinitionContext();
/**
* The api definition version.
*/
private DefinitionVersion definitionVersion;
private io.gravitee.definition.model.v4.Api apiDefinitionV4;
private io.gravitee.definition.model.Api apiDefinition;
/**
* The api type.
*/
private ApiType type;
/**
* The api deployment date
*/
private ZonedDateTime deployedAt;
/**
* The Api creation date
*/
private ZonedDateTime createdAt;
/**
* The Api last updated date
*/
private ZonedDateTime updatedAt;
/**
* The api visibility
*/
@Builder.Default
private Visibility visibility = Visibility.PRIVATE;
/**
* The current runtime life cycle state.
*/
@Builder.Default
private LifecycleState lifecycleState = LifecycleState.STOPPED;
/**
* The api picture
*/
private String picture;
/**
* the api group, may be null
*/
private Set<String> groups;
/**
* The views associated to this API
*/
private Set<String> categories;
/**
*
*/
private List<String> labels;
private boolean disableMembershipNotifications;
@Builder.Default
private ApiLifecycleState apiLifecycleState = ApiLifecycleState.CREATED;
private String background;
public enum Visibility {
/**
* The entity is visible to everyone.
*/
PUBLIC,
/**
* The entity is visible only from its members.
*/
PRIVATE,
}
public enum LifecycleState {
STARTED,
STOPPED,
}
public enum ApiLifecycleState {
CREATED,
PUBLISHED,
UNPUBLISHED,
DEPRECATED,
ARCHIVED,
}
public boolean isDeprecated() {
return apiLifecycleState == ApiLifecycleState.DEPRECATED;
}
public Set<String> getTags() {
if (definitionVersion == DefinitionVersion.V4) {
return apiDefinitionV4.getTags();
} else {
return apiDefinition.getTags();
}
}
public Api setId(String id) {
this.id = id;
if (apiDefinitionV4 != null) {
apiDefinitionV4.setId(id);
}
if (apiDefinition != null) {
apiDefinition.setId(id);
}
return this;
}
public Api setApiDefinitionV4(io.gravitee.definition.model.v4.Api apiDefinitionV4) {
this.apiDefinitionV4 = apiDefinitionV4;
this.definitionVersion = apiDefinitionV4.getDefinitionVersion();
return this;
}
public Api setApiDefinition(io.gravitee.definition.model.Api apiDefinition) {
this.apiDefinition = apiDefinition;
this.definitionVersion = apiDefinition.getDefinitionVersion();
return this;
}
/**
* Updates the list of properties to include dynamic properties
*
* @param dynamicProperties the list of dynamic properties to update the list of property
* @return true if an update has been done, meaning the Api need to be persisted
*/
public boolean updateDynamicProperties(List<Property> dynamicProperties) {
if (definitionVersion != DefinitionVersion.V4) {
return false;
}
final ApiProperties apiProperties = new ApiProperties(this.apiDefinitionV4.getProperties());
final ApiProperties.DynamicPropertiesResult properties = apiProperties.updateDynamicProperties(dynamicProperties);
this.getApiDefinitionV4().setProperties(properties.orderedProperties());
setUpdatedAt(TimeProvider.now());
return properties.needToUpdate();
}
public abstract static class ApiBuilder<C extends Api, B extends ApiBuilder<C, B>> {
public B apiDefinition(io.gravitee.definition.model.Api apiDefinition) {
this.apiDefinition = apiDefinition;
if (apiDefinition != null) {
this.definitionVersion = apiDefinition.getDefinitionVersion();
}
return self();
}
public B apiDefinitionV4(io.gravitee.definition.model.v4.Api apiDefinitionV4) {
this.apiDefinitionV4 = apiDefinitionV4;
if (apiDefinitionV4 != null) {
this.definitionVersion = apiDefinitionV4.getDefinitionVersion();
}
return self();
}
}
}