/jboss-as-7.1.1.Final/clustering/web-spi/src/main/java/org/jboss/as/clustering/web/OutgoingDistributableSessionData.java

 1/*
 2 * JBoss, Home of Professional Open Source.
 3 * Copyright 2008, Red Hat Middleware LLC, and individual contributors
 4 * as indicated by the @author tags. See the copyright.txt file in the
 5 * distribution for a full listing of individual contributors.
 6 *
 7 * This is free software; you can redistribute it and/or modify it
 8 * under the terms of the GNU Lesser General Public License as
 9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22
23package org.jboss.as.clustering.web;
24
25/**
26 * Encapsulates the types of data about a session that can be stored to a distributed cache, except for the attributes. How to
27 * obtain the attributes, if available, would be specified via a subinterface.
28 * @author Brian Stansberry
29 */
30public interface OutgoingDistributableSessionData {
31    /**
32     * Gets the session id with any appended jvmRoute info removed.
33     */
34    String getRealId();
35
36    /**
37     * Gets the session's version.
38     */
39    int getVersion();
40
41    /**
42     * Gets the timestamp of the most recent session access.
43     */
44    Long getTimestamp();
45
46    /**
47     * Gets the other session metadata besides the version and timestamp.
48     */
49    DistributableSessionMetadata getMetadata();
50}