org.openecomp.mso.openstack.utils

Class MsoKeystoneUtils

java.lang.Object

org.openecomp.mso.openstack.utils.MsoCommonUtils

org.openecomp.mso.openstack.utils.MsoTenantUtils

org.openecomp.mso.openstack.utils.MsoKeystoneUtils

public class MsoKeystoneUtils
extends MsoTenantUtils

Field Summary

Fields inherited from class org.openecomp.mso.openstack.utils.MsoTenantUtils

cloudConfig, cloudConfigFactory, msoPropFactory, msoProps

Fields inherited from class org.openecomp.mso.openstack.utils.MsoCommonUtils

alarmLogger, retryCodesDefault, retryCodesProp, retryCountDefault, retryCountProp, retryDelayDefault, retryDelayProp

Constructor Summary

Constructors

Constructor and Description
MsoKeystoneUtils(String msoPropID)

Method Summary

Modifier and Type	Method and Description
static void	adminCacheCleanup() Clean up the Admin client cache to remove expired entries.
static void	adminCacheReset() Reset the Admin client cache.
String	createTenant(String tenantName, String cloudSiteId, Map<String,String> metadata, boolean backout) Create a tenant with the specified name in the given cloud.
boolean	deleteTenant(String tenantId, String cloudSiteId) Delete the specified Tenant (by ID) in the given cloud.
boolean	deleteTenantByName(String tenantName, String cloudSiteId) Delete the specified Tenant (by Name) in the given cloud.
com.woorea.openstack.keystone.model.Tenant	findTenantByName(com.woorea.openstack.keystone.Keystone adminClient, String tenantName)
com.woorea.openstack.keystone.model.Tenant	findTenantByNameOrId(com.woorea.openstack.keystone.Keystone adminClient, String tenantNameOrId)
com.woorea.openstack.keystone.model.User	findUserByName(com.woorea.openstack.keystone.Keystone adminClient, String userName)
com.woorea.openstack.keystone.Keystone	getKeystoneAdminClient(CloudSite cloudSite)
MsoTenant	queryTenant(String tenantId, String cloudSiteId) Query for a tenant by ID in the given cloud.
MsoTenant	queryTenantByName(String tenantName, String cloudSiteId) Query for a tenant with the specified name in the given cloud.

Methods inherited from class org.openecomp.mso.openstack.utils.MsoCommonUtils

executeAndRecordOpenstackRequest, executeAndRecordOpenstackRequest, heatExceptionToMsoException, isNullOrEmpty, keystoneErrorToMsoException, neutronExceptionToMsoException, runtimeExceptionToMsoException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MsoKeystoneUtils

public MsoKeystoneUtils(String msoPropID)

Method Detail

createTenant

public String createTenant(String tenantName,
                           String cloudSiteId,
                           Map<String,String> metadata,
                           boolean backout)
                    throws MsoException

Create a tenant with the specified name in the given cloud. If the tenant already exists, an Exception will be thrown. The MSO User will also be added to the "member" list of the new tenant to perform subsequent Nova/Heat commands in the tenant. If the MSO User association fails, the entire transaction will be rolled back.

For the AIC Cloud (DCP/LCP): it is not clear that cloudId is needed, as all admin requests go to the centralized identity service in DCP. However, if some artifact must exist in each local LCP instance as well, then it will be needed to access the correct region.

Specified by:

createTenant in class MsoTenantUtils

Parameters:

tenantName - The tenant name to create

cloudId - The cloud identifier (may be a region) in which to create the tenant.

Returns:

the tenant ID of the newly created tenant

Throws:

MsoTenantAlreadyExists - Thrown if the requested tenant already exists

MsoOpenstackException - Thrown if the Openstack API call returns an exception

MsoException

queryTenant

public MsoTenant queryTenant(String tenantId,
                             String cloudSiteId)
                      throws MsoException,
                             MsoCloudSiteNotFound

Query for a tenant by ID in the given cloud. If the tenant exists, return an MsoTenant object. If not, return null.

