All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opencastproject.publication.oaipmh.remote.OaiPmhPublicationServiceRemoteImpl Maven / Gradle / Ivy

There is a newer version: 16.7
Show newest version
/*
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community 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://opensource.org/licenses/ecl2.txt
 *
 * 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.opencastproject.publication.oaipmh.remote;

import static java.lang.String.format;
import static java.nio.charset.StandardCharsets.UTF_8;

import org.opencastproject.job.api.Job;
import org.opencastproject.job.api.JobParser;
import org.opencastproject.mediapackage.MediaPackage;
import org.opencastproject.mediapackage.MediaPackageElement;
import org.opencastproject.mediapackage.MediaPackageElementFlavor;
import org.opencastproject.mediapackage.MediaPackageElementParser;
import org.opencastproject.mediapackage.MediaPackageException;
import org.opencastproject.mediapackage.MediaPackageParser;
import org.opencastproject.mediapackage.Publication;
import org.opencastproject.publication.api.OaiPmhPublicationService;
import org.opencastproject.publication.api.PublicationException;
import org.opencastproject.security.api.TrustedHttpClient;
import org.opencastproject.serviceregistry.api.RemoteBase;
import org.opencastproject.serviceregistry.api.ServiceRegistry;

import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.http.HttpResponse;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.message.BasicNameValuePair;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Set;

/**
 * A remote publication service invoker.
 */
@Component(
    immediate = true,
    service = OaiPmhPublicationService.class,
    property = {
        "service.description=Publication (OAI-PMH) Remote Service Proxy"
    }
)
public class OaiPmhPublicationServiceRemoteImpl extends RemoteBase implements OaiPmhPublicationService {

  /** The logger */
  private static final Logger logger = LoggerFactory.getLogger(OaiPmhPublicationServiceRemoteImpl.class);

  public OaiPmhPublicationServiceRemoteImpl() {
    super(JOB_TYPE);
  }

  @Override
  public Job publish(
      MediaPackage mediaPackage,
      String repository,
      Set downloadIds,
      Set streamingIds,
      boolean checkAvailability
  ) throws PublicationException, MediaPackageException {
    final String mediapackageXml = MediaPackageParser.getAsXml(mediaPackage);
    final List params = new ArrayList();
    params.add(new BasicNameValuePair("mediapackage", mediapackageXml));
    params.add(new BasicNameValuePair("channel", repository));
    params.add(new BasicNameValuePair("downloadElementIds", StringUtils.join(downloadIds, SEPARATOR)));
    params.add(new BasicNameValuePair("streamingElementIds", StringUtils.join(streamingIds, SEPARATOR)));
    params.add(new BasicNameValuePair("checkAvailability", Boolean.toString(checkAvailability)));
    final HttpPost post = new HttpPost();
    HttpResponse response = null;
    try {
      post.setEntity(new UrlEncodedFormEntity(params, UTF_8));
      response = getResponse(post);
      if (response != null) {
        logger.info("Publishing media package {} to OAI-PMH channel {} using a remote publication service",
                mediaPackage, repository);
        try {
          return JobParser.parseJob(response.getEntity().getContent());
        } catch (Exception e) {
          throw new PublicationException(
              "Unable to publish media package '" + mediaPackage + "' using a remote OAI-PMH publication service", e);
        }
      }
    } catch (Exception e) {
      throw new PublicationException(
              "Unable to publish media package " + mediaPackage + " using a remote OAI-PMH publication service.", e);
    } finally {
      closeConnection(response);
    }
    throw new PublicationException(
            "Unable to publish mediapackage " + mediaPackage + " using a remote OAI-PMH publication service.");
  }

  @Override
  public Job replace(
      MediaPackage mediaPackage,
      String repository,
      Set downloadElements,
      Set streamingElements,
      Set retractDownloadFlavors,
      Set retractStreamingFlavors,
      Set publications,
      boolean checkAvailability
  ) throws PublicationException {
    HttpResponse response = null;
    try {
      final String mediapackageXml = MediaPackageParser.getAsXml(mediaPackage);
      final String downloadElementsXml = MediaPackageElementParser.getArrayAsXml(downloadElements);
      final String streamingElementsXml = MediaPackageElementParser.getArrayAsXml(streamingElements);
      final String retractDownloadFlavorsString = StringUtils.join(retractDownloadFlavors, SEPARATOR);
      final String retractStreamingFlavorsString = StringUtils.join(retractStreamingFlavors, SEPARATOR);
      final String publicationsXml = MediaPackageElementParser.getArrayAsXml(publications);
      final List params = Arrays.asList(
              new BasicNameValuePair("mediapackage", mediapackageXml),
              new BasicNameValuePair("channel", repository),
              new BasicNameValuePair("downloadElements", downloadElementsXml),
              new BasicNameValuePair("streamingElements", streamingElementsXml),
              new BasicNameValuePair("retractDownloadFlavors", retractDownloadFlavorsString),
              new BasicNameValuePair("retractStreamingFlavors", retractStreamingFlavorsString),
              new BasicNameValuePair("publications", publicationsXml),
              new BasicNameValuePair("checkAvailability", Boolean.toString(checkAvailability)));
      final HttpPost post = new HttpPost("replace");
      post.setEntity(new UrlEncodedFormEntity(params, UTF_8));
      response = getResponse(post);
      if (response != null) {
        logger.info("Replace media package {} in OAI-PMH channel {} using a remote publication service", mediaPackage,
            repository);

        return JobParser.parseJob(response.getEntity().getContent());
      }
    } catch (final Exception e) {
      throw new PublicationException(
              "Unable to replace media package " + mediaPackage + " using a remote OAI-PMH publication service.", e);
    } finally {
      closeConnection(response);
    }
    throw new PublicationException(
            "Unable to replace media package " + mediaPackage + " using a remote OAI-PMH publication service.");
  }

