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.system.SystemResource Maven / Gradle / Ivy
package org.openmetadata.service.resources.system;
import static org.openmetadata.common.utils.CommonUtil.nullOrEmpty;
import freemarker.template.TemplateException;
import io.swagger.v3.oas.annotations.ExternalDocumentation;
import io.swagger.v3.oas.annotations.Hidden;
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.ExampleObject;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import java.io.IOException;
import javax.json.JsonPatch;
import javax.validation.Valid;
import javax.ws.rs.Consumes;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.PATCH;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
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 lombok.extern.slf4j.Slf4j;
import org.openmetadata.schema.auth.EmailRequest;
import org.openmetadata.schema.settings.Settings;
import org.openmetadata.schema.settings.SettingsType;
import org.openmetadata.schema.system.ValidationResponse;
import org.openmetadata.schema.type.Include;
import org.openmetadata.schema.util.EntitiesCount;
import org.openmetadata.schema.util.ServicesCount;
import org.openmetadata.sdk.PipelineServiceClient;
import org.openmetadata.service.Entity;
import org.openmetadata.service.OpenMetadataApplicationConfig;
import org.openmetadata.service.clients.pipeline.PipelineServiceClientFactory;
import org.openmetadata.service.exception.UnhandledServerException;
import org.openmetadata.service.jdbi3.ListFilter;
import org.openmetadata.service.jdbi3.SystemRepository;
import org.openmetadata.service.resources.Collection;
import org.openmetadata.service.security.Authorizer;
import org.openmetadata.service.security.JwtFilter;
import org.openmetadata.service.util.EmailUtil;
import org.openmetadata.service.util.ResultList;
@Path("/v1/system")
@Tag(name = "System", description = "APIs related to System configuration and settings.")
@Hidden
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Collection(name = "system")
@Slf4j
public class SystemResource {
public static final String COLLECTION_PATH = "/v1/system";
private final SystemRepository systemRepository;
private final Authorizer authorizer;
private OpenMetadataApplicationConfig applicationConfig;
private PipelineServiceClient pipelineServiceClient;
private JwtFilter jwtFilter;
public SystemResource(Authorizer authorizer) {
this.systemRepository = Entity.getSystemRepository();
this.authorizer = authorizer;
}
public void initialize(OpenMetadataApplicationConfig config) {
this.applicationConfig = config;
this.pipelineServiceClient =
PipelineServiceClientFactory.createPipelineServiceClient(
config.getPipelineServiceClientConfiguration());
this.jwtFilter =
new JwtFilter(config.getAuthenticationConfiguration(), config.getAuthorizerConfiguration());
}
public static class SettingsList extends ResultList {
/* Required for serde */
}
@GET
@Path("/settings")
@Operation(
operationId = "listSettings",
summary = "List all settings",
description = "Get a list of all OpenMetadata settings",
responses = {
@ApiResponse(
responseCode = "200",
description = "List of Settings",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = SettingsList.class)))
})
public ResultList list(
@Context UriInfo uriInfo, @Context SecurityContext securityContext) {
authorizer.authorizeAdmin(securityContext);
return systemRepository.listAllConfigs();
}
@GET
@Path("/settings/{name}")
@Operation(
operationId = "getSetting",
summary = "Get a setting",
description = "Get a OpenMetadata Settings",
responses = {
@ApiResponse(
responseCode = "200",
description = "Settings",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Settings.class)))
})
public Settings getSettingByName(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Name of the setting", schema = @Schema(type = "string"))
@PathParam("name")
String name) {
authorizer.authorizeAdmin(securityContext);
return systemRepository.getConfigWithKey(name);
}
@GET
@Path("/settings/profilerConfiguration")
@Operation(
operationId = "getProfilerConfigurationSetting",
summary = "Get profiler configuration setting",
description = "Get a profiler configuration Settings",
responses = {
@ApiResponse(
responseCode = "200",
description = "Settings",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Settings.class)))
})
public Settings getProfilerConfigurationSetting(
@Context UriInfo uriInfo, @Context SecurityContext securityContext) {
authorizer.authorizeAdminOrBot(securityContext);
return systemRepository.getConfigWithKey(SettingsType.PROFILER_CONFIGURATION.value());
}
@PUT
@Path("/settings")
@Operation(
operationId = "createOrUpdate",
summary = "Update setting",
description = "Update existing settings",
responses = {
@ApiResponse(
responseCode = "200",
description = "Settings",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Settings.class)))
})
public Response createOrUpdateSetting(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Valid Settings settingName) {
authorizer.authorizeAdmin(securityContext);
return systemRepository.createOrUpdate(settingName);
}
@PUT
@Path("/email/test")
@Operation(
operationId = "sendTestEmail",
summary = "Sends a Test Email",
description = "Sends a Test Email with Provided Settings",
responses = {
@ApiResponse(
responseCode = "200",
description = "EmailTest",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = String.class)))
})
public Response sendTestEmail(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Valid EmailRequest emailRequest)
throws TemplateException, IOException {
if (nullOrEmpty(emailRequest.getEmail())) {
throw new IllegalArgumentException("Email address is required.");
}
authorizer.authorizeAdmin(securityContext);
try {
EmailUtil.testConnection();
EmailUtil.sendTestEmail(emailRequest.getEmail(), false);
} catch (Exception ex) {
LOG.error("Failed in sending mail. Message: {}", ex.getMessage(), ex);
throw new UnhandledServerException(ex.getMessage());
}
return Response.status(Response.Status.OK).entity("Test Email Sent Successfully.").build();
}
@PATCH
@Path("/settings/{settingName}")
@Operation(
operationId = "patchSetting",
summary = "Patch a setting",
description = "Update an existing Setting using JsonPatch.",
externalDocs =
@ExternalDocumentation(
description = "JsonPatch RFC",
url = "https://tools.ietf.org/html/rfc6902"))
@Consumes(MediaType.APPLICATION_JSON_PATCH_JSON)
public Response patch(
@Context UriInfo uriInfo,
@Context SecurityContext securityContext,
@Parameter(description = "Key of the Setting", schema = @Schema(type = "string"))
@PathParam("settingName")
String settingName,
@RequestBody(
description = "JsonPatch with array of operations",
content =
@Content(
mediaType = MediaType.APPLICATION_JSON_PATCH_JSON,
examples = {
@ExampleObject("[{op:remove, path:/a},{op:add, path: /b, value: val}]")
}))
JsonPatch patch) {
authorizer.authorizeAdmin(securityContext);
return systemRepository.patchSetting(settingName, patch);
}
@PUT
@Path("/restore/default/email")
@Operation(
operationId = "restoreEmailSettingToDefault",
summary = "Restore Email to Default setting",
description = "Restore Email to Default settings",
responses = {
@ApiResponse(
responseCode = "200",
description = "Settings",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = Settings.class)))
})
public Response restoreDefaultEmailSetting(
@Context UriInfo uriInfo, @Context SecurityContext securityContext) {
authorizer.authorizeAdmin(securityContext);
return systemRepository.createOrUpdate(
new Settings()
.withConfigType(SettingsType.EMAIL_CONFIGURATION)
.withConfigValue(applicationConfig.getSmtpSettings()));
}
@GET
@Path("/entities/count")
@Operation(
operationId = "listEntitiesCount",
summary = "List all entities counts",
description = "Get a list of all entities count",
responses = {
@ApiResponse(
responseCode = "200",
description = "List of Entities Count",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = EntitiesCount.class)))
})
public EntitiesCount listEntitiesCount(
@Context UriInfo uriInfo,
@Parameter(
description = "Include all, deleted, or non-deleted entities.",
schema = @Schema(implementation = Include.class))
@QueryParam("include")
@DefaultValue("non-deleted")
Include include) {
ListFilter filter = new ListFilter(include);
return systemRepository.getAllEntitiesCount(filter);
}
@GET
@Path("/services/count")
@Operation(
operationId = "listServicesCount",
summary = "List all services counts",
description = "Get a list of all entities count",
responses = {
@ApiResponse(
responseCode = "200",
description = "List of Services Count",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ServicesCount.class)))
})
public ServicesCount listServicesCount(
@Context UriInfo uriInfo,
@Parameter(
description = "Include all, deleted, or non-deleted entities.",
schema = @Schema(implementation = Include.class))
@QueryParam("include")
@DefaultValue("non-deleted")
Include include) {
ListFilter filter = new ListFilter(include);
return systemRepository.getAllServicesCount(filter);
}
@GET
@Path("/status")
@Operation(
operationId = "validateDeployment",
summary = "Validate the OpenMetadata deployment",
description =
"Check connectivity against your database, elasticsearch/opensearch, migrations,...",
responses = {
@ApiResponse(
responseCode = "200",
description = "validation OK",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ServicesCount.class)))
})
public ValidationResponse validate() {
return systemRepository.validateSystem(applicationConfig, pipelineServiceClient, jwtFilter);
}
}