For the AIC Cloud (DCP/LCP): it is not clear that cloudId is needed, as all admin requests go to the centralized identity service in DCP. However, if some artifact must exist in each local LCP instance as well, then it will be needed to access the correct region.

Specified by:

queryTenant in class MsoTenantUtils

Parameters:

tenantId - The Openstack ID of the tenant to query

cloudSiteId - The cloud identifier (may be a region) in which to query the tenant.

Returns:

the tenant properties of the queried tenant, or null if not found

Throws:

MsoOpenstackException - Thrown if the Openstack API call returns an exception

MsoException

MsoCloudSiteNotFound

queryTenantByName

public MsoTenant queryTenantByName(String tenantName,
                                   String cloudSiteId)
                            throws MsoException

Query for a tenant with the specified name in the given cloud. If the tenant exists, return an MsoTenant object. If not, return null. This query is useful if the client knows it has the tenant name, skipping an initial lookup by ID that would always fail.

For the AIC Cloud (DCP/LCP): it is not clear that cloudId is needed, as all admin requests go to the centralized identity service in DCP. However, if some artifact must exist in each local LCP instance as well, then it will be needed to access the correct region.

Specified by:

queryTenantByName in class MsoTenantUtils

Parameters:

tenantName - The name of the tenant to query

cloudSiteId - The cloud identifier (may be a region) in which to query the tenant.

Returns:

the tenant properties of the queried tenant, or null if not found

Throws:

MsoOpenstackException - Thrown if the Openstack API call returns an exception

MsoException

deleteTenant

public boolean deleteTenant(String tenantId,
                            String cloudSiteId)
                     throws MsoException

Delete the specified Tenant (by ID) in the given cloud. This method returns true or false, depending on whether the tenant existed and was successfully deleted, or if the tenant already did not exist. Both cases are treated as success (no Exceptions).

Note for the AIC Cloud (DCP/LCP): all admin requests go to the centralized identity service in DCP. So deleting a tenant from one cloudSiteId will remove it from all sites managed by that identity service.

Specified by:

deleteTenant in class MsoTenantUtils

Parameters:

tenantId - The Openstack ID of the tenant to delete

cloudSiteId - The cloud identifier from which to delete the tenant.

Returns:

true if the tenant was deleted, false if the tenant did not exist.

Throws:

MsoOpenstackException - If the Openstack API call returns an exception.

MsoException

deleteTenantByName

public boolean deleteTenantByName(String tenantName,
                                  String cloudSiteId)
                           throws MsoException

Delete the specified Tenant (by Name) in the given cloud. This method returns true or false, depending on whether the tenant existed and was successfully deleted, or if the tenant already did not exist. Both cases are treated as success (no Exceptions).

Note for the AIC Cloud (DCP/LCP): all admin requests go to the centralized identity service in DCP. So deleting a tenant from one cloudSiteId will remove it from all sites managed by that identity service.

Parameters:

tenantName - The name of the tenant to delete

cloudSiteId - The cloud identifier from which to delete the tenant.

Returns:

true if the tenant was deleted, false if the tenant did not exist.

Throws:

MsoOpenstackException - If the Openstack API call returns an exception.

MsoException

getKeystoneAdminClient

public com.woorea.openstack.keystone.Keystone getKeystoneAdminClient(CloudSite cloudSite)
                                                              throws MsoException

Throws:

MsoException

findTenantByNameOrId

public com.woorea.openstack.keystone.model.Tenant findTenantByNameOrId(com.woorea.openstack.keystone.Keystone adminClient,
                                                                       String tenantNameOrId)

findTenantByName

public com.woorea.openstack.keystone.model.Tenant findTenantByName(com.woorea.openstack.keystone.Keystone adminClient,
                                                                   String tenantName)

findUserByName

public com.woorea.openstack.keystone.model.User findUserByName(com.woorea.openstack.keystone.Keystone adminClient,
                                                               String userName)

adminCacheCleanup

public static void adminCacheCleanup()

Clean up the Admin client cache to remove expired entries.

adminCacheReset

public static void adminCacheReset()

Reset the Admin client cache. This may be useful if cached credentials get out of sync.