  @Override
  public Publication replaceSync(
      MediaPackage mediaPackage,
      String repository,
      Set downloadElements,
      Set streamingElements,
      Set retractDownloadFlavors,
      Set retractStreamingFlavors,
      Set publications,
      boolean checkAvailability
  ) throws PublicationException {
    HttpResponse response = null;
    try {
      final String mediapackageXml = MediaPackageParser.getAsXml(mediaPackage);
      final String downloadElementsXml = MediaPackageElementParser.getArrayAsXml(downloadElements);
      final String streamingElementsXml = MediaPackageElementParser.getArrayAsXml(streamingElements);
      final String retractDownloadFlavorsString = StringUtils.join(retractDownloadFlavors, SEPARATOR);
      final String retractStreamingFlavorsString = StringUtils.join(retractStreamingFlavors, SEPARATOR);
      final String publicationsXml = MediaPackageElementParser.getArrayAsXml(publications);
      final List params = Arrays.asList(
          new BasicNameValuePair("mediapackage", mediapackageXml),
          new BasicNameValuePair("channel", repository),
          new BasicNameValuePair("downloadElements", downloadElementsXml),
          new BasicNameValuePair("streamingElements", streamingElementsXml),
          new BasicNameValuePair("retractDownloadFlavors", retractDownloadFlavorsString),
          new BasicNameValuePair("retractStreamingFlavors", retractStreamingFlavorsString),
          new BasicNameValuePair("publications", publicationsXml),
          new BasicNameValuePair("checkAvailability", Boolean.toString(checkAvailability)));
      final HttpPost post = new HttpPost("replacesync");
      post.setEntity(new UrlEncodedFormEntity(params, UTF_8));
      response = getResponse(post);
      if (response != null) {
        logger.info("Replace media package {} in OAI-PMH channel {} using a remote publication service", mediaPackage,
            repository);

        final String xml = IOUtils.toString(response.getEntity().getContent(), Charset.forName("utf-8"));
        return (Publication) MediaPackageElementParser.getFromXml(xml);
      }
    } catch (final Exception e) {
      throw new PublicationException(
          "Unable to replace media package " + mediaPackage + " using a remote OAI-PMH publication service.", e);
    } finally {
      closeConnection(response);
    }
    throw new PublicationException(
        "Unable to replace media package " + mediaPackage + " using a remote OAI-PMH publication service.");
  }

  @Override
  public Job retract(MediaPackage mediaPackage, String repository) throws PublicationException {
    String mediapackageXml = MediaPackageParser.getAsXml(mediaPackage);
    List params = new ArrayList();
    params.add(new BasicNameValuePair("mediapackage", mediapackageXml));
    params.add(new BasicNameValuePair("channel", repository));
    HttpPost post = new HttpPost("/retract");
    HttpResponse response = null;
    post.setEntity(new UrlEncodedFormEntity(params, UTF_8));
    try {
      response = getResponse(post);
      Job receipt = null;
      if (response != null) {
        logger.info("Retracting {} from OAI-PMH channel {} using a remote publication service",
                mediaPackage.getIdentifier().toString(), repository);
        try {
          receipt = JobParser.parseJob(response.getEntity().getContent());
          return receipt;
        } catch (Exception e) {
          throw new PublicationException(format(
              "Unable to retract media package %s from OAI-PMH channel %s using a remote publication service",
              mediaPackage.getIdentifier().toString(), repository), e);
        }
      }
    } finally {
      closeConnection(response);
    }
    throw new PublicationException(format(
        "Unable to retract media package %s from OAI-PMH channel %s using a remote publication service",
        mediaPackage.getIdentifier().toString(), repository));
  }

  @Override
  public Job updateMetadata(
      MediaPackage mediaPackage,
      String repository,
      Set flavors,
      Set tags,
      boolean checkAvailability
  ) throws PublicationException {
    final String mediapackageXml = MediaPackageParser.getAsXml(mediaPackage);
    final List params = new ArrayList<>();
    params.add(new BasicNameValuePair("mediapackage", mediapackageXml));
    params.add(new BasicNameValuePair("channel", repository));
    params.add(new BasicNameValuePair("flavors", StringUtils.join(flavors, SEPARATOR)));
    params.add(new BasicNameValuePair("tags", StringUtils.join(tags, SEPARATOR)));
    params.add(new BasicNameValuePair("checkAvailability", Boolean.toString(checkAvailability)));
    final HttpPost post = new HttpPost("/updateMetadata");
    HttpResponse response = null;
    try {
      post.setEntity(new UrlEncodedFormEntity(params, UTF_8));
      response = getResponse(post);
      if (response != null) {
        logger.info("Update media package {} metadata in OAI-PMH channel {} using a remote publication service",
            mediaPackage.getIdentifier().toString(), repository);
        return JobParser.parseJob(response.getEntity().getContent());
      }
    } catch (Exception e) {
      throw new PublicationException(format(
          "Unable to update media package %s metadata in OAI-PMH repository %s using a remote publication service.",
          mediaPackage.getIdentifier().toString(), repository), e);
    } finally {
      closeConnection(response);
    }
    throw new PublicationException(format(
        "Unable to update media package %s metadata in OAI-PMH repository %s using a remote publication service.",
        mediaPackage.getIdentifier().toString(), repository));
  }

  @Reference
  @Override
  public void setTrustedHttpClient(TrustedHttpClient trustedHttpClient) {
    super.setTrustedHttpClient(trustedHttpClient);
  }
  @Reference
  @Override
  public void setRemoteServiceManager(ServiceRegistry serviceRegistry) {
    super.setRemoteServiceManager(serviceRegistry);
  }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy