Interface QuotaExhaustionAction


  • @SupportedAll
    public interface QuotaExhaustionAction
    Interface to define the resulting behavior when the session quota is exhausted.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean action​(org.forgerock.openam.session.Session session, Map<String,​Long> existingSessions, long surplusSessions)
      Performs an action, when the session quota is exhausted.
    • Method Detail

      • action

        boolean action​(org.forgerock.openam.session.Session session,
                       Map<String,​Long> existingSessions,
                       long surplusSessions)
        Performs an action, when the session quota is exhausted. The action implementation should destroy at least one session (either by destroying an old session, or rejecting the new one) in order to adhere the session quota.
        Parameters:
        session - the to-be-actived Session
        existingSessions - all existing sessions belonging to the same uuid (Map:sid->expiration_time)
        surplusSessions - the number of sessions in excess of the quota. Under normal circumstances should be 1
        Returns:
        true if the session activation request should be rejected, false otherwise