org.red5.server.api.statistics.IStatisticsService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ant-media-server Show documentation
Ant Media Server supports RTMP, RTSP, MP4, HLS, WebRTC, Adaptive Streaming, etc.
There is a newer version: 2.12.0
/*
 * RED5 Open Source Media Server - https://github.com/Red5/
 * 
 * Copyright 2006-2016 by respective authors (see below). All rights reserved.
 * 
 * Licensed 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.red5.server.api.statistics;

import java.util.Set;

import org.red5.server.api.scope.IScope;
import org.red5.server.api.so.ISharedObject;
import org.red5.server.exception.ScopeNotFoundException;
import org.red5.server.exception.SharedObjectException;

/**
 * Statistics methods for Red5. They can be used to poll for updates of given elements inside the server. Statistics data will be stored as properties of different shared objects.
 * 
 * Use
 * 
 *  * getScopeStatisticsSO
 * 
 * 
 * and
 * 
 *  * getSharedObjectStatisticsSO
 * 
 * 
 * to get these shared objects. The property names are
 * 
 *  * scopeName
 * 
 * 
 * for scope attributes and
 * 
 *  * scopeName | sharedObjectName
 * 
 * 
 * for shared object attributes. Each property holds a Map containing key/value mappings of the corresponding attributes.
 * 
 * Sometime in the future, the updates on the shared objects will be done automatically so a client doesn't need to poll for them.
 * 
 * @author The Red5 Project
 * @author Joachim Bauch ([email protected])
 */
public interface IStatisticsService {

    /**
     * Return the shared object that will be used to keep scope statistics.
     * 
     * @param scope
     *            A scope to return the shared object for.
     * @return the shared object containing scope statistics
     */
    public ISharedObject getScopeStatisticsSO(IScope scope);

    /**
     * Return the shared object that will be used to keep SO statistics.
     * 
     * @param scope
     *            A scope to return the shared object for.
     * @return the shared object containing SO statistics
     */
    public ISharedObject getSharedObjectStatisticsSO(IScope scope);

    /**
     * Return a list of all scopes that currently exist on the server.
     * 
     * @return list of scope names
     */
    public Set getScopes();

    /**
     * Return a list of all scopes that currently exist on the server below a current path.
     * 
     * @param path
     *            Path to start looking for scopes.
     * @return list of scope names
     * @throws ScopeNotFoundException
     *             if the path on the server doesn't exist
     */
    public Set getScopes(String path) throws ScopeNotFoundException;

    /**
     * Update statistics for a given scope.
     * 
     * @param path
     *            Path to scope to update.
     * @throws ScopeNotFoundException
     *             if the given scope doesn't exist
     */
    public void updateScopeStatistics(String path) throws ScopeNotFoundException;

    /**
     * Return informations about shared objects for a given scope.
     * 
     * @param path
     *            Path to scope to return shared object names for.
     * @return list of informations about shared objects
     */
    public Set getSharedObjects(String path);

    /**
     * Update informations about a shared object in a given scope.
     * 
     * @param path
     *            Path to scope that contains the shared object.
     * @param name
     *            Name of shared object to update.
     * @throws ScopeNotFoundException
     *             if the given scope doesn't exist
     * @throws SharedObjectException
     *             if no shared object with the given name exists
     */
    public void updateSharedObjectStatistics(String path, String name) throws ScopeNotFoundException, SharedObjectException;

}