001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
005 *
006 * The contents of this file are subject to the terms
007 * of the Common Development and Distribution License
008 * (the License). You may not use this file except in
009 * compliance with the License.
010 *
011 * You can obtain a copy of the License at
012 * https://opensso.dev.java.net/public/CDDLv1.0.html or
013 * opensso/legal/CDDLv1.0.txt
014 * See the License for the specific language governing
015 * permission and limitations under the License.
016 *
017 * When distributing Covered Code, include this CDDL
018 * Header Notice in each file and include the License file
019 * at opensso/legal/CDDLv1.0.txt.
020 * If applicable, add the following below the CDDL Header,
021 * with the fields enclosed by brackets [] replaced by
022 * your own identifying information:
023 * "Portions Copyrighted [year] [name of copyright owner]"
024 *
025 * $Id: QuotaExhaustionAction.java,v 1.2 2008/06/25 05:41:30 qcheng Exp $
026 *
027 */
028/**
029 * Portions Copyrighted 2011-2013 ForgeRock, Inc.
030 */
031package com.iplanet.dpro.session.service;
032
033import java.util.Map;
034
035/**
036 * Interface to define the resulting behavior when the session quota is exhausted.
037 *
038 * @supported.all.api
039 */
040public interface QuotaExhaustionAction {
041
042    /**
043     * Performs an action, when the session quota is exhausted. The action implementation should destroy at least one
044     * session (either by destroying an old session, or rejecting the new one) in order to adhere the session quota.
045     *
046     * @param is the to-be-actived InternalSession
047     * @param existingSessions all existing sessions belonging to the same uuid (Map:sid->expiration_time)
048     * @return <code>true</code> if the session activation request should be rejected, <code>false</code> otherwise
049     */
050    public boolean action(InternalSession is, Map<String, Long> existingSessions);
051}