org.kurento.repository.RepositoryClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kurento-repository-client Show documentation
The Kurento Repository Client project publishes a Java API to repository services in Kurento.
There is a newer version: 6.14.0
Show newest version
/*
 * (C) Copyright 2013 Kurento (http://kurento.org/)
 *
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the GNU Lesser General Public License (LGPL)
 * version 2.1 which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/lgpl-2.1.html
 *
 * This library 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 Lesser General Public License for more
 * details.
 */

package org.kurento.repository;

import java.util.Map;
import java.util.Set;

import org.kurento.repository.service.pojo.RepositoryItemPlayer;
import org.kurento.repository.service.pojo.RepositoryItemRecorder;

import retrofit.client.Response;
import retrofit.http.Body;
import retrofit.http.DELETE;
import retrofit.http.GET;
import retrofit.http.POST;
import retrofit.http.PUT;
import retrofit.http.Path;

/**
 * Client API for the Kurento repository server application. It uses REST as means of communicating
 * with the server.
 *
 * @author Radu Tom Vlad
 */
public interface RepositoryClient {

  /**
   * Creates a new repository item with the provided metadata, ready for media recording.
   * 
   * @param metadata
   *          a map of values. Can be empty but not null.
   * @return a {@link RepositoryItemRecorder} containing the item's id and an URL through which
   *         Kurento Media Server can record media sent by the client
   */
  @POST("/repo/item")
  RepositoryItemRecorder createRepositoryItem(@Body Map metadata);

  /**
   * Removes the repository item associated to the provided id.
   * 
   * @param itemId
   *          the id of an existing repository item
   * @return a {@link Response} containing the response code from the server
   */
  @DELETE("/repo/item/{itemId}")
  Response removeRepositoryItem(@Path("itemId") String itemId);

  /**
   * Obtains a new endpoint for reading (playing multimedia) from the repository item.
   * 
   * @param itemId
   *          the id of an existing repository item
   * @return a {@link RepositoryItemPlayer} containing the item's id and an URL from which Kurento
   *         Media Server can play (serve) stored media streams
   */
  @GET("/repo/item/{itemId}")
  RepositoryItemPlayer getReadEndpoint(@Path("itemId") String itemId);

  /**
   * Searches for repository items by each pair of attributes and their expected values.
   * 
   * @param searchValues
   *          pairs of attributes and their values
   * @return a {@link Set}<{@link String}> with identifiers of the repository items that were
   *         found
   */
  @POST("/repo/item/find")
  Set simpleFindItems(@Body Map searchValues);

  /**
   * Searches for repository items by each pair of attributes whose values can be regex Strings.
   * 
   * @param searchValues
   *          pairs of attributes and their values
   * @return a {@link Set}<{@link String}> with identifiers of the repository items that were
   *         found
   */
  @POST("/repo/item/find/regex")
  Set regexFindItems(@Body Map searchValues);

  /**
   * Returns the metadata from a repository item.
   * 
   * @param itemId
   *          the id of an existing repository item
   * @return the metadata map
   */
  @GET("/repo/item/{itemId}/metadata")
  Map getRepositoryItemMetadata(@Path("itemId") String itemId);

  /**
   * Replaces the metadata of a repository item.
   * 
   * @param itemId
   *          the id of an existing repository item
   * @param metadata
   *          the new metadata
   * @return a {@link Response} with the response code from the server
   */
  @PUT("/repo/item/{itemId}/metadata")
  Response setRepositoryItemMetadata(@Path("itemId") String itemId,
      @Body Map metadata);

}