WFLY-4792 Add support for session manager statistics for distributabl…

…e web applications

clustering/ee/spi/src/main/java/org/wildfly/clustering/ee/Recordable.java

@@ -0,0 +1,40 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2015, Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags. See the copyright.txt file in the
+ * distribution for a full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+
+package org.wildfly.clustering.ee;
+
+/**
+ * Records some other object.
+ * @author Paul Ferraro
+ */
+public interface Recordable<T> {
+    /**
+     * Records the specified object
+     * @param object an object to record
+     */
+    void record(T object);
+
+    /**
+     * Resets any previously recorded objects
+     */
+    void reset();
+}

clustering/web/infinispan/src/main/java/org/wildfly/clustering/web/infinispan/session/InfinispanSession.java

@@ -60,9 +60,6 @@ public InfinispanSession(String id, SessionMetaData metaData, SessionAttributes
 
     @Override
     public SessionAttributes getAttributes() {
-        if (!this.valid.get()) {
-            throw InfinispanWebLogger.ROOT_LOGGER.invalidSession(this.getId());
-        }
         return this.attributes;
     }
 
@@ -81,9 +78,6 @@ public boolean isValid() {
 
     @Override
     public SessionMetaData getMetaData() {
-        if (!this.valid.get()) {
-            throw InfinispanWebLogger.ROOT_LOGGER.invalidSession(this.getId());
-        }
         return this.metaData;
     }
 

clustering/web/infinispan/src/main/java/org/wildfly/clustering/web/infinispan/session/InfinispanSessionManager.java

@@ -58,6 +58,7 @@
 import org.wildfly.clustering.ee.Batch;
 import org.wildfly.clustering.ee.Batcher;
 import org.wildfly.clustering.ee.Invoker;
+import org.wildfly.clustering.ee.Recordable;
 import org.wildfly.clustering.ee.infinispan.RetryingInvoker;
 import org.wildfly.clustering.ee.infinispan.TransactionBatch;
 import org.wildfly.clustering.group.Node;
@@ -94,6 +95,7 @@ public class InfinispanSessionManager<V, L> implements SessionManager<L, Transac
     private final boolean persistent;
     private final Invoker invoker = new RetryingInvoker(0, 10, 100);
     private final SessionIdentifierFilter filter = new SessionIdentifierFilter();
+    private final Recordable<ImmutableSession> recorder;
 
     volatile CommandDispatcher<Scheduler> dispatcher;
     private volatile Scheduler scheduler;
@@ -107,6 +109,7 @@ public InfinispanSessionManager(SessionFactory<V, L> factory, InfinispanSessionM
         this.dispatcherFactory = configuration.getCommandDispatcherFactory();
         this.nodeFactory = configuration.getNodeFactory();
         this.maxActiveSessions = configuration.getMaxActiveSessions();
+        this.recorder = configuration.getInactiveSessionRecorder();
         Configuration config = this.cache.getCacheConfiguration();
         // If cache is clustered or configured with a write-through cache store
         // then we need to trigger any HttpSessionActivationListeners per request
@@ -116,6 +119,9 @@ public InfinispanSessionManager(SessionFactory<V, L> factory, InfinispanSessionM
 
     @Override
     public void start() {
+        if (this.recorder != null) {
+            this.recorder.reset();
+        }
         this.identifierFactory.start();
         final List<Scheduler> schedulers = new ArrayList<>(2);
         schedulers.add(new SessionExpirationScheduler(this.batcher, new ExpiredSessionRemover<>(this.factory)));
@@ -283,6 +289,16 @@ private Set<String> getSessions(Flag... flags) {
         return result;
     }
 
+    @Override
+    public int getMaxActiveSessions() {
+        return this.maxActiveSessions;
+    }
+
+    @Override
+    public long getActiveSessionCount() {
+        return this.getActiveSessions().size();
+    }
+
     @CacheEntryActivated
     public void activated(CacheEntryActivatedEvent<String, ?> event) {
         if (!event.isPre() && !this.persistent) {
@@ -332,6 +348,10 @@ public void removed(CacheEntryRemovedEvent<String, ?> event) {
                         listener.valueUnbound(new HttpSessionBindingEvent(httpSession, name, attribute));
                     }
                 }
+
+                if (this.recorder != null) {
+                    this.recorder.record(session);
+                }
             }
         }
     }
@@ -421,6 +441,9 @@ public String getId() {
 
         @Override
         public SessionMetaData getMetaData() {
+            if (!this.isValid()) {
+                throw InfinispanWebLogger.ROOT_LOGGER.invalidSession(this.getId());
+            }
             return this.session.getMetaData();
         }
 
@@ -436,6 +459,9 @@ public void invalidate() {
 
         @Override
         public SessionAttributes getAttributes() {
+            if (!this.isValid()) {
+                throw InfinispanWebLogger.ROOT_LOGGER.invalidSession(this.getId());
+            }
             return this.session.getAttributes();
         }
 

clustering/web/infinispan/src/main/java/org/wildfly/clustering/web/infinispan/session/InfinispanSessionManagerConfiguration.java

@@ -25,9 +25,11 @@
 import org.infinispan.remoting.transport.Address;
 import org.wildfly.clustering.dispatcher.CommandDispatcherFactory;
 import org.wildfly.clustering.ee.Batcher;
+import org.wildfly.clustering.ee.Recordable;
 import org.wildfly.clustering.ee.infinispan.TransactionBatch;
 import org.wildfly.clustering.group.NodeFactory;
 import org.wildfly.clustering.web.IdentifierFactory;
+import org.wildfly.clustering.web.session.ImmutableSession;
 import org.wildfly.clustering.web.session.SessionContext;
 
 /**
@@ -42,4 +44,5 @@ public interface InfinispanSessionManagerConfiguration {
     CommandDispatcherFactory getCommandDispatcherFactory();
     NodeFactory<Address> getNodeFactory();
     int getMaxActiveSessions();
+    Recordable<ImmutableSession> getInactiveSessionRecorder();
 }

clustering/web/infinispan/src/main/java/org/wildfly/clustering/web/infinispan/session/InfinispanSessionManagerFactory.java

@@ -39,6 +39,7 @@
 import org.jboss.modules.Module;
 import org.wildfly.clustering.dispatcher.CommandDispatcherFactory;
 import org.wildfly.clustering.ee.Batcher;
+import org.wildfly.clustering.ee.Recordable;
 import org.wildfly.clustering.ee.infinispan.InfinispanBatcher;
 import org.wildfly.clustering.ee.infinispan.TransactionBatch;
 import org.wildfly.clustering.group.NodeFactory;
@@ -51,6 +52,7 @@
 import org.wildfly.clustering.web.infinispan.session.fine.FineSessionCacheEntry;
 import org.wildfly.clustering.web.infinispan.session.fine.FineSessionFactory;
 import org.wildfly.clustering.web.infinispan.session.fine.SessionAttributeCacheKey;
+import org.wildfly.clustering.web.session.ImmutableSession;
 import org.wildfly.clustering.web.session.SessionContext;
 import org.wildfly.clustering.web.session.SessionManager;
 import org.wildfly.clustering.web.session.SessionManagerConfiguration;
@@ -69,7 +71,7 @@ public InfinispanSessionManagerFactory(InfinispanSessionManagerFactoryConfigurat
     }
 
     @Override
-    public <L> SessionManager<L, TransactionBatch> createSessionManager(final SessionContext context, IdentifierFactory<String> identifierFactory, LocalContextFactory<L> localContextFactory) {
+    public <L> SessionManager<L, TransactionBatch> createSessionManager(final SessionContext context, IdentifierFactory<String> identifierFactory, LocalContextFactory<L> localContextFactory, final Recordable<ImmutableSession> inactiveSessionRecorder) {
         final Batcher<TransactionBatch> batcher = new InfinispanBatcher(this.config.getCache());
         final Cache<String, ?> cache = this.config.getCache();
         final IdentifierFactory<String> factory = new AffinityIdentifierFactory<>(identifierFactory, cache, this.config.getKeyAffinityServiceFactory());
@@ -111,6 +113,11 @@ public NodeFactory<Address> getNodeFactory() {
             public int getMaxActiveSessions() {
                 return maxActiveSessions;
             }
+
+            @Override
+            public Recordable<ImmutableSession> getInactiveSessionRecorder() {
+                return inactiveSessionRecorder;
+            }
         };
         return new InfinispanSessionManager<>(this.getSessionFactory(context, localContextFactory), config);
     }

clustering/web/infinispan/src/main/java/org/wildfly/clustering/web/infinispan/session/SessionExpirationScheduler.java

@@ -21,8 +21,7 @@
  */
 package org.wildfly.clustering.web.infinispan.session;
 
-import static java.security.AccessController.doPrivileged;
-
+import java.security.AccessController;
 import java.security.PrivilegedAction;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
@@ -59,7 +58,8 @@ public SessionExpirationScheduler(Batcher<TransactionBatch> batcher, Remover<Str
     }
 
     private static ThreadFactory createThreadFactory() {
-        return doPrivileged(new PrivilegedAction<ThreadFactory>() {
+        return AccessController.doPrivileged(new PrivilegedAction<ThreadFactory>() {
+            @Override
             public ThreadFactory run() {
                 return new JBossThreadFactory(new ThreadGroup(SessionExpirationScheduler.class.getSimpleName()), Boolean.FALSE, null, "%G - %t", null, null);
             }

clustering/web/infinispan/src/main/java/org/wildfly/clustering/web/infinispan/session/SimpleSessionMetaDataExternalizer.java

@@ -35,6 +35,7 @@
  */
 public class SimpleSessionMetaDataExternalizer extends AbstractSimpleExternalizer<SimpleSessionMetaData> {
     private static final long serialVersionUID = 1371677643229192026L;
+    private static final TimeUnit SERIALIZED_UNIT = TimeUnit.SECONDS;
 
     public SimpleSessionMetaDataExternalizer() {
         super(SimpleSessionMetaData.class);
@@ -44,14 +45,14 @@ public SimpleSessionMetaDataExternalizer() {
     public void writeObject(ObjectOutput output, SimpleSessionMetaData metaData) throws IOException {
         output.writeLong(metaData.getCreationTime().getTime());
         output.writeLong(metaData.getLastAccessedTime().getTime());
-        output.writeInt((int) metaData.getMaxInactiveInterval(TimeUnit.SECONDS));
+        output.writeInt((int) metaData.getMaxInactiveInterval(SERIALIZED_UNIT));
     }
 
     @Override
     public SimpleSessionMetaData readObject(ObjectInput input) throws IOException {
         Date creationTime = new Date(input.readLong());
         Date lastAccessedTime = new Date(input.readLong());
-        Time maxInactiveInterval = new Time(input.readInt(), TimeUnit.SECONDS);
+        Time maxInactiveInterval = new Time(input.readInt(), SERIALIZED_UNIT);
         return new SimpleSessionMetaData(creationTime, lastAccessedTime, maxInactiveInterval);
     }
 }

clustering/web/infinispan/src/main/java/org/wildfly/clustering/web/infinispan/session/Time.java

@@ -27,7 +27,7 @@
  * Struct for specifying a time duration.
  * @author Paul Ferraro
  */
-public class Time {
+public class Time implements Comparable<Time> {
     private final long value;
     private final TimeUnit unit;
 
@@ -48,6 +48,12 @@ public long convert(TimeUnit unit) {
         return unit.convert(this.value, this.unit);
     }
 
+    @Override
+    public int compareTo(Time time) {
+        TimeUnit compareUnit = TimeUnit.values()[Math.min(this.unit.ordinal(), time.unit.ordinal())];
+        return Long.compare(this.convert(compareUnit), time.convert(compareUnit));
+    }
+
     @Override
     public boolean equals(Object object) {
         if ((object == null) || !(object instanceof Time)) return false;

clustering/web/infinispan/src/test/java/org/wildfly/clustering/web/infinispan/session/InfinispanSessionTestCase.java

@@ -65,31 +65,11 @@ public void getId() {
     @Test
     public void getAttributes() {
         assertSame(this.attributes, this.session.getAttributes());
-
-        this.session.invalidate();
-
-        IllegalStateException exception = null;
-        try {
-            this.session.getAttributes();
-        } catch (IllegalStateException e) {
-            exception = e;
-        }
-        assertNotNull(exception);
     }
 
     @Test
     public void getMetaData() {
         assertSame(this.metaData, this.session.getMetaData());
-
-        this.session.invalidate();
-
-        IllegalStateException exception = null;
-        try {
-            this.session.getMetaData();
-        } catch (IllegalStateException e) {
-            exception = e;
-        }
-        assertNotNull(exception);
     }
 
     @Test

clustering/web/spi/src/main/java/org/wildfly/clustering/web/session/ActiveSessionStatistics.java

@@ -0,0 +1,39 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2015, Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags. See the copyright.txt file in the
+ * distribution for a full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+
+package org.wildfly.clustering.web.session;
+
+/**
+ * Statistics for active sessions.
+ * @author Paul Ferraro
+ */
+public interface ActiveSessionStatistics {
+    /**
+     * @return the maximum number of active sessions allowed by this session manager
+     */
+    int getMaxActiveSessions();
+
+    /**
+     * @return The number of active sessions
+     */
+    long getActiveSessionCount();
+}

clustering/web/spi/src/main/java/org/wildfly/clustering/web/session/InactiveSessionStatistics.java

@@ -0,0 +1,47 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2015, Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags. See the copyright.txt file in the
+ * distribution for a full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+
+package org.wildfly.clustering.web.session;
+
+import java.util.concurrent.TimeUnit;
+
+/**
+ * Statistics for inactive sessions.
+ * @author Paul Ferraro
+ */
+public interface InactiveSessionStatistics {
+
+    /**
+     * @return The number of expired sessions
+     */
+    long getExpiredSessionCount();
+
+    /**
+     * @return The longest a session has been alive using the specified unit
+     */
+    long getMaxSessionLifetime(TimeUnit unit);
+
+    /**
+     * @return The average session lifetime using the specified unit
+     */
+    long getMeanSessionLifetime(TimeUnit unit);
+}

clustering/web/spi/src/main/java/org/wildfly/clustering/web/session/SessionManager.java

@@ -28,7 +28,7 @@
 import org.wildfly.clustering.ee.Batcher;
 import org.wildfly.clustering.web.IdentifierFactory;
 
-public interface SessionManager<L, B extends Batch> extends IdentifierFactory<String> {
+public interface SessionManager<L, B extends Batch> extends IdentifierFactory<String>, ActiveSessionStatistics {
 
     /**
      * Indicates whether or not the session with the specified identifier is known to this session manager.