-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added relationships APIs to V3. Added these generic APIs to V3 swagge…
…r doc. (#10939)
- Loading branch information
1 parent
a7ae99c
commit 8266b02
Showing
5 changed files
with
285 additions
and
224 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
221 changes: 221 additions & 0 deletions
221
...let/src/main/java/io/datahubproject/openapi/controller/GenericRelationshipController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| package io.datahubproject.openapi.controller; | ||
|
|
||
| import static com.linkedin.metadata.authorization.ApiGroup.RELATIONSHIP; | ||
| import static com.linkedin.metadata.authorization.ApiOperation.READ; | ||
|
|
||
| import com.datahub.authentication.Authentication; | ||
| import com.datahub.authentication.AuthenticationContext; | ||
| import com.datahub.authorization.AuthUtil; | ||
| import com.datahub.authorization.AuthorizerChain; | ||
| import com.linkedin.common.urn.Urn; | ||
| import com.linkedin.common.urn.UrnUtils; | ||
| import com.linkedin.metadata.aspect.models.graph.Edge; | ||
| import com.linkedin.metadata.aspect.models.graph.RelatedEntities; | ||
| import com.linkedin.metadata.aspect.models.graph.RelatedEntitiesScrollResult; | ||
| import com.linkedin.metadata.graph.elastic.ElasticSearchGraphService; | ||
| import com.linkedin.metadata.models.registry.EntityRegistry; | ||
| import com.linkedin.metadata.query.filter.RelationshipDirection; | ||
| import com.linkedin.metadata.query.filter.RelationshipFilter; | ||
| import com.linkedin.metadata.search.utils.QueryUtils; | ||
| import io.datahubproject.openapi.exception.UnauthorizedException; | ||
| import io.datahubproject.openapi.models.GenericScrollResult; | ||
| import io.datahubproject.openapi.v2.models.GenericRelationship; | ||
| import io.swagger.v3.oas.annotations.Operation; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.http.MediaType; | ||
| import org.springframework.http.ResponseEntity; | ||
| import org.springframework.web.bind.annotation.*; | ||
|
|
||
| public abstract class GenericRelationshipController { | ||
|
|
||
| @Autowired private EntityRegistry entityRegistry; | ||
| @Autowired private ElasticSearchGraphService graphService; | ||
| @Autowired private AuthorizerChain authorizationChain; | ||
|
|
||
| /** | ||
| * Returns relationship edges by type | ||
| * | ||
| * @param relationshipType the relationship type | ||
| * @param count number of results | ||
| * @param scrollId scrolling id | ||
| * @return list of relation edges | ||
| */ | ||
| @GetMapping(value = "/{relationshipType}", produces = MediaType.APPLICATION_JSON_VALUE) | ||
| @Operation(summary = "Scroll relationships of the given type.") | ||
| public ResponseEntity<GenericScrollResult<GenericRelationship>> getRelationshipsByType( | ||
| @PathVariable("relationshipType") String relationshipType, | ||
| @RequestParam(value = "count", defaultValue = "10") Integer count, | ||
| @RequestParam(value = "scrollId", required = false) String scrollId) { | ||
|
|
||
| Authentication authentication = AuthenticationContext.getAuthentication(); | ||
| if (!AuthUtil.isAPIAuthorized(authentication, authorizationChain, RELATIONSHIP, READ)) { | ||
| throw new UnauthorizedException( | ||
| authentication.getActor().toUrnStr() | ||
| + " is unauthorized to " | ||
| + READ | ||
| + " " | ||
| + RELATIONSHIP); | ||
| } | ||
|
|
||
| RelatedEntitiesScrollResult result = | ||
| graphService.scrollRelatedEntities( | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| List.of(relationshipType), | ||
| new RelationshipFilter().setDirection(RelationshipDirection.UNDIRECTED), | ||
| Edge.EDGE_SORT_CRITERION, | ||
| scrollId, | ||
| count, | ||
| null, | ||
| null); | ||
|
|
||
| if (!AuthUtil.isAPIAuthorizedUrns( | ||
| authentication, | ||
| authorizationChain, | ||
| RELATIONSHIP, | ||
| READ, | ||
| result.getEntities().stream() | ||
| .flatMap( | ||
| edge -> | ||
| Stream.of( | ||
| UrnUtils.getUrn(edge.getSourceUrn()), | ||
| UrnUtils.getUrn(edge.getDestinationUrn()))) | ||
| .collect(Collectors.toSet()))) { | ||
| throw new UnauthorizedException( | ||
| authentication.getActor().toUrnStr() | ||
| + " is unauthorized to " | ||
| + READ | ||
| + " " | ||
| + RELATIONSHIP); | ||
| } | ||
|
|
||
| return ResponseEntity.ok( | ||
| GenericScrollResult.<GenericRelationship>builder() | ||
| .results(toGenericRelationships(result.getEntities())) | ||
| .scrollId(result.getScrollId()) | ||
| .build()); | ||
| } | ||
|
|
||
| /** | ||
| * Returns edges for a given urn | ||
| * | ||
| * @param relationshipTypes types of edges | ||
| * @param direction direction of the edges | ||
| * @param count number of results | ||
| * @param scrollId scroll id | ||
| * @return urn edges | ||
| */ | ||
| @GetMapping(value = "/{entityName}/{entityUrn}", produces = MediaType.APPLICATION_JSON_VALUE) | ||
| @Operation(summary = "Scroll relationships from a given entity.") | ||
| public ResponseEntity<GenericScrollResult<GenericRelationship>> getRelationshipsByEntity( | ||
| @PathVariable("entityName") String entityName, | ||
| @PathVariable("entityUrn") String entityUrn, | ||
| @RequestParam(value = "relationshipType[]", required = false, defaultValue = "*") | ||
| String[] relationshipTypes, | ||
| @RequestParam(value = "direction", defaultValue = "OUTGOING") String direction, | ||
| @RequestParam(value = "count", defaultValue = "10") Integer count, | ||
| @RequestParam(value = "scrollId", required = false) String scrollId) { | ||
|
|
||
| final RelatedEntitiesScrollResult result; | ||
|
|
||
| Authentication authentication = AuthenticationContext.getAuthentication(); | ||
| if (!AuthUtil.isAPIAuthorizedUrns( | ||
| authentication, | ||
| authorizationChain, | ||
| RELATIONSHIP, | ||
| READ, | ||
| List.of(UrnUtils.getUrn(entityUrn)))) { | ||
| throw new UnauthorizedException( | ||
| authentication.getActor().toUrnStr() | ||
| + " is unauthorized to " | ||
| + READ | ||
| + " " | ||
| + RELATIONSHIP); | ||
| } | ||
|
|
||
| switch (RelationshipDirection.valueOf(direction.toUpperCase())) { | ||
| case INCOMING -> result = | ||
| graphService.scrollRelatedEntities( | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| relationshipTypes.length > 0 && !relationshipTypes[0].equals("*") | ||
| ? Arrays.stream(relationshipTypes).toList() | ||
| : List.of(), | ||
| new RelationshipFilter() | ||
| .setDirection(RelationshipDirection.UNDIRECTED) | ||
| .setOr(QueryUtils.newFilter("destination.urn", entityUrn).getOr()), | ||
| Edge.EDGE_SORT_CRITERION, | ||
| scrollId, | ||
| count, | ||
| null, | ||
| null); | ||
| case OUTGOING -> result = | ||
| graphService.scrollRelatedEntities( | ||
| null, | ||
| null, | ||
| null, | ||
| null, | ||
| relationshipTypes.length > 0 && !relationshipTypes[0].equals("*") | ||
| ? Arrays.stream(relationshipTypes).toList() | ||
| : List.of(), | ||
| new RelationshipFilter() | ||
| .setDirection(RelationshipDirection.UNDIRECTED) | ||
| .setOr(QueryUtils.newFilter("source.urn", entityUrn).getOr()), | ||
| Edge.EDGE_SORT_CRITERION, | ||
| scrollId, | ||
| count, | ||
| null, | ||
| null); | ||
| default -> throw new IllegalArgumentException("Direction must be INCOMING or OUTGOING"); | ||
| } | ||
|
|
||
| if (!AuthUtil.isAPIAuthorizedUrns( | ||
| authentication, | ||
| authorizationChain, | ||
| RELATIONSHIP, | ||
| READ, | ||
| result.getEntities().stream() | ||
| .flatMap( | ||
| edge -> | ||
| Stream.of( | ||
| UrnUtils.getUrn(edge.getSourceUrn()), | ||
| UrnUtils.getUrn(edge.getDestinationUrn()))) | ||
| .collect(Collectors.toSet()))) { | ||
| throw new UnauthorizedException( | ||
| authentication.getActor().toUrnStr() | ||
| + " is unauthorized to " | ||
| + READ | ||
| + " " | ||
| + RELATIONSHIP); | ||
| } | ||
|
|
||
| return ResponseEntity.ok( | ||
| GenericScrollResult.<GenericRelationship>builder() | ||
| .results(toGenericRelationships(result.getEntities())) | ||
| .scrollId(result.getScrollId()) | ||
| .build()); | ||
| } | ||
|
|
||
| private List<GenericRelationship> toGenericRelationships(List<RelatedEntities> relatedEntities) { | ||
| return relatedEntities.stream() | ||
| .map( | ||
| result -> { | ||
| Urn source = UrnUtils.getUrn(result.getSourceUrn()); | ||
| Urn dest = UrnUtils.getUrn(result.getDestinationUrn()); | ||
| return GenericRelationship.builder() | ||
| .relationshipType(result.getRelationshipType()) | ||
| .source(GenericRelationship.GenericNode.fromUrn(source)) | ||
| .destination(GenericRelationship.GenericNode.fromUrn(dest)) | ||
| .build(); | ||
| }) | ||
| .collect(Collectors.toList()); | ||
| } | ||
| } |
Oops, something went wrong.