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.apereo.portal.session; + +public class PortalSessionConstants { + + private PortalSessionConstants() {} + + public static final String REDIS_STORE_TYPE = "redis"; + public static final String REDIS_STANDALONE_MODE = "standalone"; + public static final String REDIS_SENTINEL_MODE = "sentinel"; + public static final String REDIS_CLUSTER_MODE = "cluster"; + public static final String SESSION_STORE_TYPE_ENV_PROPERTY_NAME = + "ORG_APEREO_PORTAL_SESSION_STORETYPE"; + public static final String SESSION_STORE_TYPE_SYSTEM_PROPERTY_NAME = + "org.apereo.portal.session.storetype"; +} diff --git a/uPortal-session/src/main/java/org/apereo/portal/session/redis/RedisSessionConfig.java b/uPortal-session/src/main/java/org/apereo/portal/session/redis/RedisSessionConfig.java new file mode 100644 index 00000000000..c2a2d3f56f2 --- /dev/null +++ b/uPortal-session/src/main/java/org/apereo/portal/session/redis/RedisSessionConfig.java @@ -0,0 +1,127 @@ +/** + * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information regarding copyright ownership. Apereo + * licenses this file to you 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 the + * following location: + * + *
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.apereo.portal.session.redis;
+
+import static org.apereo.portal.session.PortalSessionConstants.REDIS_CLUSTER_MODE;
+import static org.apereo.portal.session.PortalSessionConstants.REDIS_SENTINEL_MODE;
+import static org.apereo.portal.session.PortalSessionConstants.REDIS_STANDALONE_MODE;
+
+import java.util.Arrays;
+import java.util.List;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Conditional;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.redis.connection.RedisClusterConfiguration;
+import org.springframework.data.redis.connection.RedisConnectionFactory;
+import org.springframework.data.redis.connection.RedisSentinelConfiguration;
+import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
+import org.springframework.session.data.redis.config.annotation.web.http.EnableRedisHttpSession;
+
+@Configuration
+@Conditional(SpringSessionRedisEnabledCondition.class)
+@EnableRedisHttpSession
+public class RedisSessionConfig {
+
+ @Value("${org.apereo.portal.session.redis.mode:standalone}")
+ private String redisMode;
+
+ @Value("${org.apereo.portal.session.redis.host:#{null}}")
+ private String redisHost;
+
+ @Value("${org.apereo.portal.session.redis.port:#{null}}")
+ private Integer redisPort;
+
+ @Value("${org.apereo.portal.session.redis.cluster.nodes:#{null}}")
+ private String redisClusterNodes;
+
+ @Value("${org.apereo.portal.session.redis.cluster.maxredirects:#{null}}")
+ private Integer redisClusterMaxRedirects;
+
+ @Value("${org.apereo.portal.session.redis.sentinel.master:#{null}}")
+ private String redisSentinelMaster;
+
+ @Value("${org.apereo.portal.session.redis.sentinel.nodes:#{null}}")
+ private String redisSentinelNodes;
+
+ @Value("${org.apereo.portal.session.redis.database:#{null}}")
+ private Integer redisDatabase;
+
+ @Value("${org.apereo.portal.session.redis.password:#{null}}")
+ private String redisPassword;
+
+ @Value("${org.apereo.portal.session.redis.timeout:#{null}}")
+ private Integer redisTimeout;
+
+ @Bean
+ public RedisConnectionFactory redisConnectionFactory() {
+ JedisConnectionFactory result;
+ if (REDIS_CLUSTER_MODE.equalsIgnoreCase(this.redisMode)) {
+ result = this.createBaseClusterConnectionFactory();
+ } else if (REDIS_SENTINEL_MODE.equalsIgnoreCase(this.redisMode)) {
+ result = this.createBaseSentinelConnectionFactory();
+ } else if (REDIS_STANDALONE_MODE.equalsIgnoreCase(this.redisMode)) {
+ result = this.createBaseStandaloneConnectionFactory();
+ } else {
+ throw new IllegalArgumentException(
+ "Invalid value for org.apereo.portal.session.redis.mode: " + this.redisMode);
+ }
+ this.setAdditionalProperties(result);
+ return result;
+ }
+
+ private JedisConnectionFactory createBaseClusterConnectionFactory() {
+ List 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.apereo.portal.session.redis;
+
+import static org.apereo.portal.session.PortalSessionConstants.REDIS_STORE_TYPE;
+import static org.apereo.portal.session.PortalSessionConstants.SESSION_STORE_TYPE_ENV_PROPERTY_NAME;
+import static org.apereo.portal.session.PortalSessionConstants.SESSION_STORE_TYPE_SYSTEM_PROPERTY_NAME;
+
+import org.springframework.session.web.context.AbstractHttpSessionApplicationInitializer;
+
+/**
+ * This class is needed to enable Spring Session Redis support in uPortal. It registers the filter
+ * that is needed by Spring Session to manage the session with Redis. It also ensures that the
+ * filter is only registered if the session store-type is configured for Redis. The filter could
+ * have instead been added to web.xml, but that would not have allowed for the feature to be
+ * enabled/disabled via configuration. Note that the application properties are not available during
+ * initialization, and therefore we instead check for an environment variable or system property.
+ */
+public class RedisSessionInitializer extends AbstractHttpSessionApplicationInitializer {
+
+ public RedisSessionInitializer() {
+ // MUST pass null here to avoid having Spring Session create a root WebApplicationContext
+ // that does not work with the current uPortal setup.
+ super((Class[]) null);
+ }
+
+ @Override
+ public void onStartup(javax.servlet.ServletContext servletContext)
+ throws javax.servlet.ServletException {
+ if (REDIS_STORE_TYPE.equals(this.getStoreTypeConfiguredValue())) {
+ super.onStartup(servletContext);
+ }
+ }
+
+ private String getStoreTypeConfiguredValue() {
+ String result = System.getProperty(SESSION_STORE_TYPE_SYSTEM_PROPERTY_NAME);
+ if (result == null) {
+ result = System.getenv(SESSION_STORE_TYPE_ENV_PROPERTY_NAME);
+ }
+ return result;
+ }
+}
diff --git a/uPortal-session/src/main/java/org/apereo/portal/session/redis/SpringSessionRedisEnabledCondition.java b/uPortal-session/src/main/java/org/apereo/portal/session/redis/SpringSessionRedisEnabledCondition.java
new file mode 100644
index 00000000000..152ff50ba30
--- /dev/null
+++ b/uPortal-session/src/main/java/org/apereo/portal/session/redis/SpringSessionRedisEnabledCondition.java
@@ -0,0 +1,43 @@
+/**
+ * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information regarding copyright ownership. Apereo
+ * licenses this file to you 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 the
+ * following location:
+ *
+ * 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.apereo.portal.session.redis;
+
+import static org.apereo.portal.session.PortalSessionConstants.REDIS_STORE_TYPE;
+import static org.apereo.portal.session.PortalSessionConstants.SESSION_STORE_TYPE_ENV_PROPERTY_NAME;
+import static org.apereo.portal.session.PortalSessionConstants.SESSION_STORE_TYPE_SYSTEM_PROPERTY_NAME;
+
+import org.springframework.context.annotation.Condition;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+
+public class SpringSessionRedisEnabledCondition implements Condition {
+
+ @Override
+ public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
+ return REDIS_STORE_TYPE.equals(this.getSessionStoreTypeValue(context));
+ }
+
+ private String getSessionStoreTypeValue(ConditionContext context) {
+ String result =
+ context.getEnvironment()
+ .getProperty(SESSION_STORE_TYPE_SYSTEM_PROPERTY_NAME, String.class, null);
+ if (result == null) {
+ result =
+ context.getEnvironment()
+ .getProperty(SESSION_STORE_TYPE_ENV_PROPERTY_NAME, String.class, null);
+ }
+ return result;
+ }
+}
diff --git a/uPortal-session/src/test/java/org/apereo/portal/session/redis/RedisSessionInitializerTest.java b/uPortal-session/src/test/java/org/apereo/portal/session/redis/RedisSessionInitializerTest.java
new file mode 100644
index 00000000000..951b22a4875
--- /dev/null
+++ b/uPortal-session/src/test/java/org/apereo/portal/session/redis/RedisSessionInitializerTest.java
@@ -0,0 +1,106 @@
+/**
+ * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information regarding copyright ownership. Apereo
+ * licenses this file to you 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 the
+ * following location:
+ *
+ * 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.apereo.portal.session.redis;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import javax.servlet.Filter;
+import javax.servlet.FilterRegistration.Dynamic;
+import javax.servlet.ServletContext;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.contrib.java.lang.system.EnvironmentVariables;
+import org.junit.contrib.java.lang.system.RestoreSystemProperties;
+import org.junit.rules.TestRule;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+public class RedisSessionInitializerTest {
+
+ private static final String EXPECTED_FILTER_NAME = "springSessionRepositoryFilter";
+
+ private RedisSessionInitializer redisSessionInitializer;
+
+ @Mock private ServletContext servletContext;
+ @Mock private Dynamic FilterRegistration;
+
+ @Rule public final EnvironmentVariables environmentVariables = new EnvironmentVariables();
+ @Rule public final TestRule restoreSystemProperties = new RestoreSystemProperties();
+
+ @Before
+ public void setUp() {
+ MockitoAnnotations.openMocks(this);
+ when(this.servletContext.addFilter(anyString(), any(Filter.class)))
+ .thenReturn(this.FilterRegistration);
+ this.redisSessionInitializer = new RedisSessionInitializer();
+ }
+
+ @Test
+ public void testOnStartupAddsFilterWhenStoreTypeSystemPropertySetToRedis() throws Exception {
+ System.setProperty("org.apereo.portal.session.storetype", "redis");
+ this.redisSessionInitializer.onStartup(this.servletContext);
+ verify(this.servletContext, times(1))
+ .addFilter(eq(EXPECTED_FILTER_NAME), any(Filter.class));
+ }
+
+ @Test
+ public void
+ testOnStartupDoesNotAddFilterWhenStoreTypeEnvironmentVariableAndSystemPropertyNotFound()
+ throws Exception {
+ this.redisSessionInitializer.onStartup(this.servletContext);
+ verify(this.servletContext, never()).addFilter(anyString(), any(Filter.class));
+ }
+
+ @Test
+ public void testOnStartupDoesNotAddFilterWhenStoreTypeSystemPropertyValueIsNotRedis()
+ throws Exception {
+ System.setProperty("org.apereo.portal.session.storetype", "rdbms");
+ this.redisSessionInitializer.onStartup(this.servletContext);
+ verify(this.servletContext, never()).addFilter(anyString(), any(Filter.class));
+ }
+
+ @Test
+ public void testOnStartupAddsFilterWhenStoreTypeEnvironmentVariableSetToRedis()
+ throws Exception {
+ this.environmentVariables.set("ORG_APEREO_PORTAL_SESSION_STORETYPE", "redis");
+ this.redisSessionInitializer.onStartup(this.servletContext);
+ verify(this.servletContext, times(1))
+ .addFilter(eq(EXPECTED_FILTER_NAME), any(Filter.class));
+ }
+
+ @Test
+ public void testOnStartupDoesNotAddFilterWhenStoreTypeEnvironmentVariableValueIsNotRedis()
+ throws Exception {
+ this.environmentVariables.set("ORG_APEREO_PORTAL_SESSION_STORETYPE", "foo");
+ this.redisSessionInitializer.onStartup(this.servletContext);
+ verify(this.servletContext, never()).addFilter(anyString(), any(Filter.class));
+ }
+
+ @Test
+ public void testOnStartupHasSystemPropertyTakePresidenceOverEnvironmentVariable()
+ throws Exception {
+ this.environmentVariables.set("ORG_APEREO_PORTAL_SESSION_STORETYPE", "redis");
+ System.setProperty("org.apereo.portal.session.storetype", "foo");
+ this.redisSessionInitializer.onStartup(this.servletContext);
+ verify(this.servletContext, never()).addFilter(anyString(), any(Filter.class));
+ }
+}
diff --git a/uPortal-webapp/build.gradle b/uPortal-webapp/build.gradle
index ead64d2e0ca..7a4308b272c 100644
--- a/uPortal-webapp/build.gradle
+++ b/uPortal-webapp/build.gradle
@@ -39,6 +39,7 @@ dependencies {
api project(':uPortal-security:uPortal-security-authn')
api project(':uPortal-security:uPortal-security-xslt')
api project(':uPortal-security:uPortal-security-filters')
+ api project(':uPortal-session')
api project(':uPortal-soffit:uPortal-soffit-connector')
api project(':uPortal-utils:uPortal-utils-jmx')
api project(':uPortal-utils:uPortal-utils-url')
diff --git a/uPortal-webapp/src/main/java/org/apereo/portal/PortalWebAppInitializer.java b/uPortal-webapp/src/main/java/org/apereo/portal/PortalWebAppInitializer.java
new file mode 100644
index 00000000000..5053c795d90
--- /dev/null
+++ b/uPortal-webapp/src/main/java/org/apereo/portal/PortalWebAppInitializer.java
@@ -0,0 +1,41 @@
+package org.apereo.portal;
+
+import org.springframework.web.context.AbstractContextLoaderInitializer;
+import org.springframework.web.context.WebApplicationContext;
+import org.springframework.web.context.support.XmlWebApplicationContext;
+
+/**
+ * This class does the following: 1. creates the root application context using the specified config
+ * locations 2. initializes the context loader
+ *
+ * This replaces the the following, which were previously defined in web.xml file.
+ *
+ * {@code
+ *
+ *
+ * This new approach allows us to dynamically update the servlet context programatically with
+ * Spring, which was needed in order support Spring Session handling as a feature that could be
+ * enabled/disabled with configuration.
+ */
+public class PortalWebAppInitializer extends AbstractContextLoaderInitializer {
+
+ @Override
+ protected WebApplicationContext createRootApplicationContext() {
+ XmlWebApplicationContext context = new XmlWebApplicationContext();
+ context.setConfigLocation(
+ "classpath:/properties/contexts/*.xml,classpath:/properties/contextOverrides/*.xml");
+ return context;
+ }
+}
diff --git a/uPortal-webapp/src/main/resources/properties/contexts/applicationContext.xml b/uPortal-webapp/src/main/resources/properties/contexts/applicationContext.xml
index 1e418b66b06..a90eb9f6064 100644
--- a/uPortal-webapp/src/main/resources/properties/contexts/applicationContext.xml
+++ b/uPortal-webapp/src/main/resources/properties/contexts/applicationContext.xml
@@ -53,6 +53,7 @@