-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Expand file tree
/
Copy pathEntityResource.java
More file actions
1376 lines (1266 loc) · 53.5 KB
/
EntityResource.java
File metadata and controls
1376 lines (1266 loc) · 53.5 KB
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2021 Collate
* 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 org.openmetadata.service.resources;
import static org.openmetadata.common.utils.CommonUtil.listOrEmpty;
import static org.openmetadata.common.utils.CommonUtil.nullOrEmpty;
import static org.openmetadata.schema.type.EventType.ENTITY_CREATED;
import static org.openmetadata.schema.type.MetadataOperation.CREATE;
import static org.openmetadata.schema.type.MetadataOperation.VIEW_BASIC;
import static org.openmetadata.service.security.DefaultAuthorizer.getSubjectContext;
import static org.openmetadata.service.util.EntityUtil.createOrUpdateOperation;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import jakarta.json.JsonPatch;
import jakarta.validation.constraints.Max;
import jakarta.validation.constraints.Min;
import jakarta.ws.rs.DefaultValue;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.Context;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.SecurityContext;
import jakarta.ws.rs.core.UriInfo;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.IdentityHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import java.util.UUID;
import java.util.concurrent.ExecutorService;
import java.util.stream.Collectors;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.openmetadata.csv.CsvExportProgressCallback;
import org.openmetadata.csv.CsvImportProgressCallback;
import org.openmetadata.csv.CsvUtil;
import org.openmetadata.schema.BulkAssetsRequestInterface;
import org.openmetadata.schema.CreateEntity;
import org.openmetadata.schema.EntityInterface;
import org.openmetadata.schema.type.ApiStatus;
import org.openmetadata.schema.type.EntityHistory;
import org.openmetadata.schema.type.EntityReference;
import org.openmetadata.schema.type.Include;
import org.openmetadata.schema.type.MetadataOperation;
import org.openmetadata.schema.type.Permission;
import org.openmetadata.schema.type.ResourcePermission;
import org.openmetadata.schema.type.api.BulkOperationResult;
import org.openmetadata.schema.type.api.BulkResponse;
import org.openmetadata.schema.type.change.ChangeSource;
import org.openmetadata.schema.type.csv.CsvImportResult;
import org.openmetadata.schema.utils.ResultList;
import org.openmetadata.service.Entity;
import org.openmetadata.service.OpenMetadataApplicationConfig;
import org.openmetadata.service.exception.CatalogExceptionMessage;
import org.openmetadata.service.jdbi3.EntityRepository;
import org.openmetadata.service.jdbi3.ListFilter;
import org.openmetadata.service.limits.Limits;
import org.openmetadata.service.mapper.EntityMapper;
import org.openmetadata.service.monitoring.LatencyPhase;
import org.openmetadata.service.monitoring.RequestLatencyContext;
import org.openmetadata.service.search.SearchListFilter;
import org.openmetadata.service.search.SearchSortFilter;
import org.openmetadata.service.security.AuthRequest;
import org.openmetadata.service.security.AuthorizationException;
import org.openmetadata.service.security.AuthorizationLogic;
import org.openmetadata.service.security.Authorizer;
import org.openmetadata.service.security.ImpersonationContext;
import org.openmetadata.service.security.policyevaluator.CreateResourceContext;
import org.openmetadata.service.security.policyevaluator.OperationContext;
import org.openmetadata.service.security.policyevaluator.ResourceContext;
import org.openmetadata.service.security.policyevaluator.ResourceContextInterface;
import org.openmetadata.service.security.policyevaluator.SubjectContext;
import org.openmetadata.service.util.AsyncService;
import org.openmetadata.service.util.BulkAssetsOperationResponse;
import org.openmetadata.service.util.CSVExportResponse;
import org.openmetadata.service.util.CSVImportResponse;
import org.openmetadata.service.util.DeleteEntityResponse;
import org.openmetadata.service.util.EntityUtil;
import org.openmetadata.service.util.EntityUtil.Fields;
import org.openmetadata.service.util.EntityUtil.RelationIncludes;
import org.openmetadata.service.util.RestUtil;
import org.openmetadata.service.util.RestUtil.DeleteResponse;
import org.openmetadata.service.util.RestUtil.PatchResponse;
import org.openmetadata.service.util.RestUtil.PutResponse;
import org.openmetadata.service.util.ValidatorUtil;
import org.openmetadata.service.util.WebsocketNotificationHandler;
@Slf4j
@LatencyPhase
public abstract class EntityResource<T extends EntityInterface, K extends EntityRepository<T>> {
protected final Class<T> entityClass;
protected final String entityType;
protected final Set<String> allowedFields;
@Getter protected final K repository;
protected final Authorizer authorizer;
protected final Limits limits;
protected final Map<String, MetadataOperation> fieldsToViewOperations = new HashMap<>();
protected EntityResource(String entityType, Authorizer authorizer, Limits limits) {
this.entityType = entityType;
this.repository = (K) Entity.getEntityRepository(entityType);
this.entityClass = (Class<T>) Entity.getEntityClassFromType(entityType);
allowedFields = repository.getAllowedFields();
this.authorizer = authorizer;
this.limits = limits;
addViewOperation(
"owners,followers,votes,tags,extension,domains,dataProducts,experts,reviewers", VIEW_BASIC);
Entity.registerResourcePermissions(entityType, getEntitySpecificOperations());
Entity.registerResourceFieldViewMapping(entityType, fieldsToViewOperations);
}
/** Method used for initializing a resource, such as creating default policies, roles, etc. */
public void initialize(OpenMetadataApplicationConfig config) throws IOException {}
/**
* Method used for upgrading a resource such as adding new fields to entities, etc. that can't be done in bootstrap
* migrate
*/
public void upgrade() {
// Nothing to do in the default implementation
}
public final Fields getFields(String fields) {
return repository.getFields(fields);
}
protected T addHref(UriInfo uriInfo, T entity) {
try (var ignored = RequestLatencyContext.phase("addHref")) {
Entity.withHref(uriInfo, entity.getOwners());
Entity.withHref(uriInfo, entity.getFollowers());
Entity.withHref(uriInfo, entity.getExperts());
Entity.withHref(uriInfo, entity.getReviewers());
Entity.withHref(uriInfo, entity.getChildren());
Entity.withHref(uriInfo, entity.getDomains());
Entity.withHref(uriInfo, entity.getDataProducts());
return entity;
}
}
protected List<MetadataOperation> getEntitySpecificOperations() {
return null;
}
public final ResultList<T> addHref(UriInfo uriInfo, ResultList<T> list) {
try (var ignored = RequestLatencyContext.phase("addHref")) {
listOrEmpty(list.getData()).forEach(i -> addHref(uriInfo, i));
return list;
}
}
public ResultList<T> listInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String fieldsParam,
ListFilter filter,
int limitParam,
String before,
String after) {
Fields fields = getFields(fieldsParam);
OperationContext listOperationContext =
new OperationContext(entityType, getViewOperations(fields));
ResourceContext resourceContext = filter.getResourceContext(entityType);
return listInternal(
uriInfo,
securityContext,
fields,
filter,
limitParam,
before,
after,
listOperationContext,
resourceContext);
}
public ResultList<T> listInternal(
UriInfo uriInfo,
SecurityContext securityContext,
Fields fields,
ListFilter filter,
int limitParam,
String before,
String after,
OperationContext operationContext,
ResourceContextInterface resourceContext) {
RestUtil.validateCursors(before, after);
authorizer.authorize(securityContext, operationContext, resourceContext);
// Add Domain Filter
EntityUtil.addDomainQueryParam(securityContext, filter, entityType);
// List
ResultList<T> resultList;
if (before != null) { // Reverse paging
resultList = repository.listBefore(uriInfo, fields, filter, limitParam, before);
} else { // Forward paging or first page
resultList = repository.listAfter(uriInfo, fields, filter, limitParam, after);
}
return addHref(uriInfo, resultList);
}
public ResultList<T> listInternal(
UriInfo uriInfo,
SecurityContext securityContext,
Fields fields,
ListFilter filter,
int limitParam,
String before,
String after,
List<AuthRequest> authRequests) {
RestUtil.validateCursors(before, after);
authorizer.authorizeRequests(securityContext, authRequests, AuthorizationLogic.ANY);
// Add Domain Filter
EntityUtil.addDomainQueryParam(securityContext, filter, entityType);
// List
ResultList<T> resultList;
if (before != null) { // Reverse paging
resultList = repository.listBefore(uriInfo, fields, filter, limitParam, before);
} else { // Forward paging or first page
resultList = repository.listAfter(uriInfo, fields, filter, limitParam, after);
}
return addHref(uriInfo, resultList);
}
protected ResultList<T> searchInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String fieldsParam,
ListFilter filter,
String query,
int limit,
int offset) {
Fields fields = getFields(fieldsParam);
OperationContext operationContext = new OperationContext(entityType, getViewOperations(fields));
ResourceContextInterface resourceContext = filter.getResourceContext(entityType);
authorizer.authorize(securityContext, operationContext, resourceContext);
EntityUtil.addDomainQueryParam(securityContext, filter, entityType);
if (!nullOrEmpty(query)) {
filter.addQueryParam("nameFilter", query);
}
ResultList<T> resultList =
repository.listAfterWithOffset(uriInfo, fields, filter, limit, offset);
return addHref(uriInfo, resultList);
}
public ResultList<T> listInternalFromSearch(
UriInfo uriInfo,
SecurityContext securityContext,
Fields fields,
SearchListFilter searchListFilter,
int limit,
int offset,
SearchSortFilter searchSortFilter,
String q,
String queryString,
List<AuthRequest> authRequests)
throws IOException {
authorizer.authorizeRequests(securityContext, authRequests, AuthorizationLogic.ANY);
return repository.listFromSearchWithOffset(
uriInfo,
fields,
searchListFilter,
limit,
offset,
searchSortFilter,
q,
queryString,
securityContext);
}
public T getInternal(
UriInfo uriInfo,
SecurityContext securityContext,
UUID id,
String fieldsParam,
Include include) {
return getInternal(uriInfo, securityContext, id, fieldsParam, include, null);
}
public T getInternal(
UriInfo uriInfo,
SecurityContext securityContext,
UUID id,
String fieldsParam,
Include include,
String includeRelations) {
Fields fields = getFields(fieldsParam);
OperationContext operationContext = new OperationContext(entityType, getViewOperations(fields));
RelationIncludes relationIncludes = new RelationIncludes(include, includeRelations);
return getInternal(
uriInfo,
securityContext,
id,
fields,
relationIncludes,
operationContext,
getResourceContextById(id, relationIncludes, fields));
}
public T getInternal(
UriInfo uriInfo,
SecurityContext securityContext,
UUID id,
Fields fields,
Include include,
OperationContext operationContext,
ResourceContextInterface resourceContext) {
return getInternal(
uriInfo,
securityContext,
id,
fields,
RelationIncludes.fromInclude(include),
operationContext,
resourceContext);
}
public T getInternal(
UriInfo uriInfo,
SecurityContext securityContext,
UUID id,
Fields fields,
RelationIncludes relationIncludes,
OperationContext operationContext,
ResourceContextInterface resourceContext) {
authorizer.authorize(securityContext, operationContext, resourceContext);
return addHref(uriInfo, repository.get(uriInfo, id, fields, relationIncludes, false));
}
public T getVersionInternal(SecurityContext securityContext, UUID id, String version) {
OperationContext operationContext = new OperationContext(entityType, VIEW_BASIC);
return getVersionInternal(
securityContext, id, version, operationContext, getResourceContextById(id));
}
public T getVersionInternal(
SecurityContext securityContext,
UUID id,
String version,
OperationContext operationContext,
ResourceContextInterface resourceContext) {
authorizer.authorize(securityContext, operationContext, resourceContext);
return repository.getVersion(id, version);
}
protected EntityHistory listVersionsInternal(SecurityContext securityContext, UUID id) {
OperationContext operationContext = new OperationContext(entityType, VIEW_BASIC);
return listVersionsInternal(securityContext, id, operationContext, getResourceContextById(id));
}
protected EntityHistory listVersionsInternal(
SecurityContext securityContext,
UUID id,
OperationContext operationContext,
ResourceContextInterface resourceContext) {
authorizer.authorize(securityContext, operationContext, resourceContext);
return repository.listVersions(id);
}
protected ResultList<T> listEntityHistoryByTimestampInternal(
SecurityContext securityContext,
long startTs,
long endTs,
String before,
String after,
int limit) {
ResourceContext resourceContext = getResourceContext();
OperationContext operationContext = new OperationContext(entityType, VIEW_BASIC);
authorizer.authorize(securityContext, operationContext, resourceContext);
return repository.listEntityHistoryByTimestamp(startTs, endTs, after, before, limit);
}
public T getByNameInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
String fieldsParam,
Include include) {
return getByNameInternal(uriInfo, securityContext, name, fieldsParam, include, null);
}
public T getByNameInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
String fieldsParam,
Include include,
String includeRelations) {
Fields fields = getFields(fieldsParam);
OperationContext operationContext = new OperationContext(entityType, getViewOperations(fields));
RelationIncludes relationIncludes = new RelationIncludes(include, includeRelations);
return getByNameInternal(
uriInfo,
securityContext,
name,
fields,
relationIncludes,
operationContext,
getResourceContextByName(name, relationIncludes, fields));
}
public T getByNameInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
Fields fields,
Include include,
OperationContext operationContext,
ResourceContextInterface resourceContext) {
return getByNameInternal(
uriInfo,
securityContext,
name,
fields,
RelationIncludes.fromInclude(include),
operationContext,
resourceContext);
}
public T getByNameInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
Fields fields,
RelationIncludes relationIncludes,
OperationContext operationContext,
ResourceContextInterface resourceContext) {
authorizer.authorize(securityContext, operationContext, resourceContext);
return addHref(uriInfo, repository.getByName(uriInfo, name, fields, relationIncludes, false));
}
public Response create(UriInfo uriInfo, SecurityContext securityContext, T entity) {
OperationContext operationContext = new OperationContext(entityType, CREATE);
CreateResourceContext<T> createResourceContext =
new CreateResourceContext<>(entityType, entity);
limits.enforceLimits(securityContext, createResourceContext, operationContext);
authorizer.authorize(securityContext, operationContext, createResourceContext);
String impersonatedBy = ImpersonationContext.getImpersonatedBy();
T createdEntity =
addHref(
uriInfo,
repository.create(
uriInfo, entity, securityContext.getUserPrincipal().getName(), impersonatedBy));
return Response.created(createdEntity.getHref()).entity(createdEntity).build();
}
public Response create(
UriInfo uriInfo,
SecurityContext securityContext,
List<AuthRequest> authRequests,
AuthorizationLogic authorizationLogic,
T entity) {
OperationContext operationContext = new OperationContext(entityType, CREATE);
CreateResourceContext<T> createResourceContext =
new CreateResourceContext<>(entityType, entity);
limits.enforceLimits(securityContext, createResourceContext, operationContext);
authorizer.authorizeRequests(securityContext, authRequests, authorizationLogic);
String impersonatedBy = ImpersonationContext.getImpersonatedBy();
T createdEntity =
addHref(
uriInfo,
repository.create(
uriInfo, entity, securityContext.getUserPrincipal().getName(), impersonatedBy));
return Response.created(createdEntity.getHref()).entity(createdEntity).build();
}
public Response createOrUpdate(UriInfo uriInfo, SecurityContext securityContext, T entity) {
repository.prepareInternal(entity, true);
// If entity does not exist, this is a create operation, else update operation
ResourceContext<T> resourceContext = getResourceContextByName(entity.getFullyQualifiedName());
MetadataOperation operation = createOrUpdateOperation(resourceContext);
OperationContext operationContext = new OperationContext(entityType, operation);
String impersonatedBy = ImpersonationContext.getImpersonatedBy();
if (operation == CREATE) {
CreateResourceContext<T> createResourceContext =
new CreateResourceContext<>(entityType, entity);
limits.enforceLimits(securityContext, createResourceContext, operationContext);
authorizer.authorize(securityContext, operationContext, createResourceContext);
T createdEntity =
addHref(
uriInfo,
repository.create(
uriInfo, entity, securityContext.getUserPrincipal().getName(), impersonatedBy));
return new PutResponse<>(Response.Status.CREATED, createdEntity, ENTITY_CREATED).toResponse();
}
resourceContext =
getResourceContextByName(
entity.getFullyQualifiedName(), ResourceContextInterface.Operation.PUT);
authorizer.authorize(securityContext, operationContext, resourceContext);
PutResponse<T> response =
repository.createOrUpdate(uriInfo, entity, securityContext.getUserPrincipal().getName());
addHref(uriInfo, response.getEntity());
return response.toResponse();
}
public Response createOrUpdate(
UriInfo uriInfo,
SecurityContext securityContext,
List<AuthRequest> authRequests,
AuthorizationLogic authorizationLogic,
T entity) {
repository.prepareInternal(entity, true);
// If entity does not exist, this is a create operation, else update operation
ResourceContext<T> resourceContext = getResourceContextByName(entity.getFullyQualifiedName());
MetadataOperation operation = createOrUpdateOperation(resourceContext);
OperationContext operationContext = new OperationContext(entityType, operation);
String impersonatedBy = ImpersonationContext.getImpersonatedBy();
if (operation == CREATE) {
CreateResourceContext<T> createResourceContext =
new CreateResourceContext<>(entityType, entity);
limits.enforceLimits(securityContext, createResourceContext, operationContext);
authorizer.authorizeRequests(securityContext, authRequests, authorizationLogic);
T createdEntity =
addHref(
uriInfo,
repository.create(
uriInfo, entity, securityContext.getUserPrincipal().getName(), impersonatedBy));
return new PutResponse<>(Response.Status.CREATED, createdEntity, ENTITY_CREATED).toResponse();
}
authorizer.authorizeRequests(securityContext, authRequests, authorizationLogic);
PutResponse<T> response =
repository.createOrUpdate(uriInfo, entity, securityContext.getUserPrincipal().getName());
addHref(uriInfo, response.getEntity());
return response.toResponse();
}
/** Deprecated: use method with changeContext
* Example:
* ```
* patchInternal(uriInfo, securityContext, id, patch, changeContext);
* ```
* */
@Deprecated
public Response patchInternal(
UriInfo uriInfo, SecurityContext securityContext, UUID id, JsonPatch patch) {
return patchInternal(uriInfo, securityContext, id, patch, null);
}
public Response patchInternal(
UriInfo uriInfo,
SecurityContext securityContext,
UUID id,
JsonPatch patch,
ChangeSource changeSource) {
// Get If-Match header from ThreadLocal set by ETagRequestFilter
String ifMatchHeader =
org.openmetadata.service.resources.filters.ETagRequestFilter.getIfMatchHeader();
return patchInternal(uriInfo, securityContext, id, patch, changeSource, ifMatchHeader);
}
public Response patchInternal(
UriInfo uriInfo,
SecurityContext securityContext,
UUID id,
JsonPatch patch,
ChangeSource changeSource,
String ifMatchHeader) {
OperationContext operationContext = new OperationContext(entityType, patch);
authorizer.authorize(
securityContext,
operationContext,
getResourceContextById(id, ResourceContextInterface.Operation.PATCH));
String impersonatedBy = ImpersonationContext.getImpersonatedBy();
PatchResponse<T> response =
repository.patch(
uriInfo,
id,
securityContext.getUserPrincipal().getName(),
patch,
changeSource,
ifMatchHeader,
impersonatedBy);
addHref(uriInfo, response.entity());
return response.toResponse();
}
public Response patchInternal(
UriInfo uriInfo,
SecurityContext securityContext,
List<AuthRequest> authRequests,
AuthorizationLogic authorizationLogic,
UUID id,
JsonPatch patch) {
authorizer.authorizeRequests(securityContext, authRequests, authorizationLogic);
PatchResponse<T> response =
repository.patch(uriInfo, id, securityContext.getUserPrincipal().getName(), patch);
addHref(uriInfo, response.entity());
return response.toResponse();
}
public Response patchInternal(
UriInfo uriInfo, SecurityContext securityContext, String fqn, JsonPatch patch) {
return patchInternal(uriInfo, securityContext, fqn, patch, null);
}
public Response patchInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String fqn,
JsonPatch patch,
ChangeSource changeSource) {
// Get If-Match header from ThreadLocal set by ETagRequestFilter
String ifMatchHeader =
org.openmetadata.service.resources.filters.ETagRequestFilter.getIfMatchHeader();
return patchInternal(uriInfo, securityContext, fqn, patch, changeSource, ifMatchHeader);
}
public Response patchInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String fqn,
JsonPatch patch,
ChangeSource changeSource,
String ifMatchHeader) {
OperationContext operationContext = new OperationContext(entityType, patch);
authorizer.authorize(
securityContext,
operationContext,
getResourceContextByName(fqn, ResourceContextInterface.Operation.PATCH));
String impersonatedBy = ImpersonationContext.getImpersonatedBy();
PatchResponse<T> response =
repository.patch(
uriInfo,
fqn,
securityContext.getUserPrincipal().getName(),
patch,
changeSource,
ifMatchHeader,
impersonatedBy);
addHref(uriInfo, response.entity());
return response.toResponse();
}
public Response delete(
UriInfo uriInfo,
SecurityContext securityContext,
UUID id,
boolean recursive,
boolean hardDelete) {
OperationContext operationContext = new OperationContext(entityType, MetadataOperation.DELETE);
authorizer.authorize(
securityContext,
operationContext,
getResourceContextById(id, ResourceContextInterface.Operation.DELETE));
DeleteResponse<T> response =
repository.delete(securityContext.getUserPrincipal().getName(), id, recursive, hardDelete);
if (hardDelete) {
limits.invalidateCache(entityType);
}
addHref(uriInfo, response.entity());
return response.toResponse();
}
public Response deleteByIdAsync(
UriInfo uriInfo,
SecurityContext securityContext,
UUID id,
boolean recursive,
boolean hardDelete) {
String jobId = UUID.randomUUID().toString();
T entity;
Response response;
OperationContext operationContext = new OperationContext(entityType, MetadataOperation.DELETE);
authorizer.authorize(
securityContext,
operationContext,
getResourceContextById(id, ResourceContextInterface.Operation.DELETE));
entity = repository.get(uriInfo, id, repository.getFields("name"), Include.ALL, false);
String userName = securityContext.getUserPrincipal().getName();
ExecutorService executorService = AsyncService.getInstance().getExecutorService();
executorService.submit(
RequestLatencyContext.wrapWithContext(
() -> {
try {
DeleteResponse<T> deleteResponse =
repository.delete(userName, id, recursive, hardDelete);
if (hardDelete) {
limits.invalidateCache(entityType);
}
WebsocketNotificationHandler.sendDeleteOperationCompleteNotification(
jobId, securityContext, deleteResponse.entity());
} catch (Exception e) {
WebsocketNotificationHandler.sendDeleteOperationFailedNotification(
jobId,
securityContext,
entity,
e.getMessage() == null ? e.toString() : e.getMessage());
}
}));
response =
Response.accepted()
.entity(
new DeleteEntityResponse(
jobId,
"Delete operation initiated for " + entity.getName(),
entity.getName(),
hardDelete,
recursive))
.build();
return response;
}
public Response deleteByName(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
boolean recursive,
boolean hardDelete) {
OperationContext operationContext = new OperationContext(entityType, MetadataOperation.DELETE);
authorizer.authorize(
securityContext,
operationContext,
getResourceContextByName(name, ResourceContextInterface.Operation.DELETE));
DeleteResponse<T> response =
repository.deleteByName(
securityContext.getUserPrincipal().getName(), name, recursive, hardDelete);
addHref(uriInfo, response.entity());
return response.toResponse();
}
public Response restoreEntity(UriInfo uriInfo, SecurityContext securityContext, UUID id) {
OperationContext operationContext =
new OperationContext(entityType, MetadataOperation.EDIT_ALL);
authorizer.authorize(securityContext, operationContext, getResourceContextById(id));
PutResponse<T> response =
repository.restoreEntity(securityContext.getUserPrincipal().getName(), id);
repository.restoreFromSearch(response.getEntity());
addHref(uriInfo, response.getEntity());
LOG.info(
"Restored {}:{}",
Entity.getEntityTypeFromObject(response.getEntity()),
response.getEntity().getId());
return response.toResponse();
}
public Response exportCsvInternalAsync(
SecurityContext securityContext, String name, boolean recursive) {
OperationContext operationContext =
new OperationContext(entityType, MetadataOperation.VIEW_ALL);
authorizer.authorize(securityContext, operationContext, getResourceContextByName(name));
String jobId = UUID.randomUUID().toString();
ExecutorService executorService = AsyncService.getInstance().getExecutorService();
executorService.submit(
RequestLatencyContext.wrapWithContext(
() -> {
try {
CsvExportProgressCallback progressCallback =
(exported, total, message) ->
WebsocketNotificationHandler.sendCsvExportProgressNotification(
jobId, securityContext, exported, total, message);
String csvData =
repository.exportToCsv(
name,
securityContext.getUserPrincipal().getName(),
recursive,
progressCallback);
WebsocketNotificationHandler.sendCsvExportCompleteNotification(
jobId, securityContext, csvData);
} catch (Exception e) {
LOG.error("Encountered Exception while exporting.", e);
WebsocketNotificationHandler.sendCsvExportFailedNotification(
jobId, securityContext, e.getMessage() == null ? e.toString() : e.getMessage());
}
}));
CSVExportResponse response = new CSVExportResponse(jobId, "Export initiated successfully.");
return Response.accepted().entity(response).type(MediaType.APPLICATION_JSON).build();
}
public Response bulkAddToAssetsAsync(
SecurityContext securityContext, UUID entityId, BulkAssetsRequestInterface request) {
SubjectContext subjectContext = getSubjectContext(securityContext);
String user = subjectContext.user().getName();
Set<String> editPermissibleResources =
authorizer.listPermissions(securityContext, user).stream()
.filter(
permission ->
permission.getPermissions().stream()
.anyMatch(
perm ->
MetadataOperation.EDIT_TAGS.equals(perm.getOperation())
&& Permission.Access.ALLOW.equals(perm.getAccess())))
.map(ResourcePermission::getResource)
.collect(Collectors.toSet());
// Validate if all entity types in the request are in the permissible resources
List<String> unauthorizedEntityTypes =
request.getAssets().stream()
.map(EntityReference::getType)
.filter(entityType -> !editPermissibleResources.contains(entityType))
.distinct()
.toList();
if (!unauthorizedEntityTypes.isEmpty()
&& !subjectContext.isAdmin()
&& !subjectContext.isBot()) {
throw new AuthorizationException(
CatalogExceptionMessage.resourcePermissionNotAllowed(
user, List.of(MetadataOperation.EDIT_TAGS), unauthorizedEntityTypes));
}
String jobId = UUID.randomUUID().toString();
ExecutorService executorService = AsyncService.getInstance().getExecutorService();
executorService.submit(
RequestLatencyContext.wrapWithContext(
() -> {
try {
BulkOperationResult result =
repository.bulkAddAndValidateTagsToAssets(entityId, request);
WebsocketNotificationHandler.bulkAssetsOperationCompleteNotification(
jobId, securityContext, result);
} catch (Exception e) {
WebsocketNotificationHandler.bulkAssetsOperationFailedNotification(
jobId, securityContext, e.getMessage() == null ? e.toString() : e.getMessage());
}
}));
BulkAssetsOperationResponse response =
new BulkAssetsOperationResponse(
jobId, "Bulk Add tags to Asset operation initiated successfully.");
return Response.ok().entity(response).type(MediaType.APPLICATION_JSON).build();
}
public Response bulkRemoveFromAssetsAsync(
SecurityContext securityContext, UUID entityId, BulkAssetsRequestInterface request) {
SubjectContext subjectContext = getSubjectContext(securityContext);
String user = subjectContext.user().getName();
Set<String> editPermissibleResources =
authorizer.listPermissions(securityContext, user).stream()
.filter(
permission ->
permission.getPermissions().stream()
.anyMatch(
perm ->
MetadataOperation.EDIT_TAGS.equals(perm.getOperation())
&& Permission.Access.ALLOW.equals(perm.getAccess())))
.map(ResourcePermission::getResource)
.collect(Collectors.toSet());
List<String> unauthorizedEntityTypes =
request.getAssets().stream()
.map(EntityReference::getType)
.filter(entityType -> !editPermissibleResources.contains(entityType))
.distinct()
.toList();
if (!unauthorizedEntityTypes.isEmpty()
&& !subjectContext.isAdmin()
&& !subjectContext.isBot()) {
throw new AuthorizationException(
CatalogExceptionMessage.resourcePermissionNotAllowed(
user, List.of(MetadataOperation.EDIT_TAGS), unauthorizedEntityTypes));
}
String jobId = UUID.randomUUID().toString();
ExecutorService executorService = AsyncService.getInstance().getExecutorService();
executorService.submit(
RequestLatencyContext.wrapWithContext(
() -> {
try {
BulkOperationResult result =
repository.bulkRemoveAndValidateTagsToAssets(entityId, request);
WebsocketNotificationHandler.bulkAssetsOperationCompleteNotification(
jobId, securityContext, result);
} catch (Exception e) {
WebsocketNotificationHandler.bulkAssetsOperationFailedNotification(
jobId, securityContext, e.getMessage() == null ? e.toString() : e.getMessage());
}
}));
BulkAssetsOperationResponse response =
new BulkAssetsOperationResponse(
jobId, "Bulk Remove tags to Asset operation initiated successfully.");
return Response.ok().entity(response).type(MediaType.APPLICATION_JSON).build();
}
public Response importCsvInternalAsync(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
String csv,
boolean dryRun,
boolean recursive) {
return importCsvInternalAsync(uriInfo, securityContext, name, csv, dryRun, recursive, null);
}
public Response importCsvInternalAsync(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
String csv,
boolean dryRun,
boolean recursive,
String versioningEntityType) {
OperationContext operationContext =
new OperationContext(entityType, MetadataOperation.EDIT_ALL);
authorizer.authorize(securityContext, operationContext, getResourceContextByName(name));
String jobId = UUID.randomUUID().toString();
CSVImportResponse responseEntity = new CSVImportResponse(jobId, "Import is in progress.");
Response response =
Response.ok().entity(responseEntity).type(MediaType.APPLICATION_JSON).build();
ExecutorService executorService = AsyncService.getInstance().getExecutorService();
executorService.submit(
RequestLatencyContext.wrapWithContext(
() -> {
try {
WebsocketNotificationHandler.sendCsvImportStartedNotification(
jobId, securityContext);
CsvImportProgressCallback progressCallback =
(rowsProcessed, totalRows, batchNumber, message) ->
WebsocketNotificationHandler.sendCsvImportProgressNotification(
jobId, securityContext, rowsProcessed, totalRows, message);
CsvImportResult result =
importCsvInternal(
uriInfo,
securityContext,
name,
csv,
dryRun,
recursive,
versioningEntityType,
progressCallback);
WebsocketNotificationHandler.sendCsvImportCompleteNotification(
jobId, securityContext, result);
} catch (Exception e) {
LOG.error("Encountered Exception while importing.", e);
WebsocketNotificationHandler.sendCsvImportFailedNotification(
jobId, securityContext, e.getMessage() == null ? e.toString() : e.getMessage());
}
}));
return response;
}
public String exportCsvInternal(SecurityContext securityContext, String name, boolean recursive)
throws IOException {
OperationContext operationContext =
new OperationContext(entityType, MetadataOperation.VIEW_ALL);
authorizer.authorize(securityContext, operationContext, getResourceContextByName(name));
return repository.exportToCsv(name, securityContext.getUserPrincipal().getName(), recursive);
}
protected CsvImportResult importCsvInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
String csv,
boolean dryRun,
boolean recursive)
throws IOException {
return importCsvInternal(uriInfo, securityContext, name, csv, dryRun, recursive, null);
}
protected CsvImportResult importCsvInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
String csv,
boolean dryRun,
boolean recursive,
String versioningEntityType)
throws IOException {
return importCsvInternal(
uriInfo, securityContext, name, csv, dryRun, recursive, versioningEntityType, null);
}
protected CsvImportResult importCsvInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
String csv,