src/org/apache/openmeetings/session/ISessionManager.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License") +  you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.openmeetings.session;

import java.util.Collection;
import java.util.List;

import org.apache.openmeetings.data.beans.basic.SearchResult;
import org.apache.openmeetings.persistence.beans.basic.Server;
import org.apache.openmeetings.persistence.beans.room.Client;
import org.apache.openmeetings.remote.red5.ScopeApplicationAdapter;

/**
 * Methods to add/get/remove {@link Client}s to the session
 * 
 * 
 * @author sebawagner
 *
 */
public interface ISessionManager {
	
	/**
	 * Notified on server start, when the session manager should be started and
	 * eventually caches cleared/setup
	 */
	public abstract void sessionStart();

	/**
	 * add a new client item
	 * 
	 * @param streamId
	 * @param scopeName
	 * @param remotePort
	 * @param remoteAddress
	 * @param swfUrl
	 * @param isAVClient
	 * @param server
	 * @return
	 */
	public abstract Client addClientListItem(String streamId,
			String scopeName, Integer remotePort, String remoteAddress,
			String swfUrl, boolean isAVClient, Server server);

	public abstract Collection<Client> getClients();
	
	/**
	 * loads the server into the client (only if database cache is used)
	 * 
	 * @return
	 */
	public abstract Collection<Client> getClientsWithServer();

	/**
	 * Get a client by its streamId
	 * 
	 * @param streamId
	 * @param server
	 * @return
	 */
	public abstract Client getClientByStreamId(String streamId,
			Server server);

	/**
	 * get a client by its publicSID and the server, 
	 * isAVClient is normally false, as you want the data connection.
	 * If you set isAVClient to true, you would obtain the RTMP 
	 * connection that is used for Audio/Video streaming
	 * 
	 * @param publicSID
	 * @param isAVClient
	 * @param server
	 * @return
	 */
	public abstract Client getClientByPublicSID(String publicSID,
			boolean isAVClient, Server server);
	
	/**
	 * same as {@link #getClientByPublicSID(String, boolean, Server)} but it ignores 
	 * if the server part, so it will deliver any client just by its publicSID.<br/>
	 * <br/>
	 * <b>Note:</b>
	 * This method requires more time to find the user, so under normal circumstances 
	 * you should use {@link #getClientByPublicSID(String, boolean, Server)}!
	 * 
	 * @param publicSID
	 * @param isAVClient
	 * @return
	 */
	public ClientSessionInfo getClientByPublicSIDAnyServer(String publicSID, boolean isAVClient);

	/**
	 * 
	 * @param userId
	 * @return
	 * 
	 * @deprecated There could be multiple users logged in with the same userid,
	 *             then this call would return a list not a single user
	 */
	public abstract Client getClientByUserId(Long userId);

	/**
	 * Update the session object of the audio/video-connection and additionally
	 * swap the values to the session object of the user that holds the full
	 * session object
	 * 
	 * @param streamId
	 * @param rcm
	 * @return
	 */
	public abstract Boolean updateAVClientByStreamId(String streamId,
			Client rcm, Server server);

	/**
	 * Update the session object
	 * 
	 * updateRoomCount is only <i>one</i> time true, in
	 * {@link ScopeApplicationAdapter#setRoomValues(Long, Boolean, Boolean, Long, String)}
	 * .
	 * 
	 * @param streamId
	 * @param rcm
	 * @param updateRoomCount
	 *            true means the count for the room has to be updated
	 * @return
	 */
	public abstract Boolean updateClientByStreamId(String streamId,
			Client rcm, boolean updateRoomCount, Server server);

	/**
	 * Remove a client from the session store
	 * 
	 * @param streamId
	 * @return
	 */
	public abstract Boolean removeClient(String streamId, Server server);

	/**
	 * Get all ClientList Objects of that room and domain This Function is
	 * needed cause it is invoked internally AFTER the current user has been
	 * already removed from the ClientList to see if the Room is empty again and
	 * the PollList can be removed
	 * @param room_id 
	 * @return
	 */
	public abstract List<Client> getClientListByRoom(Long room_id);
	
	public abstract Collection<Client> getClientListByRoomAll(Long room_id);

	/**
	 * get the current Moderator in this room
	 * 
	 * @param roomname
	 * @return
	 */
	public abstract List<Client> getCurrentModeratorByRoom(Long room_id);

	/**
	 * Get list of current client sessions
	 * 
	 * @param start
	 * @param max
	 * @param orderby
	 * @param asc
	 * @return
	 */
	public abstract SearchResult<Client> getListByStartAndMax(int start,
			int max, String orderby, boolean asc);

	/**
	 * returns number of current users recording
	 * 
	 * @param roomId
	 * @return
	 */
	public abstract long getRecordingCount(long roomId);

	/**
	 * returns a number of current users publishing screensharing
	 * 
	 * @param roomId
	 * @return
	 */
	public abstract long getPublishingCount(long roomId);
	
	/**
	 * Get a list of all servers of all rooms on that server, serverId = null 
	 * means it is a local session on the master.
	 * 
	 * @param server
	 * @return a set, a roomId can be only one time in this list
	 */
	public abstract List<Long> getActiveRoomIdsByServer(Server server);

	/**
	 * Get some statistics about the current sessions
	 * 
	 * @return
	 */
	public abstract String getSessionStatistics();

}