kurento-java.rar

[](http://www.apache.org/licenses/LICENSE-2.0) [](http://doc-kurento.readthedocs.org/en/latest/) [](https://hub.docker.com/r/fiware/stream-oriented-kurento/) [](http://stackoverflow.com/questions/tagged/kurento) [![][KurentoImage]][Kurento] Copyright © 2013-2016 [Kurento]. Licensed under [Apache 2.0 License]. kurento-repository-server ========================= The server module of Kurento Repository is a [Spring Boot][SpringBoot] application which exposes the configured media repository through an easy-to-use Http REST API. This module can also be integrated into existing applications instead of a standalone execution. The application will have access to a Java API which wraps around the repository internal library. There is a Kurento Java [tutorial application][helloworld-repository] that employs a running instance of this server to record and play media over HTTP using the capabilities of the Kurento Media Server. Table of Contents ----------------- - [Running the server](#running-the-server) - [Dependencies](#dependencies) - [Binaries](#binaries) - [Configuration](#configuration) - [Logging configuration](#logging-configuration) - [Execution](#execution) - [Run at user-level](#run-at-user-level) - [Run as daemon](#run-as-daemon) - [Version upgrade](#version-upgrade) - [Installation over MongoDB](#installation-over-mongodb) - [Http REST API](#http-rest-api) - [Create repository item](#create-repository-item) - [Remove repository item](#remove-repository-item) - [Get repository item read endpoint](#get-repository-item-read-endpoint) - [Find repository items by metadata](#find-repository-items-by-metadata) - [Find repository items by metadata regex](#find-repository-items-by-metadata-regex) - [Get the metadata of a repository item](#get-the-metadata-of-a-repository-item) - [Update the metadata of a repository item](#update-the-metadata-of-a-repository-item) - [Repository Rest Java API](#repository-rest-java-api) - [What is Kurento](#what-is-kurento) Running the server ------------------ ### Dependencies * Ubuntu 14.04 LTS * [Java JDK][Java] version 7 or 8 * [MongoDB][mongo] (we provide an install [guide](#installation-over-mongodb)) * Kurento Media Server or connection with a running instance (to install follow the [official guide][kurento-install]) ### Binaries To build the installation binaries from the source code you'll need to have installed on your machine [Git][Git], [Java JDK][Java] and [Maven][Maven]. Clone the parent project, `kurento-java` from its [GitHub Repository][GitHub Kurento Java]. ``` $ git clone [email protected]:Kurento/kurento-java.git ``` Then build the `kurento-repository-server` project together with its required modules: ``` $ cd kurento-java $ mvn clean package -DskipTests -Pdefault -am \ -pl kurento-repository/kurento-repository-server ``` Now unzip the generated install binaries (where `x.y.z` is the current version and could include the `-SNAPSHOT` suffix): ``` $ cd kurento-repository/kurento-repository-server/target $ unzip kurento-repository-server-x.y.z.zip ``` ### Configuration The configuration file, `kurento-repo.conf.json` is located in the `config` folder inside the uncompressed installation binaries. When installing the repository as a system service, the configuration files will be located after the installation inside `/etc/kurento`. ``` $ cd kurento-repository-server-x.y.z $ vim config/kurento-repo.conf.json ``` The default contents of the configuration file: ```json { "repository": { "port": 7676, "hostname": "127.0.0.1", //mongodb or filesystem "type": "mongodb", "mongodb": { "dbName": "kurento", "gridName": "kfs", "urlConn": "mongodb://localhost" }, "filesystem": { "folder": "/tmp/repository" } } } ``` These properties and their values will configure the repository application. * `port` and `hostname` are where the HTTP repository servlet will be listening for incoming connections (REST API). * `type` indicates the storage type. The repository that stores media served by KMS can be backed by GridFS on MongoDB or it can use file storage directly on the system’s disks (regular filesystem). * `mongodb` configuration: * `dbname` is the database name * `gridName` is the name of the gridfs collection used for the repository * `urlConn` is the connection to the Mongo database * `filesystem` configuration: * `folder` is a local path to be used as media storage #### Logging configuration The logging configuration is specified by the file `kurento-repo-log4j.properties`, also found in the `config` folder. ``` $ cd kurento-repository-server-x.y.z $ vim config/kurento-repo-log4j.properties ``` In it, the location of the server's output log file can be set up, the default location will be `kurento-repository-server-x.y.z/logs/` (or `/var/log/kurento/` for system-wide installations). To change it, replace the `${kurento-repo.log.file}` variable for an absolute path on your system: ``` log4j.appender.file.File=${kurento-repo.log.file} ``` ### Execution There are two options for running the server: * user-level execution - doesn’t need additional installation steps, can be done right after uncompressing the installer * system-level execution - requires installation of the repository application as a system service, which enables automatic startup after system reboots In both cases, as the application uses the [Spring Boot][SpringBoot] framework, it executes inside an embedded Tomcat container instance, so there’s no need for extra deployment actions (like using a third-party servlet container). If required, the project's build configuration could be modified in order to generate a *WAR* instead of a *JAR*. #### Run at user-level After having [configured](#configuration) the server instance just execute the start script: ``` $ cd kurento-repository-server-x.y.z $ ./bin/start.sh ``` #### Run as daemon First install the repository after having built and uncompressed the generating binaries. **sudo** privileges are required to install it as a service: ``` $ cd kurento-repository-server-x.y.z $ sudo ./bin/install.sh ``` The service **kurento-repo** will be automatically started. Now, you can configure the repository as stated in the [previous section](#configuration) and restart the service. ``` $ sudo service kurento-repo {start|stop|status|restart|reload} ``` ### Version upgrade To update to a newer version, it suffices to follow once again the installation procedures. ### Installation over MongoDB For the sake of testing *kurento-repository* on Ubuntu (*14.04 LTS 64 bits*), the default installation of MongoDB is enough. Execute the following commands (from MongoDB [webpage][mongo-install]): ``` $ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 7F0CEB10 $ echo "deb http://repo.mongodb.org/apt/ubuntu \ "$(lsb_release -sc)"/mongodb-org/3.0 multiverse" \ | sudo tee /etc/apt/sources.list.d/mongodb-org-3.0.list $ sudo apt-get update $ sudo apt-get install -y mongodb-org ``` Http REST API ------------- Primitives provided by the repository server, can be used to control items from the respository (*add*, *delete*, *search*, *update*, *get download URL*). ### Create repository item **Description** Creates a new repository item with the provided metadata and its associated recorder endpoint. **Request method and URL** ``` POST /repo/item ``` **Request Content-Type** ``` application/json ``` **Request parameters** Pairs of key-value Strin