All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.dirigible.DirigibleSpringConfiguration Maven / Gradle / Ivy

Go to download 

/*
 * Copyright (c) 2023 SAP SE or an SAP affiliate company and Eclipse Dirigible contributors
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v20.html
 *
 * SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and Eclipse Dirigible contributors
 * SPDX-License-Identifier: EPL-2.0
 */
package org.eclipse.dirigible;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;

import org.apache.catalina.filters.CorsFilter;
import org.apache.cxf.Bus;
import org.apache.cxf.endpoint.Server;
import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;
import org.apache.cxf.jaxrs.openapi.OpenApiFeature;
import org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig;
import org.apache.olingo.odata2.core.servlet.ODataServlet;
import org.eclipse.dirigible.runtime.core.embed.EmbeddedDirigible;
import org.eclipse.dirigible.runtime.core.filter.HealthCheckFilter;
import org.eclipse.dirigible.runtime.core.filter.HttpContextFilter;
import org.eclipse.dirigible.runtime.core.initializer.DirigibleInitializer;
import org.eclipse.dirigible.runtime.core.services.HomeRedirectServlet;
import org.eclipse.dirigible.runtime.core.services.LogoutServlet;
import org.eclipse.dirigible.runtime.core.version.Version;
import org.eclipse.dirigible.runtime.core.version.VersionProcessor;
//import org.eclipse.dirigible.runtime.security.filter.SecurityFilter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * The Class DirigibleSpringConfiguration.
 */
@Configuration
public class DirigibleSpringConfiguration {

	/** The Constant logger. */
	private static final Logger logger = LoggerFactory.getLogger(DirigibleSpringConfiguration.class);

	/** The bus. */
	@Autowired
	private Bus bus;

	/**
	 * Rs server.
	 *
	 * @return the server
	 */
	@Bean
	public Server rsServer() {
		EmbeddedDirigible dirigible = new EmbeddedDirigible();
		DirigibleInitializer initializer = dirigible.initialize();
		ArrayList servicesAndProviders = new ArrayList(initializer.getServices());

		JAXRSServerFactoryBean endpoint = new JAXRSServerFactoryBean();
		endpoint.setBus(bus);
		endpoint.setServiceBeans(servicesAndProviders);
		endpoint.setProviders(servicesAndProviders);
		endpoint.setAddress("/");
		endpoint.setFeatures(Arrays.asList(createOpenApiFeature()));

		return endpoint.create();
	}

	/**
	 * Context filter.
	 *
	 * @return the filter registration bean
	 */
	@Bean
	public FilterRegistrationBean contextFilter() {
		FilterRegistrationBean registrationBean = new FilterRegistrationBean<>();

		registrationBean.setFilter(new HttpContextFilter());
		registrationBean.addUrlPatterns(
				"/services/v3/*", //
				"/public/v3/*", //
				"/services/v4/*", //
				"/public/v4/*" //
		);

		return registrationBean;
	}

	/**
	 * Healthcheck filter.
	 *
	 * @return the filter registration bean
	 */
	@Bean
	public FilterRegistrationBean healthcheckFilter() {
		FilterRegistrationBean registrationBean = new FilterRegistrationBean<>();

		registrationBean.setFilter(new HealthCheckFilter());
		registrationBean.addUrlPatterns(
				"/services/v3/*", //
				"/public/v3/*", //
				"/services/v4/*", //
				"/public/v4/*" //
		);

		return registrationBean;
	}

	/**
	 * Cors filter.
	 *
	 * @return the filter registration bean
	 */
	@Bean
	public FilterRegistrationBean corsFilter() {
		FilterRegistrationBean registrationBean = new FilterRegistrationBean<>();

		registrationBean.setFilter(new CorsFilter());
		registrationBean.addInitParameter("cors.allowed.origins", "*");
		registrationBean.addInitParameter("cors.allowed.methods", "GET,PUT,PATCH,POST,DELETE,HEAD,OPTIONS,CONNECT,TRACE");
		registrationBean.addUrlPatterns("/*");

		return registrationBean;
	}

//    @Bean
//    public FilterRegistrationBean securityFilter(){
//        FilterRegistrationBean registrationBean 
//          = new FilterRegistrationBean<>();
//            
//        registrationBean.setFilter(new SecurityFilter());
//        registrationBean.addUrlPatterns("/services/v3/js/*",
//        		"/services/v3/rhino/*",
//        		"/services/v3/nashorn/*",
//        		"/services/v3/v8/*",
//        		"/services/v3/public/*",
//        		"/services/v3/web/*",
//        		"/services/v3/wiki/*",
//        		"/services/v3/command/*",
//        		
//        		"/public/v3/js/*",
//        		"/public/v3/rhino/*",
//        		"/public/v3/nashorn/*",
//        		"/public/v3/v8/*",
//        		"/public/v3/public/*",
//        		"/public/v3/web/*",
//        		"/public/v3/wiki/*",
//        		"/public/v3/command/*",
//        		
//        		"/services/v4/js/*",
//        		"/services/v4/rhino/*",
//        		"/services/v4/nashorn/*",
//        		"/services/v4/v8/*",
//        		"/services/v4/public/*",
//        		"/services/v4/web/*",
//        		"/services/v4/wiki/*",
//        		"/services/v4/command/*",
//        		
//        		"/public/v4/js/*",
//        		"/public/v4/rhino/*",
//        		"/public/v4/nashorn/*",
//        		"/public/v4/v8/*",
//        		"/public/v4/public/*",
//        		"/public/v4/web/*",
//        		"/public/v4/wiki/*",
//        		"/public/v4/command/*",
//        		
//        		"/odata/v2/*");
//            
//        return registrationBean;    
//    }

