Extract out ExpiringSessionHttpSession

This allows the HttpSession Spring Session adapter to be reused
for HttpSessionEvent.

Issue gh-4
This commit is contained in:
Rob Winch
2015-08-11 10:52:57 -05:00
parent 2503537e36
commit 7693d0e624
2 changed files with 171 additions and 125 deletions

View File

@@ -0,0 +1,162 @@
/*
* Copyright 2002-2015 the original author or authors.
*
* 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 org.springframework.session.web.http;
import java.util.Collections;
import java.util.Enumeration;
import java.util.NoSuchElementException;
import java.util.Set;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpSessionContext;
import org.springframework.session.ExpiringSession;
/**
* Adapts Spring Session's {@link ExpiringSession} to an {@link HttpSession}.
*
* @author Rob Winch
* @since 1.1
*/
@SuppressWarnings("deprecation")
class ExpiringSessionHttpSession<S extends ExpiringSession> implements HttpSession {
private S session;
private final ServletContext servletContext;
private boolean invalidated;
private boolean old;
public ExpiringSessionHttpSession(S session, ServletContext servletContext) {
this.session = session;
this.servletContext = servletContext;
}
public void setSession(S session) {
this.session = session;
}
public S getSession() {
return session;
}
public long getCreationTime() {
checkState();
return session.getCreationTime();
}
public String getId() {
return session.getId();
}
public long getLastAccessedTime() {
checkState();
return session.getLastAccessedTime();
}
public ServletContext getServletContext() {
return servletContext;
}
public void setMaxInactiveInterval(int interval) {
session.setMaxInactiveIntervalInSeconds(interval);
}
public int getMaxInactiveInterval() {
return session.getMaxInactiveIntervalInSeconds();
}
public HttpSessionContext getSessionContext() {
return NOOP_SESSION_CONTEXT;
}
public Object getAttribute(String name) {
checkState();
return session.getAttribute(name);
}
public Object getValue(String name) {
return getAttribute(name);
}
public Enumeration<String> getAttributeNames() {
checkState();
return Collections.enumeration(session.getAttributeNames());
}
public String[] getValueNames() {
checkState();
Set<String> attrs = session.getAttributeNames();
return attrs.toArray(new String[0]);
}
public void setAttribute(String name, Object value) {
checkState();
session.setAttribute(name, value);
}
public void putValue(String name, Object value) {
setAttribute(name, value);
}
public void removeAttribute(String name) {
checkState();
session.removeAttribute(name);
}
public void removeValue(String name) {
removeAttribute(name);
}
public void invalidate() {
checkState();
this.invalidated = true;
}
public void setNew(boolean isNew) {
this.old = !isNew;
}
public boolean isNew() {
checkState();
return !old;
}
private void checkState() {
if(invalidated) {
throw new IllegalStateException("The HttpSession has already be invalidated.");
}
}
private static final HttpSessionContext NOOP_SESSION_CONTEXT = new HttpSessionContext() {
public HttpSession getSession(String sessionId) {
return null;
}
public Enumeration<String> getIds() {
return EMPTY_ENUMERATION;
}
};
private static final Enumeration<String> EMPTY_ENUMERATION = new Enumeration<String>() {
public boolean hasMoreElements() {
return false;
}
public String nextElement() {
throw new NoSuchElementException("a");
}
};
}

View File

