org.openbaton.sdk.api.rest.VNFPackageAgent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
Openbaton libraries for integrating with the NFV Orchestrator NBI
The newest version!
/*
 * Copyright (c) 2016 Open Baton (http://www.openbaton.org)
 *
 * 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.openbaton.sdk.api.rest;

import java.io.File;
import org.apache.http.annotation.ThreadSafe;
import org.openbaton.catalogue.nfvo.VNFPackage;
import org.openbaton.sdk.api.annotations.Help;
import org.openbaton.sdk.api.exception.SDKException;
import org.openbaton.sdk.api.util.AbstractRestAgent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class is a Rest Request Agent for sending requests regarding VNFPackage objects to the NFVO
 * API. It is thread safe.
 */
@ThreadSafe
public class VNFPackageAgent extends AbstractRestAgent {

  private Logger log = LoggerFactory.getLogger(this.getClass());

  /**
   * @param username the username used for sending requests
   * @param password the password used for sending requests
   * @param projectId the NFVO Project's ID that will be used in the requests to the NFVO
   * @param sslEnabled true if the NFVO uses SSL
   * @param nfvoIp the IP address of the NFVO to which the requests are sent
   * @param nfvoPort the port on which the NFVO runs
   * @param version the API version
   */
  public VNFPackageAgent(
      String username,
      String password,
      String projectId,
      boolean sslEnabled,
      String nfvoIp,
      String nfvoPort,
      String version) {
    super(username, password, projectId, sslEnabled, nfvoIp, nfvoPort, version, VNFPackage.class);
  }

  /**
   * @param serviceName the service name used for sending requests
   * @param projectId the NFVO Project's ID that will be used in the requests to the NFVO
   * @param sslEnabled true if the NFVO uses SSL
   * @param nfvoIp the IP address of the NFVO to which the requests are sent
   * @param nfvoPort the port on which the NFVO runs
   * @param version the API version
   * @param serviceKey the key for authenticating the service
   * @throws IllegalArgumentException if the service key is null
   */
  public VNFPackageAgent(
      String serviceName,
      String projectId,
      boolean sslEnabled,
      String nfvoIp,
      String nfvoPort,
      String version,
      String serviceKey)
      throws IllegalArgumentException {
    super(
        serviceName,
        projectId,
        sslEnabled,
        nfvoIp,
        nfvoPort,
        version,
        serviceKey,
        VNFPackage.class);
  }

  /**
   * Use the create(String filePath) method instead.
   *
   * @param vnfPackage
   * @return null
   */
  @Override
  @Deprecated
  public VNFPackage create(VNFPackage vnfPackage) {
    log.warn(
        "The creation of VNFPackages in this way is not supported. Use the create(String filePath) method instead to upload a tar file.");
    return null;
  }

  /**
   * Uploads a VNFPackage to the NFVO.
   *
   * @param filePath the path to the tar file representing the VNFPackage
   * @return the uploaded VNFPackage
   * @throws SDKException
   */
  @Help(help = "Create a VNFPackage by uploading a tar file")
  public VNFPackage create(String filePath) throws SDKException {
    log.debug("Start uploading a VNFPackage using the tar at path " + filePath);
    File f = new File(filePath);
    if (f == null || !f.exists()) {
      log.error("No package: " + f.getName() + " found!");
      throw new SDKException(
          "No package: " + f.getName() + " found!",
          new StackTraceElement[0],
          "File " + filePath + " not existing");
    }
    return requestPostPackage(f);
  }
}