adapters/mso-openstack-adapters/src/main/java/org/onap/so/heatbridge/factory/MsoCloudClientFactory.java

   1 /*
   2  * Copyright (C) 2018 Bell Canada. All rights reserved.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.onap.so.heatbridge.factory;
  17
  18 import org.onap.so.heatbridge.HeatBridgeException;
  19 import org.onap.so.heatbridge.openstack.api.OpenstackClient;
  20
  21 /**
  22  * Defines contract to load the cloud configuration from SO, authenticate with keystone for a given cloud-region and
  23  * tenant.
  24  */
  25 public interface MsoCloudClientFactory {
  26
  27     /**
  28      * Get the Openstack Client for keystone version specified in cloud configuration.
  29      *
  30      * @param url openstack url
  31      * @param msoId openstack user for mso
  32      * @param msoPass openstack password for mso user
  33      * @param cloudRegionId cloud-region identifier
  34      * @param tenantId tenant identifier
  35      * @return Openstack Client for the keystone version requested
  36      * @throws HeatBridgeException if any errors when reading cloud configuration or getting openstack client
  37      */
  38
  39
  40     OpenstackClient getOpenstackClient(String url, String msoId, String msoPass, String cloudRegionId, String tenantId) throws HeatBridgeException;
  41 }