/*
 * Copyright 2007-2010 Sun Microsystems, Inc.
 *
 * This file is part of Project Darkstar Server.
 *
 * Project Darkstar Server is free software: you can redistribute it
 * and/or modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation and
 * distributed hereunder to you.
 *
 * Project Darkstar Server is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Sun designates this particular file as subject to the "Classpath"
 * exception as provided by Sun in the LICENSE file that accompanied
 * this code.
 *
 * --
 */

package com.sun.sgs.management;

import com.sun.sgs.service.ClientSessionService;

/**
 * The management interface for the client session service.
 * <p>
 * An instance implementing this MBean can be obtained from the from the 
 * {@link java.lang.management.ManagementFactory.html#getPlatformMBeanServer() 
 * getPlatformMBeanServer} method.
 * <p>
 * The {@code ObjectName} for uniquely identifying this MBean is
 * {@value #MXBEAN_NAME}.
 * 
 */
public interface ClientSessionServiceMXBean {
    /** The name for uniquely identifying this MBean. */
    String MXBEAN_NAME = "com.sun.sgs.service:type=ClientSessionService";
    
    // Maybe add number of active clients in the system, number
    // of connects/disconnects?
    // number of channels a client is connected to
    // amount of communications traffic this client sends/receives?
    
    /**
     * Returns the number of times {@link 
     * ClientSessionService#addSessionStatusListener
     * addSessionStatusListener} has been called.
     * 
     * @return the number of times {@code addSessionStatusListener} 
     *         has been called
     */
    long getAddSessionStatusListenerCalls();
    
    /**
     * Returns the number of times {@link 
     * ClientSessionService#getSessionProtocol getSessionProtocol}
     * has been called.
     * 
     * @return the number of times {@code getSessionProtocol} 
     *         has been called
     */
    long getGetSessionProtocolCalls();

    /**
     * Returns the number of times {@link
     * ClientSessionService#isRelocatingToLocalNode
     * isRelocatingToLocalNode} has been called.
     * 
     * @return the number of times {@code isRelocatingToLocalNode} 
     *         has been called
     */
    long getIsRelocatingToLocalNodeCalls();
}