@@ -16,12 +16,9 @@
package org.springframework.session.web.http;
import java.io.IOException;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import javax.servlet.FilterChain;
import javax.servlet.ServletContext;
@@ -30,7 +27,6 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpSessionContext;
import org.springframework.core.annotation.Order;
import org.springframework.session.ExpiringSession;
@@ -63,7 +59,6 @@ import org.springframework.session.SessionRepository;
* @since 1.0
* @author Rob Winch
*/
@SuppressWarnings("deprecation")
@Order(SessionRepositoryFilter.DEFAULT_ORDER)
public class SessionRepositoryFilter<S extends ExpiringSession> extends OncePerRequestFilter {
public static final String SESSION_REPOSITORY_ATTR = SessionRepository.class.getName();
@@ -189,7 +184,7 @@ public class SessionRepositoryFilter<S extends ExpiringSession> extends OncePerR
httpSessionStrategy.onInvalidateSession(this, response);
}
} else {
S session = wrappedSession.session;
S session = wrappedSession.getSession();
sessionRepository.save(session);
if(!isRequestedSessionIdValid() || !session.getId().equals(getRequestedSessionId())) {
httpSessionStrategy.onNewSession(session, this, response);
@@ -210,7 +205,7 @@ public class SessionRepositoryFilter<S extends ExpiringSession> extends OncePerR
}
}
@SuppressWarnings({ "unused", "unchecked" })
@SuppressWarnings("unused")
public String changeSessionId() {
HttpSession session = getSession(false);
@@ -232,8 +227,8 @@ public class SessionRepositoryFilter<S extends ExpiringSession> extends OncePerR
HttpSessionWrapper original = getCurrentSession();
setCurrentSession(null);
HttpSession newSession = getSession();
original.session = ((HttpSessionWrapper)newSession).session;
HttpSessionWrapper newSession = getSession();
original.setSession(newSession.getSession());
newSession.setMaxInactiveInterval(session.getMaxInactiveInterval());
for(Map.Entry<String, Object> attr : attrs.entrySet()) {
@@ -266,7 +261,7 @@ public class SessionRepositoryFilter<S extends ExpiringSession> extends OncePerR
}
@Override
public HttpSession getSession(boolean create) {
public HttpSessionWrapper getSession(boolean create) {
HttpSessionWrapper currentSession = getCurrentSession();
if(currentSession != null) {
return currentSession;
@@ -300,7 +295,7 @@ public class SessionRepositoryFilter<S extends ExpiringSession> extends OncePerR
}
@Override
public HttpSession getSession() {
public HttpSessionWrapper getSession() {
return getSession(true);
}
@@ -315,132 +310,21 @@ public class SessionRepositoryFilter<S extends ExpiringSession> extends OncePerR
* @author Rob Winch
* @since 1.0
*/
private final class HttpSessionWrapper implements HttpSession {
private S session;
private final ServletContext servletContext;
private boolean invalidated;
private boolean old;
private final class HttpSessionWrapper extends ExpiringSessionHttpSession<S> {
public HttpSessionWrapper(S session, ServletContext servletContext) {
this.session = session;
this.servletContext = servletContext;
}
public long getCreationTime() {
checkState();
return session.getCreationTime();
}
public String getId() {
return session.getId();
}
public long getLastAccessedTime() {
checkState();
return session.getLastAccessedTime();
}
public ServletContext getServletContext() {
return servletContext;
}
public void setMaxInactiveInterval(int interval) {
session.setMaxInactiveIntervalInSeconds(interval);
}
public int getMaxInactiveInterval() {
return session.getMaxInactiveIntervalInSeconds();
}
@SuppressWarnings("deprecation")
public HttpSessionContext getSessionContext() {
return NOOP_SESSION_CONTEXT;
}
public Object getAttribute(String name) {
checkState();
return session.getAttribute(name);
}
public Object getValue(String name) {
return getAttribute(name);
}
public Enumeration<String> getAttributeNames() {
checkState();
return Collections.enumeration(session.getAttributeNames());
}
public String[] getValueNames() {
checkState();
Set<String> attrs = session.getAttributeNames();
return attrs.toArray(new String[0]);
}
public void setAttribute(String name, Object value) {
checkState();
session.setAttribute(name, value);
}
public void putValue(String name, Object value) {
setAttribute(name, value);
}
public void removeAttribute(String name) {
checkState();
session.removeAttribute(name);
}
public void removeValue(String name) {
removeAttribute(name);
super(session, servletContext);
}
public void invalidate() {
checkState();
this.invalidated = true;
super.invalidate();
requestedSessionInvalidated = true;
setCurrentSession(null);
sessionRepository.delete(getId());
}
public void setNew(boolean isNew) {
this.old = !isNew;
}
public boolean isNew() {
checkState();
return !old;
}
private void checkState() {
if(invalidated) {
throw new IllegalStateException("The HttpSession has already be invalidated.");
}
}
}
}
@SuppressWarnings("deprecation")
private static final HttpSessionContext NOOP_SESSION_CONTEXT = new HttpSessionContext() {
public HttpSession getSession(String sessionId) {
return null;
}
public Enumeration<String> getIds() {
return EMPTY_ENUMERATION;
}
};
private static final Enumeration<String> EMPTY_ENUMERATION = new Enumeration<String>() {
public boolean hasMoreElements() {
return false;
}
public String nextElement() {
throw new NoSuchElementException("a");
}
};
static class MultiHttpSessionStrategyAdapter implements MultiHttpSessionStrategy {
private HttpSessionStrategy delegate;