org.kurento.repository.RepositoryClientProvider 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.nio.file.Path;
import java.nio.file.Paths;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.base.StandardSystemProperty;

import retrofit.RestAdapter;

/**
 * Factory to create {@link RepositoryClient} that can be used to access services offered by a
 * repository server application. It requires the repository's service URL for REST communications,
 * which can be configured by means of reading properties from well-known locations (see
 * {@link RepositoryUrlLoader}), or directly when instantiating the provider.
 *
 * @author Micael Gallego
 * @author Radu Tom Vlad
 */
public class RepositoryClientProvider {

  private static final Logger log = LoggerFactory.getLogger(RepositoryClientProvider.class);

  private static RepositoryUrlLoader repositoryUrlLoader;

  private RepositoryClient restService;

  /**
   * Creates a provider for clients to a server instance. The repository URL is searched for in
   * properties from well-known locations.
   * 
   * @return a factory of {@link RepositoryClient}
   */
  public static RepositoryClientProvider createProvider() {
    return createProvider(getRepositoryUrl());
  }

  /**
   * Creates a client to a server instance. The repository URL of the client provider is searched
   * for in properties from well-known locations.
   * 
   * @return a {@link RepositoryClient}
   */
  public static RepositoryClient create() {
    return create(getRepositoryUrl());
  }

  /**
   * Creates a provider for clients to a server instance.
   * 
   * @param repoRestUrl
   *          the repository server URL (where the server expects REST connections)
   * @return a factory of {@link RepositoryClient}
   */
  public static RepositoryClientProvider createProvider(String repoRestUrl) {
    RepositoryClientProvider provider = new RepositoryClientProvider();
    RestAdapter restAdapter = new RestAdapter.Builder().setEndpoint(repoRestUrl).build();
    provider.restService = restAdapter.create(RepositoryClient.class);
    log.info("Rest client service created for {}", repoRestUrl);
    return provider;
  }

  /**
   * Creates a client to a server instance found on the provided URL.
   * 
   * @param repoRestUrl
   *          the repository server URL (where the server expects REST connections)
   * @return a {@link RepositoryClient}
   */
  public static RepositoryClient create(String repoRestUrl) {
    return createProvider(repoRestUrl).getRepositoryClient();
  }

  private RepositoryClientProvider() {
  }

  /**
   * @return a {@link RepositoryClient} to communicate with a repository server instance
   */
  public RepositoryClient getRepositoryClient() {
    return restService;
  }

  private synchronized static String getRepositoryUrl() {

    if (repositoryUrlLoader == null) {

      Path configFile =
          Paths.get(StandardSystemProperty.USER_HOME.value(), ".kurento", "config.properties");

      repositoryUrlLoader = new RepositoryUrlLoader(configFile);
    }

    return repositoryUrlLoader.getRepositoryUrl();
  }
}