org.openbaton.sdk.api.rest.KeyAgent 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 org.openbaton.catalogue.security.Key;
import org.openbaton.sdk.api.annotations.Help;
import org.openbaton.sdk.api.exception.SDKException;
import org.openbaton.sdk.api.util.AbstractRestAgent;

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

  /**
   * @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 KeyAgent(
      String username,
      String password,
      String projectId,
      boolean sslEnabled,
      String nfvoIp,
      String nfvoPort,
      String version) {
    super(username, password, projectId, sslEnabled, nfvoIp, nfvoPort, version, Key.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 KeyAgent(
      String serviceName,
      String projectId,
      boolean sslEnabled,
      String nfvoIp,
      String nfvoPort,
      String version,
      String serviceKey)
      throws IllegalArgumentException {
    super(serviceName, projectId, sslEnabled, nfvoIp, nfvoPort, version, serviceKey, Key.class);
  }

  /**
   * Use the generateKey method instead.
   *
   * @param key do not use this method!
   * @return null
   */
  @Override
  @Deprecated
  public Key create(Key key) {
    return null;
  }

  /**
   * Generate a new Key in the NFVO.
   *
   * @param name the name of the new Key
   * @return the private Key
   * @throws SDKException if the request fails
   */
  @Help(help = "Generate a new Key in the NFVO")
  public String generateKey(String name) throws SDKException {
    return (String) requestPost("generate", name);
  }

  /**
   * Import a Key into the NFVO by providing name and public key.
   *
   * @param name the name of the Key
   * @param publicKey the public Key
   * @return the imported Key
   * @throws SDKException if the request fails
   */
  @Help(help = "Import a Key into the NFVO by providing name and public key")
  public Key importKey(String name, String publicKey) throws SDKException {
    Key key = new Key();
    key.setName(name);
    key.setPublicKey(publicKey);
    return (Key) requestPost(key);
  }

  @Override
  @Deprecated
  public Key update(Key key, String id) {
    return null;
  }
}