	/**
 * Delegate home redirect servlet.
 *
 * @return the servlet registration bean
 */
@Bean
	public ServletRegistrationBean delegateHomeRedirectServlet() {
		return new ServletRegistrationBean(new HomeRedirectServlet(), "/home");
	}

	/**
	 * Delegate logout servlet.
	 *
	 * @return the servlet registration bean
	 */
	@Bean
	public ServletRegistrationBean delegateLogoutServlet() {
		return new ServletRegistrationBean(new LogoutServlet(), "/logout");
	}

	/**
	 * Olingo servlet.
	 *
	 * @return the servlet registration bean
	 */
	@Bean
	public ServletRegistrationBean olingoServlet() {
		ServletRegistrationBean bean = new ServletRegistrationBean(new ODataServlet(), "/odata/v2/*");
		bean.addInitParameter("javax.ws.rs.Application", "org.apache.olingo.odata2.core.rest.app.ODataApplication");
		bean.addInitParameter("org.apache.olingo.odata2.service.factory", "org.eclipse.dirigible.engine.odata2.factory.DirigibleODataServiceFactory");
		bean.setLoadOnStartup(1);
		return bean;
	}

	/**
	 * Creates the open api feature.
	 *
	 * @return the open api feature
	 */
	@Bean
	public OpenApiFeature createOpenApiFeature() {
		final OpenApiFeature openApiFeature = new OpenApiFeature();
		openApiFeature.setPrettyPrint(true);
		openApiFeature.setTitle(getOpenApiTitle());
		openApiFeature.setContactName(getOpenApiContactName());
		openApiFeature.setContactEmail(getOpenApiContactEmail());
		openApiFeature.setLicense(getOpenApiLicense());
		openApiFeature.setLicenseUrl(getOpenApiLicenseUrl());
		openApiFeature.setDescription(getOpenApiDescription());
		try {
			Version version = new VersionProcessor().getVersion();
			openApiFeature.setVersion(version.getProductVersion());
		} catch (IOException e) {
			if (logger.isErrorEnabled()) {logger.error(e.getMessage(), e);}
			openApiFeature.setVersion("3.0.0");
		}
		openApiFeature.setSwaggerUiConfig(new SwaggerUiConfig().url("/a/services/v4/openapi.json"));
		return openApiFeature;
	}

	/**
	 * Gets the open api title.
	 *
	 * @return the open api title
	 */
	protected String getOpenApiTitle() {
		return "Eclipse Dirigible - RESTful Services API";
	}

	/**
	 * Gets the open api contact name.
	 *
	 * @return the open api contact name
	 */
	protected String getOpenApiContactName() {
		return "Eclipse Dirigible";
	}

	/**
	 * Gets the open api contact email.
	 *
	 * @return the open api contact email
	 */
	protected String getOpenApiContactEmail() {
		return "[email protected]";
	}

	/**
	 * Gets the open api license.
	 *
	 * @return the open api license
	 */
	protected String getOpenApiLicense() {
		return "Eclipse Public License - v 2.0";
	}

	/**
	 * Gets the open api license url.
	 *
	 * @return the open api license url
	 */
	protected String getOpenApiLicenseUrl() {
		return "https://www.eclipse.org/legal/epl-v20.html";
	}

	/**
	 * Gets the open api description.
	 *
	 * @return the open api description
	 */
	protected String getOpenApiDescription() {
		return "Eclipse Dirigible API of the core RESTful services provided by the application development platform itself";
	}
} 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy