com.hortonworks.registries.webservice.RegistryApplication Maven / Gradle / Ivy
Show all versions of schema-registry-webservice Show documentation
/**
* Copyright 2016-2022 Cloudera, Inc.
* 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 com.hortonworks.registries.webservice;
import com.cloudera.dim.atlas.conf.AtlasSchemaRegistryModule;
import com.cloudera.dim.atlas.events.AtlasEventLogger;
import com.codahale.metrics.health.HealthCheck;
import com.hortonworks.registries.common.GenericExceptionMapper;
import com.hortonworks.registries.common.KerberosService;
import com.hortonworks.registries.common.RegistryConfiguration;
import com.hortonworks.registries.common.SchemaRegistryServiceInfo;
import com.hortonworks.registries.common.SchemaRegistryVersion;
import com.hortonworks.registries.common.ServletFilterConfiguration;
import com.hortonworks.registries.schemaregistry.webservice.CoreModule;
import com.hortonworks.registries.schemaregistry.webservice.SchemaRegistryModule;
import io.dropwizard.Application;
import io.dropwizard.assets.AssetsBundle;
import io.dropwizard.configuration.EnvironmentVariableSubstitutor;
import io.dropwizard.configuration.SubstitutingSourceProvider;
import io.dropwizard.lifecycle.Managed;
import io.dropwizard.setup.Bootstrap;
import io.dropwizard.setup.Environment;
import io.federecio.dropwizard.swagger.SwaggerBundle;
import io.federecio.dropwizard.swagger.SwaggerBundleConfiguration;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.jetty.servlets.CrossOriginFilter;
import org.glassfish.jersey.media.multipart.MultiPartFeature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ru.vyarus.dropwizard.guice.GuiceBundle;
import ru.vyarus.dropwizard.guice.injector.lookup.InjectorProvider;
import javax.inject.Provider;
import javax.servlet.DispatcherType;
import javax.servlet.Filter;
import javax.servlet.FilterRegistration;
import java.util.EnumSet;
import java.util.List;
import java.util.Map;
/**
* Application entry point.
*/
public class RegistryApplication extends Application {
private static final Logger LOG = LoggerFactory.getLogger(RegistryApplication.class);
@Override
public void run(RegistryConfiguration registryConfiguration, Environment environment) throws Exception {
initializeUGI(registryConfiguration);
SchemaRegistryVersion schemaRegistryVersion = SchemaRegistryServiceInfo.get().version();
LOG.info("SchemaRegistry is starting with {}", schemaRegistryVersion);
environment.jersey().register(MultiPartFeature.class);
environment.jersey().register(GenericExceptionMapper.class);
environment.healthChecks().register("dummyHealthCheck", new DummyHealthCheck());
manageAtlasEventLogger(environment);
if (registryConfiguration.isEnableCors()) {
enableCORS(environment);
}
addServletFilters(registryConfiguration, environment);
}
@SuppressWarnings("unchecked")
private void initializeUGI(RegistryConfiguration conf) {
if (conf.getServiceAuthenticationConfiguration() == null || StringUtils.isBlank(conf.getKerberosServiceImplementation())) {
LOG.debug("No service authentication is configured");
return;
}
final Class kerbServiceClass;
try {
kerbServiceClass = Class.forName(conf.getKerberosServiceImplementation());
} catch (Throwable t) {
// this will cause Schema Registry to halt
throw new Error("Error while loading the KerberosService implementation class " + conf.getKerberosServiceImplementation(), t);
}
try {
// first try to load a Provider - this is the preferred method
if (Provider.class.isAssignableFrom(kerbServiceClass)) {
Class> keytabProviderClass = (Class>) kerbServiceClass;
keytabProviderClass.newInstance().get().loadKerberosUser(conf.getServiceAuthenticationConfiguration());
return; // success
}
// if a provider was not found then try a direct implementation
if (KerberosService.class.isAssignableFrom(kerbServiceClass)) {
Class keytabCheck = (Class) kerbServiceClass;
keytabCheck.newInstance().loadKerberosUser(conf.getServiceAuthenticationConfiguration());
}
} catch (Throwable t) {
LOG.error("Failed to initialize kerberos service while using plugin implementation [{}].", conf.getKerberosServiceImplementation(), t);
}
}
@Override
public String getName() {
return "Schema Registry";
}
@Override
public void initialize(Bootstrap bootstrap) {
LOG.debug("Initializing Registry ...");
bootstrap.setConfigurationSourceProvider(
new SubstitutingSourceProvider(bootstrap.getConfigurationSourceProvider(),
new EnvironmentVariableSubstitutor(false)
)
);
bootstrap.addBundle(GuiceBundle.builder()
.modules(new CoreModule())
.modules(new SchemaRegistryModule())
.modules(new AtlasSchemaRegistryModule())
.build());
// always deploy UI on /ui. If there is no other filter like Confluent etc, redirect / to /ui
bootstrap.addBundle(new AssetsBundle("/assets", "/ui", "index.html", "static"));
bootstrap.addBundle(new SwaggerBundle() {
private SwaggerBundleConfiguration swaggerConfig;
@Override
protected SwaggerBundleConfiguration getSwaggerBundleConfiguration(RegistryConfiguration registryConfiguration) {
if (swaggerConfig == null) {
this.swaggerConfig = registryConfiguration.getSwaggerBundleConfiguration();
String resourcePackage = swaggerConfig.getResourcePackage();
swaggerConfig.setResourcePackage(resourcePackage);
// dropwizard-swagger 2.0.12-1 has a bug in its template, hence the custom one
swaggerConfig.getSwaggerViewConfiguration().setTemplateUrl("/swagger-index.ftl");
}
return swaggerConfig;
}
});
super.initialize(bootstrap);
}
private void enableCORS(Environment environment) {
// Enable CORS headers
final FilterRegistration.Dynamic cors = environment.servlets().addFilter("CORS", CrossOriginFilter.class);
// Configure CORS parameters
cors.setInitParameter(CrossOriginFilter.ALLOWED_ORIGINS_PARAM, "*");
cors.setInitParameter(CrossOriginFilter.ALLOWED_HEADERS_PARAM, "X-Requested-With,Authorization,Content-Type,Accept,Origin");
cors.setInitParameter(CrossOriginFilter.ALLOWED_METHODS_PARAM, "OPTIONS,GET,PUT,POST,DELETE,HEAD");
// Add URL mapping
cors.addMappingForUrlPatterns(EnumSet.allOf(DispatcherType.class), true, "/*");
}
@SuppressWarnings("unchecked")
private void addServletFilters(RegistryConfiguration registryConfiguration, Environment environment) {
List servletFilterConfigurations = registryConfiguration.getServletFilters();
if (servletFilterConfigurations != null && !servletFilterConfigurations.isEmpty()) {
for (ServletFilterConfiguration servletFilterConfig : servletFilterConfigurations) {
try {
String className = servletFilterConfig.getClassName();
Map params = servletFilterConfig.getParams();
String typeSuffix = "";
if (params != null) {
typeSuffix = params.get("type") != null ? ("-" + params.get("type")) : "";
}
LOG.info("Registering servlet filter [{}]", servletFilterConfig);
Class filterClass = (Class) Class.forName(className);
FilterRegistration.Dynamic dynamic = environment.servlets().addFilter(className + typeSuffix, filterClass);
if (params != null) {
dynamic.setInitParameters(params);
}
dynamic.addMappingForUrlPatterns(EnumSet.allOf(DispatcherType.class), true, "/*");
} catch (Exception e) {
LOG.error("Error registering servlet filter {}", servletFilterConfig);
throw new RuntimeException(e);
}
}
}
}
private void manageAtlasEventLogger(Environment environment) {
AutoCloseable managed = new InjectorProvider(this).get().getInstance(AtlasEventLogger.class);
environment.lifecycle().manage(new AutoCloseableManager(managed));
}
public static void main(String[] args) throws Exception {
RegistryApplication registryApplication = new RegistryApplication();
registryApplication.run(args);
}
/** Dropwizard requires us to have at least one health check. These health checks can be
* observed through the admin endpoint. However, we have disabled the admin port due to
* security reasons, so there's no actual way to see a health check's results. We are adding
* this dummy health check in order to avoid the ugly/misleading message in the logs.
*
* See CDPD-14175 for more details.
*/
private static class DummyHealthCheck extends HealthCheck {
@Override
protected Result check() {
return Result.healthy();
}
}
private static class AutoCloseableManager implements Managed {
private final AutoCloseable closeableObject;
public AutoCloseableManager(AutoCloseable closeableObjects) {
this.closeableObject = closeableObjects;
}
@Override
public void start() {
}
@Override
public void stop() {
LOG.info("Close managed AutoCloseable: " + closeableObject.getClass().getSimpleName());
try {
closeableObject.close();
} catch (Exception e) {
LOG.warn("Could not close object.", e);
}
}
}
}