edu.internet2.middleware.shibboleth.common.session
Interface Session

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractSession

public interface Session
extends Serializable

Session information for user currently logged in.


Method Summary
 long getInactivityTimeout()
          Gets the session inactivity timeout in milliseconds.
 DateTime getLastActivityInstant()
          Gets the time of the last activity from the user.
 String getPrincipalName()
          A convenience method that gets the first principal retrieved from the Subject.
 String getSessionID()
          Gets the unique identifier of the session.
 Subject getSubject()
          Gets the subject with which this session is associated.
 void setLastActivityInstant(DateTime lastActivity)
          Sets the time of the last activity from the user.
 void setSubject(Subject newSubject)
          Sets the subject with which this session is associated.
 

Method Detail

getSessionID

String getSessionID()
Gets the unique identifier of the session.

Returns:
unique identifier of the session

getSubject

Subject getSubject()
Gets the subject with which this session is associated.

Returns:
subject with which this session is associated

setSubject

void setSubject(Subject newSubject)
Sets the subject with which this session is associated.

Parameters:
newSubject - the subject with which this session is associated

getPrincipalName

String getPrincipalName()
A convenience method that gets the first principal retrieved from the Subject.

Returns:
principal ID of the user, or null

getInactivityTimeout

long getInactivityTimeout()
Gets the session inactivity timeout in milliseconds.

Returns:
session inactivity timeout in milliseconds

getLastActivityInstant

DateTime getLastActivityInstant()
Gets the time of the last activity from the user.

Returns:
time of the last activity from the user

setLastActivityInstant

void setLastActivityInstant(DateTime lastActivity)
Sets the time of the last activity from the user.

Parameters:
lastActivity - time of the last activity from the user


Copyright © 2006-2010 Internet2. All Rights Reserved.