-
Notifications
You must be signed in to change notification settings - Fork 143
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[HWORKS-1104] Explicit storage connector provenance (#1524)
- Loading branch information
Showing
16 changed files
with
283 additions
and
15 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
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
121 changes: 121 additions & 0 deletions
121
...pi/src/main/java/io/hops/hopsworks/api/provenance/StorageConnectorProvenanceResource.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,121 @@ | ||
| /* | ||
| * This file is part of Hopsworks | ||
| * Copyright (C) 2024, Hopsworks AB. All rights reserved | ||
| * | ||
| * Hopsworks is free software: you can redistribute it and/or modify it under the terms of | ||
| * the GNU Affero General Public License as published by the Free Software Foundation, | ||
| * either version 3 of the License, or (at your option) any later version. | ||
| * | ||
| * Hopsworks is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; | ||
| * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR | ||
| * PURPOSE. See the GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License along with this program. | ||
| * If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
| package io.hops.hopsworks.api.provenance; | ||
|
|
||
| import io.hops.hopsworks.api.auth.key.ApiKeyRequired; | ||
| import io.hops.hopsworks.api.filter.AllowedProjectRoles; | ||
| import io.hops.hopsworks.api.filter.Audience; | ||
| import io.hops.hopsworks.api.jwt.JWTHelper; | ||
| import io.hops.hopsworks.api.provenance.explicit.ExplicitProvenanceExpansionBeanParam; | ||
| import io.hops.hopsworks.api.provenance.explicit.ProvExplicitLinksBuilder; | ||
| import io.hops.hopsworks.api.provenance.explicit.dto.ProvExplicitLinkDTO; | ||
| import io.hops.hopsworks.api.provenance.ops.ProvLinksBeanParams; | ||
| import io.hops.hopsworks.common.api.ResourceRequest; | ||
| import io.hops.hopsworks.common.featurestore.storageconnectors.FeaturestoreStorageConnectorController; | ||
| import io.hops.hopsworks.common.provenance.explicit.ProvExplicitControllerIface; | ||
| import io.hops.hopsworks.common.provenance.explicit.ProvExplicitLink; | ||
| import io.hops.hopsworks.common.provenance.ops.dto.ProvLinksDTO; | ||
| import io.hops.hopsworks.exceptions.DatasetException; | ||
| import io.hops.hopsworks.exceptions.FeatureStoreMetadataException; | ||
| import io.hops.hopsworks.exceptions.FeaturestoreException; | ||
| import io.hops.hopsworks.exceptions.GenericException; | ||
| import io.hops.hopsworks.exceptions.MetadataException; | ||
| import io.hops.hopsworks.exceptions.ModelRegistryException; | ||
| import io.hops.hopsworks.exceptions.ServiceException; | ||
| import io.hops.hopsworks.jwt.annotation.JWTRequired; | ||
| import io.hops.hopsworks.persistence.entity.featurestore.Featurestore; | ||
| import io.hops.hopsworks.persistence.entity.featurestore.storageconnector.FeaturestoreConnector; | ||
| import io.hops.hopsworks.persistence.entity.project.Project; | ||
| import io.hops.hopsworks.persistence.entity.user.Users; | ||
| import io.hops.hopsworks.persistence.entity.user.security.apiKey.ApiScope; | ||
| import io.swagger.annotations.Api; | ||
| import io.swagger.annotations.ApiOperation; | ||
|
|
||
| import javax.ejb.EJB; | ||
| import javax.ejb.TransactionAttribute; | ||
| import javax.ejb.TransactionAttributeType; | ||
| import javax.enterprise.context.RequestScoped; | ||
| import javax.inject.Inject; | ||
| import javax.servlet.http.HttpServletRequest; | ||
| import javax.ws.rs.BeanParam; | ||
| import javax.ws.rs.GET; | ||
| import javax.ws.rs.Path; | ||
| import javax.ws.rs.Produces; | ||
| import javax.ws.rs.core.Context; | ||
| import javax.ws.rs.core.MediaType; | ||
| import javax.ws.rs.core.Response; | ||
| import javax.ws.rs.core.SecurityContext; | ||
| import javax.ws.rs.core.UriInfo; | ||
| import java.io.IOException; | ||
|
|
||
| @RequestScoped | ||
| @TransactionAttribute(TransactionAttributeType.NEVER) | ||
| @Api(value = "Storage Connector Explicit Provenance Resource") | ||
| public class StorageConnectorProvenanceResource { | ||
| @EJB | ||
| private JWTHelper jwtHelper; | ||
| @Inject | ||
| private ProvExplicitControllerIface provCtrl; | ||
| @EJB | ||
| private ProvExplicitLinksBuilder linksBuilder; | ||
| @EJB | ||
| private FeaturestoreStorageConnectorController storageConnectorController; | ||
| private Project project; | ||
| private Featurestore featureStore; | ||
| private String connectorName; | ||
|
|
||
| public void setProject(Project project) { | ||
| this.project = project; | ||
| } | ||
|
|
||
| public void setFeatureStore(Featurestore featureStore) { | ||
| this.featureStore = featureStore; | ||
| } | ||
|
|
||
| public void setConnectorName(String connectorName) { | ||
| this.connectorName = connectorName; | ||
| } | ||
|
|
||
| @GET | ||
| @Path("links") | ||
| @Produces(MediaType.APPLICATION_JSON) | ||
| @AllowedProjectRoles({AllowedProjectRoles.DATA_SCIENTIST, AllowedProjectRoles.DATA_OWNER}) | ||
| @JWTRequired(acceptedTokens = {Audience.API, Audience.JOB}, | ||
| allowedUserRoles = {"HOPS_ADMIN", "HOPS_USER", "HOPS_SERVICE_USER"}) | ||
| @ApiKeyRequired(acceptedScopes = {ApiScope.MODELREGISTRY}, | ||
| allowedUserRoles = {"HOPS_ADMIN", "HOPS_USER", "HOPS_SERVICE_USER"}) | ||
| @ApiOperation(value = "Links Provenance query endpoint", | ||
| response = ProvLinksDTO.class) | ||
| public Response getLinks( | ||
| @BeanParam ProvLinksBeanParams params, | ||
| @BeanParam LinksPagination pagination, | ||
| @BeanParam ExplicitProvenanceExpansionBeanParam explicitProvenanceExpansionBeanParam, | ||
| @Context UriInfo uriInfo, | ||
| @Context HttpServletRequest req, | ||
| @Context SecurityContext sc) | ||
| throws GenericException, FeaturestoreException, DatasetException, ServiceException, MetadataException, | ||
| FeatureStoreMetadataException, IOException, ModelRegistryException { | ||
| Users user = jwtHelper.getUserPrincipal(sc); | ||
| ResourceRequest resourceRequest = new ResourceRequest(ResourceRequest.Name.PROVENANCE); | ||
| resourceRequest.setExpansions(explicitProvenanceExpansionBeanParam.getResources()); | ||
| FeaturestoreConnector connector = | ||
| storageConnectorController.getConnectorWithName(user, project, featureStore, connectorName); | ||
| ProvExplicitLink<FeaturestoreConnector> provenance = provCtrl.storageConnectorLinks(project, connector, | ||
| pagination.getUpstreamLvls(), pagination.getDownstreamLvls()); | ||
| ProvExplicitLinkDTO<?> result = linksBuilder.build(uriInfo, resourceRequest, project, user, provenance); | ||
| return Response.ok().entity(result).build(); | ||
| } | ||
| } |
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
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
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
Oops, something went wrong.