Interface EditSessionListener


  • public interface EditSessionListener
    All Edit Session listeners are invoked when one of these actions occur: a user logs in, a user logs out or the session of a user times out. Register a service like any other service in the Activator of a Plugin, implementing this interface and these three callback methods will be invoked on the service implementation.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void onLogin​(javax.servlet.http.HttpSession session, String userName)
      Invoked just after a user logged in.
      void onLogout​(javax.servlet.http.HttpSession session, String userName)
      Invoked just before a user logs out.
      void onSessionTimeout​(javax.servlet.http.HttpSession session, String userName)
      Invoked when the session of a user has timed out.
    • Method Detail

      • onLogin

        void onLogin​(javax.servlet.http.HttpSession session,
                     String userName)
        Invoked just after a user logged in. The method is invoked immediately after a successful login. If a login is not successful, this method is not invoked.
        Parameters:
        session - The http session that was just created for the user
        userName - Name of the user that just logged in
      • onLogout

        void onLogout​(javax.servlet.http.HttpSession session,
                      String userName)
        Invoked just before a user logs out.
        Parameters:
        session - Http session that is about to be closed for the user
        userName - Name of the user that is about to log out
      • onSessionTimeout

        void onSessionTimeout​(javax.servlet.http.HttpSession session,
                              String userName)
        Invoked when the session of a user has timed out. Note that this session is not valid anymore. You can retrieve attributes from the session, but you cannot use it to invoke the XC API.
        Parameters:
        session - Http session that just timed out
        userName - Name of the user assigned to the session that just timed out