Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.openmetadata.service.resources.EntityResource Maven / Gradle / Ivy
/*
* 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.util.EntityUtil.createOrUpdateOperation;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import java.util.UUID;
import javax.json.JsonPatch;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.SecurityContext;
import javax.ws.rs.core.UriInfo;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.openmetadata.schema.EntityInterface;
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.csv.CsvImportResult;
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.search.SearchListFilter;
import org.openmetadata.service.search.SearchSortFilter;
import org.openmetadata.service.security.Authorizer;
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.util.EntityUtil;
import org.openmetadata.service.util.EntityUtil.Fields;
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.ResultList;
@Slf4j
public abstract class EntityResource> {
protected final Class entityClass;
protected final String entityType;
protected final Set allowedFields;
@Getter protected final K repository;
protected final Authorizer authorizer;
protected final Limits limits;
protected final Map fieldsToViewOperations = new HashMap<>();
protected EntityResource(String entityType, Authorizer authorizer, Limits limits) {
this.entityType = entityType;
this.repository = (K) Entity.getEntityRepository(entityType);
this.entityClass = (Class) Entity.getEntityClassFromType(entityType);
allowedFields = repository.getAllowedFields();
this.authorizer = authorizer;
this.limits = limits;
addViewOperation(
"owners,followers,votes,tags,extension,domain,dataProducts,experts", VIEW_BASIC);
Entity.registerResourcePermissions(entityType, getEntitySpecificOperations());
}
/** 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) {
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.getDomain());
Entity.withHref(uriInfo, entity.getDataProducts());
return entity;
}
protected List getEntitySpecificOperations() {
return null;
}
public final ResultList addHref(UriInfo uriInfo, ResultList list) {
listOrEmpty(list.getData()).forEach(i -> addHref(uriInfo, i));
return list;
}
public ResultList 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));
return listInternal(
uriInfo,
securityContext,
fields,
filter,
limitParam,
before,
after,
listOperationContext,
getResourceContext());
}
public ResultList 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);
// List
ResultList 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 listInternalFromSearch(
UriInfo uriInfo,
SecurityContext securityContext,
Fields fields,
SearchListFilter searchListFilter,
int limit,
int offset,
SearchSortFilter searchSortFilter,
String q,
OperationContext operationContext,
ResourceContextInterface resourceContext)
throws IOException {
authorizer.authorize(securityContext, operationContext, resourceContext);
return repository.listFromSearchWithOffset(
uriInfo, fields, searchListFilter, limit, offset, searchSortFilter, q);
}
public T getInternal(
UriInfo uriInfo,
SecurityContext securityContext,
UUID id,
String fieldsParam,
Include include) {
Fields fields = getFields(fieldsParam);
OperationContext operationContext = new OperationContext(entityType, getViewOperations(fields));
return getInternal(
uriInfo,
securityContext,
id,
fields,
include,
operationContext,
getResourceContextById(id));
}
public T getInternal(
UriInfo uriInfo,
SecurityContext securityContext,
UUID id,
Fields fields,
Include include,
OperationContext operationContext,
ResourceContextInterface resourceContext) {
authorizer.authorize(securityContext, operationContext, resourceContext);
return addHref(uriInfo, repository.get(uriInfo, id, fields, include, false));
}
public T getVersionInternal(SecurityContext securityContext, UUID id, String version) {
OperationContext operationContext =
new OperationContext(entityType, MetadataOperation.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, MetadataOperation.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);
}
public T getByNameInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
String fieldsParam,
Include include) {
Fields fields = getFields(fieldsParam);
OperationContext operationContext = new OperationContext(entityType, getViewOperations(fields));
return getByNameInternal(
uriInfo,
securityContext,
name,
fields,
include,
operationContext,
getResourceContextByName(name));
}
public T getByNameInternal(
UriInfo uriInfo,
SecurityContext securityContext,
String name,
Fields fields,
Include include,
OperationContext operationContext,
ResourceContextInterface resourceContext) {
authorizer.authorize(securityContext, operationContext, resourceContext);
return addHref(uriInfo, repository.getByName(uriInfo, name, fields, include, false));
}
public Response create(UriInfo uriInfo, SecurityContext securityContext, T entity) {
OperationContext operationContext = new OperationContext(entityType, CREATE);
CreateResourceContext createResourceContext =
new CreateResourceContext<>(entityType, entity);
limits.enforceLimits(securityContext, createResourceContext, operationContext);
authorizer.authorize(securityContext, operationContext, createResourceContext);
entity = addHref(uriInfo, repository.create(uriInfo, entity));
return Response.created(entity.getHref()).entity(entity).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 resourceContext = getResourceContextByName(entity.getFullyQualifiedName());
MetadataOperation operation = createOrUpdateOperation(resourceContext);
OperationContext operationContext = new OperationContext(entityType, operation);
if (operation == CREATE) {
CreateResourceContext createResourceContext =
new CreateResourceContext<>(entityType, entity);
limits.enforceLimits(securityContext, createResourceContext, operationContext);
authorizer.authorize(securityContext, operationContext, createResourceContext);
entity = addHref(uriInfo, repository.create(uriInfo, entity));
return new PutResponse<>(Response.Status.CREATED, entity, ENTITY_CREATED).toResponse();
}
authorizer.authorize(securityContext, operationContext, resourceContext);
PutResponse response = repository.createOrUpdate(uriInfo, entity);
addHref(uriInfo, response.getEntity());
return response.toResponse();
}
public Response patchInternal(
UriInfo uriInfo, SecurityContext securityContext, UUID id, JsonPatch patch) {
OperationContext operationContext = new OperationContext(entityType, patch);
authorizer.authorize(securityContext, operationContext, getResourceContextById(id));
PatchResponse 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) {
OperationContext operationContext = new OperationContext(entityType, patch);
authorizer.authorize(securityContext, operationContext, getResourceContextByName(fqn));
PatchResponse response =
repository.patch(uriInfo, fqn, securityContext.getUserPrincipal().getName(), patch);
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));
DeleteResponse response =
repository.delete(securityContext.getUserPrincipal().getName(), id, recursive, hardDelete);
repository.deleteFromSearch(response.entity(), response.changeType());
if (hardDelete) {
limits.invalidateCache(entityType);
}
addHref(uriInfo, response.entity());
return response.toResponse();
}
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));
DeleteResponse response =
repository.deleteByName(
securityContext.getUserPrincipal().getName(), name, recursive, hardDelete);
repository.deleteFromSearch(response.entity(), response.changeType());
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 response =
repository.restoreEntity(securityContext.getUserPrincipal().getName(), entityType, id);
repository.restoreFromSearch(response.getEntity());
addHref(uriInfo, response.getEntity());
LOG.info(
"Restored {}:{}",
Entity.getEntityTypeFromObject(response.getEntity()),
response.getEntity().getId());
return response.toResponse();
}
public String exportCsvInternal(SecurityContext securityContext, String name) throws IOException {
OperationContext operationContext =
new OperationContext(entityType, MetadataOperation.VIEW_ALL);
authorizer.authorize(securityContext, operationContext, getResourceContextByName(name));
return repository.exportToCsv(name, securityContext.getUserPrincipal().getName());
}
protected CsvImportResult importCsvInternal(
SecurityContext securityContext, String name, String csv, boolean dryRun) throws IOException {
OperationContext operationContext =
new OperationContext(entityType, MetadataOperation.EDIT_ALL);
authorizer.authorize(securityContext, operationContext, getResourceContextByName(name));
return repository.importFromCsv(
name, csv, dryRun, securityContext.getUserPrincipal().getName());
}
protected ResourceContext getResourceContext() {
return new ResourceContext<>(entityType);
}
protected ResourceContext getResourceContextById(UUID id) {
return new ResourceContext<>(entityType, id, null);
}
protected ResourceContext getResourceContextByName(String name) {
return new ResourceContext<>(entityType, null, name);
}
protected static final MetadataOperation[] VIEW_ALL_OPERATIONS = {MetadataOperation.VIEW_ALL};
protected static final MetadataOperation[] VIEW_BASIC_OPERATIONS = {MetadataOperation.VIEW_BASIC};
private MetadataOperation[] getViewOperations(Fields fields) {
if (fields.getFieldList().isEmpty()) {
return VIEW_BASIC_OPERATIONS;
}
Set viewOperations = new TreeSet<>();
for (String field : fields.getFieldList()) {
MetadataOperation operation = fieldsToViewOperations.get(field);
if (operation == null) {
return VIEW_ALL_OPERATIONS;
}
viewOperations.add(operation);
}
return viewOperations.toArray(new MetadataOperation[0]);
}
protected EntityReference getEntityReference(String entityType, String fqn) {
return EntityUtil.getEntityReference(entityType, fqn);
}
protected static List getEntityReferences(String entityType, List fqns) {
if (nullOrEmpty(fqns)) {
return null;
}
return EntityUtil.getEntityReferences(entityType, fqns);
}
protected void addViewOperation(String fieldsParam, MetadataOperation operation) {
String[] fields = fieldsParam.replace(" ", "").split(",");
for (String field : fields) {
if (allowedFields.contains(field)) {
fieldsToViewOperations.put(field, operation);
} else if (!"owners,followers,votes,tags,extension,domain,dataProducts,experts"
.contains(field)) {
// Some common fields for all the entities might be missing. Ignore it.
throw new IllegalArgumentException(CatalogExceptionMessage.invalidField(field));
}
}
}
}
