aboutsummaryrefslogtreecommitdiffstats
path: root/adapters/mso-openstack-adapters/src/main/java/org/onap/so/heatbridge/factory/MsoCloudClientFactory.java
blob: edf5e2d33970b064bed5e8a67634e8106f8ca930 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/*
 * Copyright (C) 2018 Bell Canada. All rights reserved.
 *
 * 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.onap.so.heatbridge.factory;

import org.onap.so.heatbridge.HeatBridgeException;
import org.onap.so.heatbridge.openstack.api.OpenstackClient;

/**
 * Defines contract to load the cloud configuration from SO, authenticate with keystone for a given cloud-region and
 * tenant.
 */
public interface MsoCloudClientFactory {

    /**
     * Get the Openstack Client for keystone version specified in cloud configuration.
     *
     * @param url openstack url
     * @param msoId openstack user for mso
     * @param msoPass openstack password for mso user
     * @param cloudRegionId cloud-region identifier
     * @param tenantId tenant identifier
     * @return Openstack Client for the keystone version requested
     * @throws HeatBridgeException if any errors when reading cloud configuration or getting openstack client
     */


    OpenstackClient getOpenstackClient(String url, String msoId, String msoPass, String cloudRegionId, String tenantId)
            throws HeatBridgeException;
}