Class GroovySession

  • All Implemented Interfaces:
    ISession, groovy.lang.GroovyObject

    @Scriptable
    public final class GroovySession
    extends groovy.lang.GroovyObjectSupport
    implements ISession
    • Constructor Detail

      • GroovySession

        public GroovySession​(ISession p_session)
    • Method Detail

      • getAuthConfigName

        public String getAuthConfigName()
        Description copied from interface: ISession
        Get the name of the authentication configuration used to login this session.
        Specified by:
        getAuthConfigName in interface ISession
        Returns:
        The name of the authentication configuration.
      • containsKey

        public boolean containsKey​(String p_strKey)
        Description copied from interface: ISession
        Test if a certain session variable exists.
        Specified by:
        containsKey in interface ISession
        Parameters:
        p_strKey - The name of the session variable.
      • get

        public Object get​(String p_strKey)
        Description copied from interface: ISession
        Get a session variable.
        Specified by:
        get in interface ISession
        Parameters:
        p_strKey - The name of the session variable.
        Returns:
        The session variable.
      • get

        public Object get​(String p_strKey,
                          Object p_objFallback)
        Description copied from interface: ISession
        Get a session variable or the specified fallback value.
        Specified by:
        get in interface ISession
        Parameters:
        p_strKey - The name of the session variable.
        p_objFallback - The fallback value that's being used if the session variable does not exist.
        Returns:
        The session variable.
      • put

        public void put​(String p_strKey,
                        Object p_objValue)
        Description copied from interface: ISession
        Set a session variable.
        Specified by:
        put in interface ISession
        Parameters:
        p_strKey - The name of the session variable.
        p_objValue - The value of the session variable.
      • remove

        public void remove​(String p_strKey)
        Description copied from interface: ISession
        Remove a session variable.
        Specified by:
        remove in interface ISession
        Parameters:
        p_strKey - The name of the session variable to be removed.
      • getCreationTime

        public long getCreationTime()
        Description copied from interface: ISession
        Get the time when this session was created.
        Specified by:
        getCreationTime in interface ISession
        Returns:
        The creation time, measured in milliseconds, between the current time and 01-01-1970 00:00:00 UTC.
      • getId

        public String getId()
        Description copied from interface: ISession
        Get the unique session identifier.
        Specified by:
        getId in interface ISession
      • getSubject

        public Subject getSubject()
        Description copied from interface: ISession
        Get the subject that is associated with this session.
        Specified by:
        getSubject in interface ISession
        Returns:
        The associated subject.
      • getTimeout

        public long getTimeout()
        Description copied from interface: ISession
        Get the session timeout.
        Specified by:
        getTimeout in interface ISession
        Returns:
        p_lTimeout The timeout in milliseconds.
      • getUser

        public IUser getUser()
        Description copied from interface: ISession
        Get the user that is associated with the session.
        Specified by:
        getUser in interface ISession
        Returns:
        The user that is associated with this session, or null.
      • isAnonymous

        public boolean isAnonymous()
        Description copied from interface: ISession
        Determine if the session is an anonymous session.
        Specified by:
        isAnonymous in interface ISession
        Returns:
        true if the session is anonymous, false otherwise.
      • isLoggedOut

        public boolean isLoggedOut()
        Description copied from interface: ISession
        Check if the session is logged out.
        Specified by:
        isLoggedOut in interface ISession
        Returns:
        true is the session is logged out, or false otherwise.
      • getLastAccessTime

        public long getLastAccessTime()
        Description copied from interface: ISession
        Get the time of the last access to this session.
        Specified by:
        getLastAccessTime in interface ISession
        Returns:
        The time of last access.
      • isStale

        public boolean isStale()
        Description copied from interface: ISession
        Check if the session has timed out.

        The natural implementation of this method will return isStale(System.currentTimeMillis()).

        Specified by:
        isStale in interface ISession
        Returns:
        true if the session already has timed out, false otherwise.
      • isStale

        public boolean isStale​(long p_lTimeNow)
        Description copied from interface: ISession
        Test if the session has timed out.
        Specified by:
        isStale in interface ISession
        Returns:
        true if the session has timed out, false otherwise.
      • keySet

        public Set<String> keySet()
        Description copied from interface: ISession
        Get a set that contains all session variable names.
        Specified by:
        keySet in interface ISession
        Returns:
        A set wit all session variables.
      • logout

        public void logout()
        Description copied from interface: ISession
        Performs a logout on this session.
        Specified by:
        logout in interface ISession
      • setTimeout

        public void setTimeout​(long p_lTimeout)
        Description copied from interface: ISession
        Set the session timeout.
        Specified by:
        setTimeout in interface ISession
        Parameters:
        p_lTimeout - The timeout in milliseconds.
      • touch

        public void touch()
        Description copied from interface: ISession
        Touch the session.
        Specified by:
        touch in interface ISession
      • addListener

        public void addListener​(de.uplanet.lucy.server.session.ISessionListener p_listener,
                                boolean p_bWeak)
        Description copied from interface: ISession
        Add a listener for session events.
        Specified by:
        addListener in interface ISession
        Parameters:
        p_listener - The session listener to add.
        p_bWeak - true if the listener should be weakly referenced, false otherwise.
      • getProperty

        public Object getProperty​(String p_strKey)
        Specified by:
        getProperty in interface groovy.lang.GroovyObject
        Overrides:
        getProperty in class groovy.lang.GroovyObjectSupport
      • setProperty

        public void setProperty​(String p_strKey,
                                Object p_value)
        Specified by:
        setProperty in interface groovy.lang.GroovyObject
        Overrides:
        setProperty in class groovy.lang.GroovyObjectSupport
      • putAt

        public void putAt​(String p_strKey,
                          Object p_value)