* Spring profiles can be configured with a program arguments --spring.profiles.active=your-active-profile - *
*- * You can find more information on how profiles work with JHipster on http://jhipster.github.io/profiles.html. - *
+ * You can find more information on how profiles work with JHipster on http://jhipster.github.io/profiles/. */ @PostConstruct - public void initApplication() throws IOException { + public void initApplication() { if (env.getActiveProfiles().length == 0) { log.warn("No Spring profile configured, running with default configuration"); } else { @@ -53,10 +49,6 @@ public void initApplication() throws IOException { log.error("You have misconfigured your application! " + "It should not run with both the 'dev' and 'prod' profiles at the same time."); } - if (activeProfiles.contains(Constants.SPRING_PROFILE_PRODUCTION) && activeProfiles.contains(Constants.SPRING_PROFILE_FAST)) { - log.error("You have misconfigured your application! " + - "It should not run with both the 'prod' and 'fast' profiles at the same time."); - } if (activeProfiles.contains(Constants.SPRING_PROFILE_DEVELOPMENT) && activeProfiles.contains(Constants.SPRING_PROFILE_CLOUD)) { log.error("You have misconfigured your application! " + "It should not run with both the 'dev' and 'cloud' profiles at the same time."); @@ -66,15 +58,20 @@ public void initApplication() throws IOException { /** * Main method, used to run the application. + * + * @param args the command line arguments + * @throws UnknownHostException if the local host name could not be resolved into an address */ public static void main(String[] args) throws UnknownHostException { - SpringApplication app = new SpringApplication(Application.class); + SpringApplication app = new SpringApplication(SampleApplicationApp.class); SimpleCommandLinePropertySource source = new SimpleCommandLinePropertySource(args); addDefaultProfile(app, source); Environment env = app.run(args).getEnvironment(); - log.info("Access URLs:\n----------------------------------------------------------\n\t" + + log.info("\n----------------------------------------------------------\n\t" + + "Application '{}' is running! Access URLs:\n\t" + "Local: \t\thttp://127.0.0.1:{}\n\t" + "External: \thttp://{}:{}\n----------------------------------------------------------", + env.getProperty("spring.application.name"), env.getProperty("server.port"), InetAddress.getLocalHost().getHostAddress(), env.getProperty("server.port")); diff --git a/src/main/java/com/mycompany/myapp/async/ExceptionHandlingAsyncTaskExecutor.java b/src/main/java/com/mycompany/myapp/async/ExceptionHandlingAsyncTaskExecutor.java index 300de6220..7603869da 100644 --- a/src/main/java/com/mycompany/myapp/async/ExceptionHandlingAsyncTaskExecutor.java +++ b/src/main/java/com/mycompany/myapp/async/ExceptionHandlingAsyncTaskExecutor.java @@ -22,7 +22,7 @@ public ExceptionHandlingAsyncTaskExecutor(AsyncTaskExecutor executor) { @Override public void execute(Runnable task) { - executor.execute(task); + executor.execute(createWrappedRunnable(task)); } @Override diff --git a/src/main/java/com/mycompany/myapp/config/AsyncConfiguration.java b/src/main/java/com/mycompany/myapp/config/AsyncConfiguration.java index 1d92d7458..cc1968775 100644 --- a/src/main/java/com/mycompany/myapp/config/AsyncConfiguration.java +++ b/src/main/java/com/mycompany/myapp/config/AsyncConfiguration.java @@ -33,7 +33,7 @@ public Executor getAsyncExecutor() { executor.setCorePoolSize(jHipsterProperties.getAsync().getCorePoolSize()); executor.setMaxPoolSize(jHipsterProperties.getAsync().getMaxPoolSize()); executor.setQueueCapacity(jHipsterProperties.getAsync().getQueueCapacity()); - executor.setThreadNamePrefix("sampleapplication-Executor-"); + executor.setThreadNamePrefix("sample-application-Executor-"); return new ExceptionHandlingAsyncTaskExecutor(executor); } diff --git a/src/main/java/com/mycompany/myapp/config/CacheConfiguration.java b/src/main/java/com/mycompany/myapp/config/CacheConfiguration.java index 242a6931c..5f1ccb143 100644 --- a/src/main/java/com/mycompany/myapp/config/CacheConfiguration.java +++ b/src/main/java/com/mycompany/myapp/config/CacheConfiguration.java @@ -22,7 +22,6 @@ @Configuration @EnableCaching @AutoConfigureAfter(value = { MetricsConfiguration.class, DatabaseConfiguration.class }) -@Profile("!" + Constants.SPRING_PROFILE_FAST) public class CacheConfiguration { private final Logger log = LoggerFactory.getLogger(CacheConfiguration.class); diff --git a/src/main/java/com/mycompany/myapp/config/Constants.java b/src/main/java/com/mycompany/myapp/config/Constants.java index b0addca91..07b981771 100644 --- a/src/main/java/com/mycompany/myapp/config/Constants.java +++ b/src/main/java/com/mycompany/myapp/config/Constants.java @@ -5,14 +5,17 @@ */ public final class Constants { - // Spring profile for development, production and "fast", see http://jhipster.github.io/profiles.html + // Spring profile for development and production, see http://jhipster.github.io/profiles/ public static final String SPRING_PROFILE_DEVELOPMENT = "dev"; public static final String SPRING_PROFILE_PRODUCTION = "prod"; - public static final String SPRING_PROFILE_FAST = "fast"; // Spring profile used when deploying with Spring Cloud (used when deploying to CloudFoundry) public static final String SPRING_PROFILE_CLOUD = "cloud"; // Spring profile used when deploying to Heroku public static final String SPRING_PROFILE_HEROKU = "heroku"; + // Spring profile used to disable swagger + public static final String SPRING_PROFILE_NO_SWAGGER = "no-swagger"; + // Spring profile used to disable running liquibase + public static final String SPRING_PROFILE_NO_LIQUIBASE = "no-liquibase"; public static final String SYSTEM_ACCOUNT = "system"; diff --git a/src/main/java/com/mycompany/myapp/config/DatabaseConfiguration.java b/src/main/java/com/mycompany/myapp/config/DatabaseConfiguration.java index ff3a5fd40..3babacfef 100644 --- a/src/main/java/com/mycompany/myapp/config/DatabaseConfiguration.java +++ b/src/main/java/com/mycompany/myapp/config/DatabaseConfiguration.java @@ -4,7 +4,6 @@ import com.codahale.metrics.MetricRegistry; import com.fasterxml.jackson.datatype.hibernate4.Hibernate4Module; -import com.zaxxer.hikari.HikariConfig; import com.zaxxer.hikari.HikariDataSource; import liquibase.integration.spring.SpringLiquibase; import org.h2.tools.Server; @@ -12,8 +11,10 @@ import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression; +import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder; import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties; import org.springframework.boot.autoconfigure.liquibase.LiquibaseProperties; +import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.ApplicationContextException; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -43,8 +44,9 @@ public class DatabaseConfiguration { private MetricRegistry metricRegistry; @Bean(destroyMethod = "close") - @ConditionalOnExpression("#{!environment.acceptsProfiles('cloud') && !environment.acceptsProfiles('heroku')}") - public DataSource dataSource(DataSourceProperties dataSourceProperties, JHipsterProperties jHipsterProperties) { + @ConditionalOnExpression("#{!environment.acceptsProfiles('" + Constants.SPRING_PROFILE_CLOUD + "') && !environment.acceptsProfiles('" + Constants.SPRING_PROFILE_HEROKU + "')}") + @ConfigurationProperties(prefix = "spring.datasource.hikari") + public DataSource dataSource(DataSourceProperties dataSourceProperties) { log.debug("Configuring Datasource"); if (dataSourceProperties.getUrl() == null) { log.error("Your database connection pool configuration is incorrect! The application" + @@ -53,34 +55,26 @@ public DataSource dataSource(DataSourceProperties dataSourceProperties, JHipster throw new ApplicationContextException("Database connection pool is not configured correctly"); } - HikariConfig config = new HikariConfig(); - config.setDataSourceClassName(dataSourceProperties.getDriverClassName()); - config.addDataSourceProperty("url", dataSourceProperties.getUrl()); - if (dataSourceProperties.getUsername() != null) { - config.addDataSourceProperty("user", dataSourceProperties.getUsername()); - } else { - config.addDataSourceProperty("user", ""); // HikariCP doesn't allow null user - } - if (dataSourceProperties.getPassword() != null) { - config.addDataSourceProperty("password", dataSourceProperties.getPassword()); - } else { - config.addDataSourceProperty("password", ""); // HikariCP doesn't allow null password - } + HikariDataSource hikariDataSource = (HikariDataSource) DataSourceBuilder + .create(dataSourceProperties.getClassLoader()) + .type(HikariDataSource.class) + .driverClassName(dataSourceProperties.getDriverClassName()) + .url(dataSourceProperties.getUrl()) + .username(dataSourceProperties.getUsername()) + .password(dataSourceProperties.getPassword()) + .build(); - //MySQL optimizations, see https://github.com/brettwooldridge/HikariCP/wiki/MySQL-Configuration - if ("com.mysql.jdbc.jdbc2.optional.MysqlDataSource".equals(dataSourceProperties.getDriverClassName())) { - config.addDataSourceProperty("cachePrepStmts", jHipsterProperties.getDatasource().isCachePrepStmts()); - config.addDataSourceProperty("prepStmtCacheSize", jHipsterProperties.getDatasource().getPrepStmtCacheSize()); - config.addDataSourceProperty("prepStmtCacheSqlLimit", jHipsterProperties.getDatasource().getPrepStmtCacheSqlLimit()); - } if (metricRegistry != null) { - config.setMetricRegistry(metricRegistry); + hikariDataSource.setMetricRegistry(metricRegistry); } - return new HikariDataSource(config); + return hikariDataSource; } /** * Open the TCP port for the H2 database, so it is available remotely. + * + * @return the H2 database TCP server + * @throws SQLException if the server failed to start */ @Bean(initMethod = "start", destroyMethod = "stop") @Profile(Constants.SPRING_PROFILE_DEVELOPMENT) @@ -99,18 +93,13 @@ public SpringLiquibase liquibase(DataSource dataSource, DataSourceProperties dat liquibase.setContexts(liquibaseProperties.getContexts()); liquibase.setDefaultSchema(liquibaseProperties.getDefaultSchema()); liquibase.setDropFirst(liquibaseProperties.isDropFirst()); - liquibase.setShouldRun(liquibaseProperties.isEnabled()); - if (env.acceptsProfiles(Constants.SPRING_PROFILE_FAST)) { - if ("org.h2.jdbcx.JdbcDataSource".equals(dataSourceProperties.getDriverClassName())) { - liquibase.setShouldRun(true); - log.warn("Using '{}' profile with H2 database in memory is not optimal, you should consider switching to" + - " MySQL or Postgresql to avoid rebuilding your database upon each start.", Constants.SPRING_PROFILE_FAST); - } else { - liquibase.setShouldRun(false); - } + if (env.acceptsProfiles(Constants.SPRING_PROFILE_NO_LIQUIBASE)) { + liquibase.setShouldRun(false); } else { + liquibase.setShouldRun(liquibaseProperties.isEnabled()); log.debug("Configuring Liquibase"); } + return liquibase; } diff --git a/src/main/java/com/mycompany/myapp/config/JHipsterProperties.java b/src/main/java/com/mycompany/myapp/config/JHipsterProperties.java index 3ebc310ae..75fb35d4e 100644 --- a/src/main/java/com/mycompany/myapp/config/JHipsterProperties.java +++ b/src/main/java/com/mycompany/myapp/config/JHipsterProperties.java @@ -5,6 +5,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.web.cors.CorsConfiguration; + /** * Properties specific to JHipster. * @@ -19,8 +20,6 @@ public class JHipsterProperties { private final Http http = new Http(); - private final Datasource datasource = new Datasource(); - private final Cache cache = new Cache(); private final Mail mail = new Mail(); @@ -33,8 +32,6 @@ public class JHipsterProperties { private final CorsConfiguration cors = new CorsConfiguration(); - - public Async getAsync() { return async; } @@ -43,10 +40,6 @@ public Http getHttp() { return http; } - public Datasource getDatasource() { - return datasource; - } - public Cache getCache() { return cache; } @@ -71,7 +64,6 @@ public CorsConfiguration getCors() { return cors; } - public static class Async { private int corePoolSize = 2; @@ -115,7 +107,7 @@ public Cache getCache() { public static class Cache { - private int timeToLiveInDays = 31; + private int timeToLiveInDays = 1461; public int getTimeToLiveInDays() { return timeToLiveInDays; @@ -127,49 +119,6 @@ public void setTimeToLiveInDays(int timeToLiveInDays) { } } - public static class Datasource { - - private boolean cachePrepStmts = true; - - private int prepStmtCacheSize = 250; - - private int prepStmtCacheSqlLimit = 2048; - - private boolean useServerPrepStmts = true; - - public boolean isCachePrepStmts() { - return cachePrepStmts; - } - - public void setCachePrepStmts(boolean cachePrepStmts) { - this.cachePrepStmts = cachePrepStmts; - } - - public int getPrepStmtCacheSize() { - return prepStmtCacheSize; - } - - public void setPrepStmtCacheSize(int prepStmtCacheSize) { - this.prepStmtCacheSize = prepStmtCacheSize; - } - - public int getPrepStmtCacheSqlLimit() { - return prepStmtCacheSqlLimit; - } - - public void setPrepStmtCacheSqlLimit(int prepStmtCacheSqlLimit) { - this.prepStmtCacheSqlLimit = prepStmtCacheSqlLimit; - } - - public boolean isUseServerPrepStmts() { - return useServerPrepStmts; - } - - public void setUseServerPrepStmts(boolean useServerPrepStmts) { - this.useServerPrepStmts = useServerPrepStmts; - } - } - public static class Cache { private int timeToLiveSeconds = 3600; @@ -217,13 +166,13 @@ public void setFrom(String from) { public static class Security { - private final Rememberme rememberme = new Rememberme(); + private final RememberMe rememberMe = new RememberMe(); - public Rememberme getRememberme() { - return rememberme; + public RememberMe getRememberMe() { + return rememberMe; } - public static class Rememberme { + public static class RememberMe { @NotNull private String key; @@ -248,7 +197,11 @@ public static class Swagger { private String termsOfServiceUrl; - private String contact; + private String contactName; + + private String contactUrl; + + private String contactEmail; private String license; @@ -286,12 +239,28 @@ public void setTermsOfServiceUrl(String termsOfServiceUrl) { this.termsOfServiceUrl = termsOfServiceUrl; } - public String getContact() { - return contact; + public String getContactName() { + return contactName; } - public void setContact(String contact) { - this.contact = contact; + public void setContactName(String contactName) { + this.contactName = contactName; + } + + public String getContactUrl() { + return contactUrl; + } + + public void setContactUrl(String contactUrl) { + this.contactUrl = contactUrl; + } + + public String getContactEmail() { + return contactEmail; + } + + public void setContactEmail(String contactEmail) { + this.contactEmail = contactEmail; } public String getLicense() { @@ -319,6 +288,8 @@ public static class Metrics { private final Graphite graphite = new Graphite(); + private final Logs logs = new Logs(); + public Jmx getJmx() { return jmx; } @@ -331,6 +302,11 @@ public Graphite getGraphite() { return graphite; } + public Logs getLogs() { + return logs; + } + + public static class Jmx { private boolean enabled = true; @@ -419,5 +395,67 @@ public void setPrefix(String prefix) { this.prefix = prefix; } } + + public static class Logs { + + private boolean enabled = false; + + private long reportFrequency = 60; + + public long getReportFrequency() { + return reportFrequency; + } + + public void setReportFrequency(int reportFrequency) { + this.reportFrequency = reportFrequency; + } + + public boolean isEnabled() { + return enabled; + } + + public void setEnabled(boolean enabled) { + this.enabled = enabled; + } + } } + + private final Logging logging = new Logging(); + + public Logging getLogging() { return logging; } + + public static class Logging { + + private final Logstash logstash = new Logstash(); + + public Logstash getLogstash() { return logstash; } + + public static class Logstash { + + private boolean enabled = false; + + private String host = "localhost"; + + private int port = 5000; + + private int queueSize = 512; + + public boolean isEnabled() { return enabled; } + + public void setEnabled(boolean enabled) { this.enabled = enabled; } + + public String getHost() { return host; } + + public void setHost(String host) { this.host = host; } + + public int getPort() { return port; } + + public void setPort(int port) { this.port = port; } + + public int getQueueSize() { return queueSize; } + + public void setQueueSize(int queueSize) { this.queueSize = queueSize; } + } + } + } diff --git a/src/main/java/com/mycompany/myapp/config/LocaleConfiguration.java b/src/main/java/com/mycompany/myapp/config/LocaleConfiguration.java index 1a51df6d7..0775b8bba 100644 --- a/src/main/java/com/mycompany/myapp/config/LocaleConfiguration.java +++ b/src/main/java/com/mycompany/myapp/config/LocaleConfiguration.java @@ -4,10 +4,8 @@ import org.springframework.boot.bind.RelaxedPropertyResolver; import org.springframework.context.EnvironmentAware; -import org.springframework.context.MessageSource; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import org.springframework.context.support.ReloadableResourceBundleMessageSource; import org.springframework.core.env.Environment; import org.springframework.web.servlet.LocaleResolver; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; @@ -31,15 +29,6 @@ public LocaleResolver localeResolver() { return cookieLocaleResolver; } - @Bean - public MessageSource messageSource() { - ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource(); - messageSource.setBasename("classpath:/i18n/messages"); - messageSource.setDefaultEncoding("UTF-8"); - messageSource.setCacheSeconds(propertyResolver.getProperty("cache-seconds", Integer.class, -1)); - return messageSource; - } - @Override public void addInterceptors(InterceptorRegistry registry) { LocaleChangeInterceptor localeChangeInterceptor = new LocaleChangeInterceptor(); diff --git a/src/main/java/com/mycompany/myapp/config/LoggingConfiguration.java b/src/main/java/com/mycompany/myapp/config/LoggingConfiguration.java new file mode 100644 index 000000000..75921d4a5 --- /dev/null +++ b/src/main/java/com/mycompany/myapp/config/LoggingConfiguration.java @@ -0,0 +1,62 @@ +package com.mycompany.myapp.config; + +import ch.qos.logback.classic.AsyncAppender; +import ch.qos.logback.classic.LoggerContext; +import net.logstash.logback.appender.LogstashSocketAppender; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Configuration; + +import javax.annotation.PostConstruct; +import javax.inject.Inject; + +@Configuration +public class LoggingConfiguration { + + private final Logger log = LoggerFactory.getLogger(LoggingConfiguration.class); + + private LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory(); + + @Value("${spring.application.name}") + private String appName; + + @Value("${server.port}") + private String serverPort; + + @Inject + private JHipsterProperties jHipsterProperties; + + @PostConstruct + private void init() { + if (jHipsterProperties.getLogging().getLogstash().isEnabled()) { + addLogstashAppender(); + } + } + + public void addLogstashAppender() { + log.info("Initializing Logstash logging"); + + LogstashSocketAppender logstashAppender = new LogstashSocketAppender(); + logstashAppender.setName("LOGSTASH"); + logstashAppender.setContext(context); + + String customFields = "{\"app_name\":\"" + appName + "\",\"app_port\":\"" + serverPort + "\"}"; + + // Set the Logstash appender config from JHipster properties + logstashAppender.setSyslogHost(jHipsterProperties.getLogging().getLogstash().getHost()); + logstashAppender.setPort(jHipsterProperties.getLogging().getLogstash().getPort()); + logstashAppender.setCustomFields(customFields); + logstashAppender.start(); + + // Wrap the appender in an Async appender for performance + AsyncAppender asyncLogstashAppender = new AsyncAppender(); + asyncLogstashAppender.setContext(context); + asyncLogstashAppender.setName("ASYNC_LOGSTASH"); + asyncLogstashAppender.setQueueSize(jHipsterProperties.getLogging().getLogstash().getQueueSize()); + asyncLogstashAppender.addAppender(logstashAppender); + asyncLogstashAppender.start(); + + context.getLogger("ROOT").addAppender(asyncLogstashAppender); + } +} diff --git a/src/main/java/com/mycompany/myapp/config/MetricsConfiguration.java b/src/main/java/com/mycompany/myapp/config/MetricsConfiguration.java index d3a2f17d8..d5b4cf1c1 100644 --- a/src/main/java/com/mycompany/myapp/config/MetricsConfiguration.java +++ b/src/main/java/com/mycompany/myapp/config/MetricsConfiguration.java @@ -2,6 +2,7 @@ import com.codahale.metrics.JmxReporter; import com.codahale.metrics.MetricRegistry; +import com.codahale.metrics.Slf4jReporter; import com.codahale.metrics.graphite.Graphite; import com.codahale.metrics.graphite.GraphiteReporter; import com.codahale.metrics.health.HealthCheckRegistry; @@ -22,7 +23,6 @@ @Configuration @EnableMetrics(proxyTargetClass = true) -@Profile("!" + Constants.SPRING_PROFILE_FAST) public class MetricsConfiguration extends MetricsConfigurerAdapter { private static final String PROP_METRIC_REG_JVM_MEMORY = "jvm.memory"; @@ -65,11 +65,20 @@ public void init() { JmxReporter jmxReporter = JmxReporter.forRegistry(metricRegistry).build(); jmxReporter.start(); } + + if (jHipsterProperties.getMetrics().getLogs().isEnabled()) { + log.info("Initializing Metrics Log reporting"); + final Slf4jReporter reporter = Slf4jReporter.forRegistry(metricRegistry) + .outputTo(LoggerFactory.getLogger("metrics")) + .convertRatesTo(TimeUnit.SECONDS) + .convertDurationsTo(TimeUnit.MILLISECONDS) + .build(); + reporter.start(jHipsterProperties.getMetrics().getLogs().getReportFrequency(), TimeUnit.SECONDS); + } } @Configuration @ConditionalOnClass(Graphite.class) - @Profile("!" + Constants.SPRING_PROFILE_FAST) public static class GraphiteRegistry { private final Logger log = LoggerFactory.getLogger(GraphiteRegistry.class); @@ -100,7 +109,6 @@ private void init() { @Configuration @ConditionalOnClass(SparkReporter.class) - @Profile("!" + Constants.SPRING_PROFILE_FAST) public static class SparkRegistry { private final Logger log = LoggerFactory.getLogger(SparkRegistry.class); diff --git a/src/main/java/com/mycompany/myapp/config/SecurityConfiguration.java b/src/main/java/com/mycompany/myapp/config/SecurityConfiguration.java index c8a5586f7..02a1d7a6c 100644 --- a/src/main/java/com/mycompany/myapp/config/SecurityConfiguration.java +++ b/src/main/java/com/mycompany/myapp/config/SecurityConfiguration.java @@ -2,9 +2,11 @@ import com.mycompany.myapp.security.*; import com.mycompany.myapp.web.filter.CsrfCookieGeneratorFilter; +import com.mycompany.myapp.config.JHipsterProperties; + import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import org.springframework.core.env.Environment; +import org.springframework.http.HttpMethod; import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder; import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity; import org.springframework.security.config.annotation.web.builders.HttpSecurity; @@ -27,7 +29,7 @@ public class SecurityConfiguration extends WebSecurityConfigurerAdapter { @Inject - private Environment env; + private JHipsterProperties jHipsterProperties; @Inject private AjaxAuthenticationSuccessHandler ajaxAuthenticationSuccessHandler; @@ -62,10 +64,11 @@ public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception @Override public void configure(WebSecurity web) throws Exception { web.ignoring() - .antMatchers("/scripts/**/*.{js,html}") + .antMatchers(HttpMethod.OPTIONS, "/**") + .antMatchers("/app/**/*.{js,html}") .antMatchers("/bower_components/**") .antMatchers("/i18n/**") - .antMatchers("/assets/**") + .antMatchers("/content/**") .antMatchers("/swagger-ui/index.html") .antMatchers("/test/**") .antMatchers("/h2-console/**"); @@ -84,7 +87,7 @@ protected void configure(HttpSecurity http) throws Exception { .rememberMe() .rememberMeServices(rememberMeServices) .rememberMeParameter("remember-me") - .key(env.getProperty("jhipster.security.rememberme.key")) + .key(jHipsterProperties.getSecurity().getRememberMe().getKey()) .and() .formLogin() .loginProcessingUrl("/api/authentication") @@ -123,7 +126,6 @@ protected void configure(HttpSecurity http) throws Exception { .antMatchers("/info/**").hasAuthority(AuthoritiesConstants.ADMIN) .antMatchers("/autoconfig/**").hasAuthority(AuthoritiesConstants.ADMIN) .antMatchers("/env/**").hasAuthority(AuthoritiesConstants.ADMIN) - .antMatchers("/trace/**").hasAuthority(AuthoritiesConstants.ADMIN) .antMatchers("/mappings/**").hasAuthority(AuthoritiesConstants.ADMIN) .antMatchers("/liquibase/**").hasAuthority(AuthoritiesConstants.ADMIN) .antMatchers("/v2/api-docs/**").permitAll() diff --git a/src/main/java/com/mycompany/myapp/config/ThymeleafConfiguration.java b/src/main/java/com/mycompany/myapp/config/ThymeleafConfiguration.java index d1dd3d673..1b7565851 100644 --- a/src/main/java/com/mycompany/myapp/config/ThymeleafConfiguration.java +++ b/src/main/java/com/mycompany/myapp/config/ThymeleafConfiguration.java @@ -3,9 +3,7 @@ import org.apache.commons.lang.CharEncoding; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import org.springframework.context.MessageSource; import org.springframework.context.annotation.*; -import org.springframework.context.support.ReloadableResourceBundleMessageSource; import org.thymeleaf.templateresolver.ClassLoaderTemplateResolver; @Configuration @@ -24,14 +22,4 @@ public ClassLoaderTemplateResolver emailTemplateResolver() { emailTemplateResolver.setOrder(1); return emailTemplateResolver; } - - @Bean - @Description("Spring mail message resolver") - public MessageSource emailMessageSource() { - log.info("loading non-reloadable mail messages resources"); - ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource(); - messageSource.setBasename("classpath:/mails/messages/messages"); - messageSource.setDefaultEncoding(CharEncoding.UTF_8); - return messageSource; - } } diff --git a/src/main/java/com/mycompany/myapp/config/WebConfigurer.java b/src/main/java/com/mycompany/myapp/config/WebConfigurer.java index 674b56ca9..edfdcadeb 100644 --- a/src/main/java/com/mycompany/myapp/config/WebConfigurer.java +++ b/src/main/java/com/mycompany/myapp/config/WebConfigurer.java @@ -4,7 +4,6 @@ import com.codahale.metrics.servlet.InstrumentedFilter; import com.codahale.metrics.servlets.MetricsServlet; import com.mycompany.myapp.web.filter.CachingHttpHeadersFilter; -import com.mycompany.myapp.web.filter.StaticResourcesProductionFilter; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; @@ -19,6 +18,7 @@ import org.springframework.web.cors.UrlBasedCorsConfigurationSource; import org.springframework.web.filter.CorsFilter; +import java.io.File; import java.util.*; import javax.inject.Inject; import javax.servlet.*; @@ -35,7 +35,7 @@ public class WebConfigurer implements ServletContextInitializer, EmbeddedServlet private Environment env; @Inject - private JHipsterProperties props; + private JHipsterProperties jHipsterProperties; @Autowired(required = false) private MetricRegistry metricRegistry; @@ -44,12 +44,9 @@ public class WebConfigurer implements ServletContextInitializer, EmbeddedServlet public void onStartup(ServletContext servletContext) throws ServletException { log.info("Web application configuration, using profiles: {}", Arrays.toString(env.getActiveProfiles())); EnumSet
- * By default, this asynchronous version only works when using the "dev" profile.
+ * By default, this asynchronous version only works when using the "dev" profile.
* The standard liquibase.integration.spring.SpringLiquibase starts Liquibase in the current thread: *
* Persistent tokens are used by Spring Security to automatically log in users. - *
+ ** This is a specific implementation of Spring Security's remember-me authentication, but it is much * more powerful than the standard implementations: *
* This is inspired by: *
* The main algorithm comes from Spring Security's PersistentTokenBasedRememberMeServices, but this class * couldn't be cleanly extended. - *
*/ @Service public class CustomPersistentRememberMeServices extends @@ -71,15 +71,14 @@ public class CustomPersistentRememberMeServices extends private UserRepository userRepository; @Inject - public CustomPersistentRememberMeServices(Environment env, org.springframework.security.core.userdetails + public CustomPersistentRememberMeServices(JHipsterProperties jHipsterProperties, org.springframework.security.core.userdetails .UserDetailsService userDetailsService) { - super(env.getProperty("jhipster.security.rememberme.key"), userDetailsService); + super(jHipsterProperties.getSecurity().getRememberMe().getKey(), userDetailsService); random = new SecureRandom(); } @Override - @Transactional protected UserDetails processAutoLoginCookie(String[] cookieTokens, HttpServletRequest request, HttpServletResponse response) { @@ -129,7 +128,7 @@ protected void onLoginSuccess(HttpServletRequest request, HttpServletResponse re /** * When logout occurs, only invalidate the current token, and not all user sessions. - * + ** The standard Spring Security implementations are too basic: they invalidate all tokens for the * current user, so when he logs out from one browser, all his other sessions are destroyed. */ diff --git a/src/main/java/com/mycompany/myapp/security/SecurityUtils.java b/src/main/java/com/mycompany/myapp/security/SecurityUtils.java index 752a3a0de..a93352f06 100644 --- a/src/main/java/com/mycompany/myapp/security/SecurityUtils.java +++ b/src/main/java/com/mycompany/myapp/security/SecurityUtils.java @@ -5,7 +5,6 @@ import org.springframework.security.core.authority.SimpleGrantedAuthority; import org.springframework.security.core.context.SecurityContext; import org.springframework.security.core.context.SecurityContextHolder; -import org.springframework.security.core.userdetails.User; import org.springframework.security.core.userdetails.UserDetails; import java.util.Collection; @@ -20,6 +19,8 @@ private SecurityUtils() { /** * Get the login of the current user. + * + * @return the login of the current user */ public static String getCurrentUserLogin() { SecurityContext securityContext = SecurityContextHolder.getContext(); @@ -54,27 +55,13 @@ public static boolean isAuthenticated() { return true; } - /** - * Return the current user, or throws an exception, if the user is not - * authenticated yet. - * - * @return the current user - */ - public static User getCurrentUser() { - SecurityContext securityContext = SecurityContextHolder.getContext(); - Authentication authentication = securityContext.getAuthentication(); - if (authentication != null) { - if (authentication.getPrincipal() instanceof User) { - return (User) authentication.getPrincipal(); - } - } - throw new IllegalStateException("User not found!"); - } - /** * If the current user has a specific authority (security role). * *
The name of this method comes from the isUserInRole() method in the Servlet API
+ * + * @param authority the authorithy to check + * @return true if the current user has the authority, false otherwise */ public static boolean isCurrentUserInRole(String authority) { SecurityContext securityContext = SecurityContextHolder.getContext(); diff --git a/src/main/java/com/mycompany/myapp/service/AuditEventService.java b/src/main/java/com/mycompany/myapp/service/AuditEventService.java index 948d9afad..6419a54fc 100644 --- a/src/main/java/com/mycompany/myapp/service/AuditEventService.java +++ b/src/main/java/com/mycompany/myapp/service/AuditEventService.java @@ -1,10 +1,11 @@ package com.mycompany.myapp.service; import com.mycompany.myapp.config.audit.AuditEventConverter; -import com.mycompany.myapp.domain.PersistentAuditEvent; import com.mycompany.myapp.repository.PersistenceAuditEventRepository; import java.time.LocalDateTime; import org.springframework.boot.actuate.audit.AuditEvent; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; import org.springframework.stereotype.Service; import org.springframework.transaction.annotation.Transactional; @@ -14,7 +15,6 @@ /** * Service for managing audit events. - * ** This is the default implementation to support SpringBoot Actuator AuditEventRepository *
@@ -36,15 +36,14 @@ public AuditEventService( this.auditEventConverter = auditEventConverter; } - public List* We use the @Async annotation to send e-mails asynchronously. *
diff --git a/src/main/java/com/mycompany/myapp/service/UserService.java b/src/main/java/com/mycompany/myapp/service/UserService.java index 2e560e023..f4c393e52 100644 --- a/src/main/java/com/mycompany/myapp/service/UserService.java +++ b/src/main/java/com/mycompany/myapp/service/UserService.java @@ -31,12 +31,14 @@ public class UserService { private final Logger log = LoggerFactory.getLogger(UserService.class); + @Inject private PasswordEncoder passwordEncoder; @Inject private UserRepository userRepository; + @Inject private PersistentTokenRepository persistentTokenRepository; @@ -45,7 +47,7 @@ public class UserService { public Optional* This is scheduled to get fired everyday, at midnight. *
@@ -208,7 +208,6 @@ public void removeOldPersistentTokens() { /** * Not activated users should be automatically deleted after 3 days. - * ** This is scheduled to get fired everyday, at 01:00 (am). *
diff --git a/src/main/java/com/mycompany/myapp/web/filter/CachingHttpHeadersFilter.java b/src/main/java/com/mycompany/myapp/web/filter/CachingHttpHeadersFilter.java index 85022cb66..79c76e587 100644 --- a/src/main/java/com/mycompany/myapp/web/filter/CachingHttpHeadersFilter.java +++ b/src/main/java/com/mycompany/myapp/web/filter/CachingHttpHeadersFilter.java @@ -1,6 +1,6 @@ package com.mycompany.myapp.web.filter; -import org.springframework.core.env.Environment; +import com.mycompany.myapp.config.JHipsterProperties; import javax.servlet.*; import javax.servlet.http.HttpServletResponse; @@ -15,18 +15,17 @@ public class CachingHttpHeadersFilter implements Filter { // We consider the last modified date is the start up time of the server private final static long LAST_MODIFIED = System.currentTimeMillis(); - private long CACHE_TIME_TO_LIVE = TimeUnit.DAYS.toMillis(31L); + private long CACHE_TIME_TO_LIVE = TimeUnit.DAYS.toMillis(1461L); - private Environment env; + private JHipsterProperties jHipsterProperties;; - public CachingHttpHeadersFilter(Environment env) { - this.env = env; + public CachingHttpHeadersFilter(JHipsterProperties jHipsterProperties) { + this.jHipsterProperties = jHipsterProperties; } @Override public void init(FilterConfig filterConfig) throws ServletException { - CACHE_TIME_TO_LIVE = TimeUnit.DAYS.toMillis(env.getProperty("jhipster.http.cache.timeToLiveInDays", - Long.class, 31L)); + CACHE_TIME_TO_LIVE = TimeUnit.DAYS.toMillis(jHipsterProperties.getHttp().getCache().getTimeToLiveInDays()); } @Override diff --git a/src/main/java/com/mycompany/myapp/web/filter/StaticResourcesProductionFilter.java b/src/main/java/com/mycompany/myapp/web/filter/StaticResourcesProductionFilter.java deleted file mode 100644 index ee5f9a994..000000000 --- a/src/main/java/com/mycompany/myapp/web/filter/StaticResourcesProductionFilter.java +++ /dev/null @@ -1,42 +0,0 @@ -package com.mycompany.myapp.web.filter; - - -import org.apache.commons.lang.StringUtils; - -import javax.servlet.*; -import javax.servlet.http.HttpServletRequest; -import java.io.IOException; - -/** - * This filter is used in production, to serve static resources generated by "grunt build". - * - *- * It is configured to serve resources from the "dist" directory, which is the Grunt - * destination directory. - *
- */ -public class StaticResourcesProductionFilter implements Filter { - - @Override - public void init(FilterConfig filterConfig) throws ServletException { - // Nothing to initialize - } - - @Override - public void destroy() { - // Nothing to destroy - } - - @Override - public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { - HttpServletRequest httpRequest = (HttpServletRequest) request; - String contextPath = ((HttpServletRequest) request).getContextPath(); - String requestURI = httpRequest.getRequestURI(); - requestURI = StringUtils.substringAfter(requestURI, contextPath); - if (StringUtils.equals("/", requestURI)) { - requestURI = "/index.html"; - } - String newURI = "/dist" + requestURI; - request.getRequestDispatcher(newURI).forward(request, response); - } -} diff --git a/src/main/java/com/mycompany/myapp/web/rest/AccountResource.java b/src/main/java/com/mycompany/myapp/web/rest/AccountResource.java index 8c1b77c53..e8b6ad2a2 100644 --- a/src/main/java/com/mycompany/myapp/web/rest/AccountResource.java +++ b/src/main/java/com/mycompany/myapp/web/rest/AccountResource.java @@ -16,6 +16,7 @@ import org.apache.commons.lang.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; @@ -50,17 +51,25 @@ public class AccountResource { private MailService mailService; /** - * POST /register -> register the user. + * POST /register : register the user. + * + * @param userDTO the user DTO + * @param request the HTTP request + * @return the ResponseEntity with status 201 (Created) if the user is registred or 400 (Bad Request) if the login or e-mail is already in use */ @RequestMapping(value = "/register", - method = RequestMethod.POST, - produces = MediaType.TEXT_PLAIN_VALUE) + method = RequestMethod.POST, + produces={MediaType.APPLICATION_JSON_VALUE, MediaType.TEXT_PLAIN_VALUE}) @Timed public ResponseEntity registerAccount(@Valid @RequestBody UserDTO userDTO, HttpServletRequest request) { + + HttpHeaders textPlainHeaders = new HttpHeaders(); + textPlainHeaders.setContentType(MediaType.TEXT_PLAIN); + return userRepository.findOneByLogin(userDTO.getLogin()) - .map(user -> new ResponseEntity<>("login already in use", HttpStatus.BAD_REQUEST)) + .map(user -> new ResponseEntity<>("login already in use", textPlainHeaders, HttpStatus.BAD_REQUEST)) .orElseGet(() -> userRepository.findOneByEmail(userDTO.getEmail()) - .map(user -> new ResponseEntity<>("e-mail address already in use", HttpStatus.BAD_REQUEST)) + .map(user -> new ResponseEntity<>("e-mail address already in use", textPlainHeaders, HttpStatus.BAD_REQUEST)) .orElseGet(() -> { User user = userService.createUserInformation(userDTO.getLogin(), userDTO.getPassword(), userDTO.getFirstName(), userDTO.getLastName(), userDTO.getEmail().toLowerCase(), @@ -79,20 +88,26 @@ public ResponseEntity registerAccount(@Valid @RequestBody UserDTO userDTO, Ht } /** - * GET /activate -> activate the registered user. + * GET /activate : activate the registered user. + * + * @param key the activation key + * @return the ResponseEntity with status 200 (OK) and the activated user in body, or status 500 (Internal Server Error) if the user couldn't be activated */ @RequestMapping(value = "/activate", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE) @Timed public ResponseEntity