org.red5.server.stream.DefaultStreamFilenameGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of red5-server-common Show documentation
Classes common for multiple red5 projects
There is a newer version: 2.0.12
/*
 * RED5 Open Source Media Server - https://github.com/Red5/ Copyright 2006-2023 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.stream;

import org.red5.server.api.scope.IScope;
import org.red5.server.api.stream.IStreamFilenameGenerator;
import org.red5.server.util.ScopeUtils;

/**
 * Default filename generator for streams. The files will be stored in a directory "streams" in the application folder. Option for changing directory streams are saved to is investigated as of 0.6RC1.
 *
 * @author The Red5 Project
 * @author Joachim Bauch ([email protected])
 */
public class DefaultStreamFilenameGenerator implements IStreamFilenameGenerator {

    /**
     * Generate stream directory based on relative scope path. The base directory is
     *
     *      * streams
     * 
     *
     * , e.g. a scope
     *
     *      * /application/one/two/
     * 
     *
     * will generate a directory
     *
     *      * /streams/one/two/
     * 
     *
     * inside the application.
     *
     * @param scope
     *            Scope
     * @return Directory based on relative scope path
     */
    private String getStreamDirectory(IScope scope) {
        final StringBuilder result = new StringBuilder();
        final IScope app = ScopeUtils.findApplication(scope);
        final String prefix = "streams/";
        while (scope != null && scope != app) {
            result.insert(0, scope.getName() + "/");
            scope = scope.getParent();
        }
        if (result.length() == 0) {
            return prefix;
        } else {
            result.insert(0, prefix).append('/');
            return result.toString();
        }
    }

    /** {@inheritDoc} */
    public String generateFilename(IScope scope, String name, GenerationType type) {
        return generateFilename(scope, name, null, type);
    }

    /** {@inheritDoc} */
    public String generateFilename(IScope scope, String name, String extension, GenerationType type) {
        String result = getStreamDirectory(scope) + name;
        if (extension != null && !extension.equals("")) {
            result += extension;
        }
        return result;
    }

    /**
     * The default filenames are relative to the scope path, so always return
     *
     *      * false
     * 
     *
     * .
     *
     * @return always
     *
     *              * false
     * 
     */
    public boolean resolvesToAbsolutePath() {
        return false;
    }

}