View Javadoc

1   /*
2    * Copyright 2006 University Corporation for Advanced Internet Development, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package edu.internet2.middleware.shibboleth.common.session;
18  
19  import java.io.Serializable;
20  
21  import javax.security.auth.Subject;
22  
23  import org.joda.time.DateTime;
24  
25  /** Session information for user currently logged in. */
26  public interface Session extends Serializable {
27  
28      /**
29       * Gets the unique identifier of the session.
30       * 
31       * @return unique identifier of the session
32       */
33      public String getSessionID();
34  
35      /**
36       * Gets the subject with which this session is associated.
37       * 
38       * @return subject with which this session is associated
39       */
40      public Subject getSubject();
41      
42      /**
43       * Sets the subject with which this session is associated.
44       * 
45       * @param newSubject the subject with which this session is associated
46       */
47      public void setSubject(Subject newSubject);
48  
49      /**
50       * A convenience method that gets the first principal retrieved from the {@link Subject}.
51       * 
52       * @return principal ID of the user, or null
53       */
54      public String getPrincipalName();
55  
56      /**
57       * Gets the session inactivity timeout in milliseconds.
58       * 
59       * @return session inactivity timeout in milliseconds
60       */
61      public long getInactivityTimeout();
62  
63      /**
64       * Gets the time of the last activity from the user.
65       * 
66       * @return time of the last activity from the user
67       */
68      public DateTime getLastActivityInstant();
69  
70      /**
71       * Sets the time of the last activity from the user.
72       * 
73       * @param lastActivity time of the last activity from the user
74       */
75      public void setLastActivityInstant(DateTime lastActivity);
76  }