net.nuage.vsp.acs.client.api.impl

Class NuageVspRestApi

java.lang.Object

net.nuage.vsp.acs.client.api.impl.NuageVspRestApi

public class NuageVspRestApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected VspHost	vspHost

Constructor Summary

Constructors

Constructor and Description
NuageVspRestApi(VspHost vspHost, NuageVspStatistics nuageVspStatistics)

Method Summary

Modifier and Type	Method and Description
protected static NuageVspFilter	createFilter(NuageVspAttribute filterAttr, Object filterAttrValue)
protected void	createHttpClient()
protected NuageVspObject	createNuageVspObject(NuageVspEntity entity)
protected NuageVspObject	createNuageVspObject(NuageVspEntity entity, String entityId)
NuageVspObject	createResource(NuageVspEntity parentEntityType, String parentEntityId, NuageVspObject childEntity)
NuageVspObject	createResource(NuageVspEntity parentEntityType, String parentEntityId, NuageVspObject childEntity, Boolean checkWarning, NuageVspUser proxyUser, NuageVspConstants.ErrorCode... retryNuageErrorCodes)
NuageVspObject	createResource(NuageVspEntity parentEntityType, String parentEntityId, NuageVspObject childEntity, String proxyUserUuid, String proxyUserDomainUuid)
NuageVspObject	createResource(NuageVspObject entity)
NuageVspObject	createResource(NuageVspObject parent, NuageVspObject child, NuageVspConstants.ErrorCode... retryNuageErrorCodes)
NuageVspObject	createResource(NuageVspObject entity, NuageVspUser proxyUser)
NuageVspObject	createResource(NuageVspObject entity, String proxyUserUuid, String proxyUserDomainUuid)
boolean	deleteQuietly(NuageVspEntity entityToBeCleaned, String entityIDToBeCleaned)
boolean	deleteQuietly(NuageVspObject entityToBeCleaned)
String	deleteResource(NuageVspEntity entityType, String entityId)
String	deleteResource(NuageVspObject nuageVspObject)
Pair<String,String>	executeNuageApi(NuageVspEntity entityType, String entityId, NuageVspEntity childEntityType, Object entityDetails, RequestType type, Boolean checkWarning, NuageVspPaging paging, NuageVspUser proxyUser) All Nuage APIs will be executed as CMS User in Nuage.
Pair<String,String>	executeNuageApi(NuageVspEntity entityType, String entityId, NuageVspEntity childEntityType, Object entityDetails, RequestType type, boolean checkWarning, NuageVspPaging paging, NuageVspUser proxyUser, String restRelativePath)
String	getChildResources(NuageVspEntity parentEntityType, String parentEntityId, NuageVspEntity nuageChildEntityType, NuageVspPaging paging)
NuageVspObject	getEntityByExternalId(NuageVspEntity entityType, String entityId, NuageVspEntity childEntityType, String externalId)
String	getEntityId(NuageVspEntity entityType, String jsonString)
NuageVspObject	getFirstJsonEntity(NuageVspEntity entityType, String jsonString)
String	getJsonString(Object entityDetails)
NuageVspObject	getOnlyJsonEntity(NuageVspEntity entityType, String jsonString)
NuageVspObject	getResource(NuageVspEntity nuageEntityType, String entityId)
String	getResource(NuageVspEntity nuageEntityType, String entityId, Boolean checkWarning)
String	getResources(NuageVspEntity nuageEntityType)
String	getResources(NuageVspEntity nuageEntityType, NuageVspFilter filter)
String	getResources(NuageVspEntity nuageEntityType, NuageVspPaging paging)
String	getResources(NuageVspEntity nuageEntityType, String entityId, NuageVspEntity nuageChildEntityType)
String	getResources(NuageVspEntity nuageEntityType, String entityId, NuageVspEntity nuageChildEntityType, NuageVspAttribute filterAttribute, Object filterValue)
String	getResources(NuageVspEntity nuageEntityType, String entityId, NuageVspEntity nuageChildEntityType, NuageVspFilter filter)
String	getResources(NuageVspObject nuageVspObject, NuageVspEntity nuageChildEntityType)
String	getResources(NuageVspObject nuageVspObject, NuageVspEntity nuageChildEntityType, NuageVspFilter filter)
protected static NuageVspApiException	handleException(String message, NuageVspException cause, Object... args)
boolean	isExistingResource(NuageVspEntity entity, String entityId)
boolean	linkRelatedEntity(NuageVspEntity nuageEntityType, String entityId, NuageVspEntity nuageChildEntityType, String nuageChildEntityId)
void	linkRelatedEntity(NuageVspObject nuageVspObject, NuageVspEntity nuageChildEntityType, String nuageChildEntityId)
void	login() Login will set the APIKey value for the CMS User.
List<NuageVspObject>	parseJsonString(NuageVspEntity nuageEntity, String jsonResult)
<T> T	parseJsonString(NuageVspEntity nuageEntity, String jsonResult, Type type)
String	resourceExists(NuageVspEntity nuageEntityType, String entityId, Boolean checkWarning)
protected boolean	saveLinkedEntities(NuageVspEntity nuageEntityType, String entityId, NuageVspEntity nuageChildEntityType, Set<String> oldNuageChildEntityIds, Set<String> newNuageChildEntityIds)
boolean	setRelatedEntities(NuageVspEntity nuageEntityType, String entityId, NuageVspEntity nuageChildEntityType, Set<String> nuageChildEntityIds)
boolean	setRelatedEntities(NuageVspObject nuageVspObject, NuageVspEntity nuageChildEntityType, Set<String> nuageChildEntityIds)
boolean	unlinkRelatedEntity(NuageVspEntity nuageEntityType, String entityId, NuageVspEntity nuageChildEntityType, String nuageChildEntityId)
String	updateResource(NuageVspEntity parentEntityType, String parentEntityId, NuageVspEntity childEntityType, Object childEntity)
String	updateResource(NuageVspObject nuageVspObject)

Methods inherited from class java.lang.Object

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

Field Detail

vspHost

protected VspHost vspHost

Constructor Detail

NuageVspRestApi

public NuageVspRestApi(VspHost vspHost,
                       NuageVspStatistics nuageVspStatistics)

Method Detail

createResource

public NuageVspObject createResource(NuageVspObject entity,
                                     NuageVspUser proxyUser)
                              throws NuageVspApiException

Throws:

NuageVspApiException

createResource

public NuageVspObject createResource(NuageVspEntity parentEntityType,
                                     String parentEntityId,
                                     NuageVspObject childEntity,
                                     Boolean checkWarning,
                                     NuageVspUser proxyUser,
                                     NuageVspConstants.ErrorCode... retryNuageErrorCodes)
                              throws NuageVspApiException

Throws:

NuageVspApiException

createResource

public NuageVspObject createResource(NuageVspObject entity)
                              throws NuageVspApiException

Throws:

NuageVspApiException

createResource

public NuageVspObject createResource(NuageVspObject entity,
                                     String proxyUserUuid,
                                     String proxyUserDomainUuid)
                              throws NuageVspApiException

Throws:

NuageVspApiException

createResource

public NuageVspObject createResource(NuageVspEntity parentEntityType,
                                     String parentEntityId,
                                     NuageVspObject childEntity)
                              throws NuageVspApiException

Throws:

NuageVspApiException

createResource

public NuageVspObject createResource(NuageVspEntity parentEntityType,
                                     String parentEntityId,
                                     NuageVspObject childEntity,
                                     String proxyUserUuid,
                                     String proxyUserDomainUuid)
                              throws NuageVspApiException

Throws:

NuageVspApiException

createResource

public NuageVspObject createResource(NuageVspObject parent,
                                     NuageVspObject child,
                                     NuageVspConstants.ErrorCode... retryNuageErrorCodes)
                              throws NuageVspApiException

Throws:

NuageVspApiException

updateResource

public String updateResource(NuageVspObject nuageVspObject)
                      throws NuageVspApiException

Throws:

NuageVspApiException

updateResource

public String updateResource(NuageVspEntity parentEntityType,
                             String parentEntityId,
                             NuageVspEntity childEntityType,
                             Object childEntity)
                      throws NuageVspApiException

Throws:

NuageVspApiException

deleteResource

public String deleteResource(NuageVspEntity entityType,
                             String entityId)
                      throws NuageVspApiException

Throws:

NuageVspApiException

deleteResource

public String deleteResource(NuageVspObject nuageVspObject)
                      throws NuageVspApiException

Throws:

NuageVspApiException

deleteQuietly

public boolean deleteQuietly(NuageVspObject entityToBeCleaned)

deleteQuietly

public boolean deleteQuietly(NuageVspEntity entityToBeCleaned,
                             String entityIDToBeCleaned)

getResources

public String getResources(NuageVspEntity nuageEntityType,
                           NuageVspPaging paging)
                    throws NuageVspApiException

Throws:

NuageVspApiException

getChildResources

public String getChildResources(NuageVspEntity parentEntityType,
                                String parentEntityId,
                                NuageVspEntity nuageChildEntityType,
                                NuageVspPaging paging)
                         throws NuageVspApiException

Throws:

NuageVspApiException

getResource

public String getResource(NuageVspEntity nuageEntityType,
                          String entityId,
                          Boolean checkWarning)
                   throws NuageVspApiException

Throws:

NuageVspApiException

resourceExists

public String resourceExists(NuageVspEntity nuageEntityType,
                             String entityId,
                             Boolean checkWarning)
                      throws NuageVspApiException

Throws:

NuageVspApiException

getResource

public NuageVspObject getResource(NuageVspEntity nuageEntityType,
                                  String entityId)
                           throws NuageVspApiException

Throws:

NuageVspApiException

getResources

public String getResources(NuageVspEntity nuageEntityType,
                           NuageVspFilter filter)
                    throws NuageVspApiException

Throws:

NuageVspApiException

getResources

public String getResources(NuageVspEntity nuageEntityType)
                    throws NuageVspApiException

Throws:

NuageVspApiException

getResources

public String getResources(NuageVspObject nuageVspObject,
                           NuageVspEntity nuageChildEntityType)
                    throws NuageVspApiException

Throws:

NuageVspApiException

getResources

public String getResources(NuageVspObject nuageVspObject,
                           NuageVspEntity nuageChildEntityType,
                           NuageVspFilter filter)
                    throws NuageVspApiException

Throws:

NuageVspApiException

getResources

public String getResources(NuageVspEntity nuageEntityType,
                           String entityId,
                           NuageVspEntity nuageChildEntityType)
                    throws NuageVspApiException

Throws:

NuageVspApiException

getResources

public String getResources(NuageVspEntity nuageEntityType,
                           String entityId,
                           NuageVspEntity nuageChildEntityType,
                           NuageVspFilter filter)
                    throws NuageVspApiException

Throws:

NuageVspApiException

getResources

public String getResources(NuageVspEntity nuageEntityType,
                           String entityId,
                           NuageVspEntity nuageChildEntityType,
                           NuageVspAttribute filterAttribute,
                           Object filterValue)
                    throws NuageVspApiException

Throws:

NuageVspApiException

saveLinkedEntities

protected boolean saveLinkedEntities(NuageVspEntity nuageEntityType,
                                     String entityId,
                                     NuageVspEntity nuageChildEntityType,
                                     Set<String> oldNuageChildEntityIds,
                                     Set<String> newNuageChildEntityIds)
                              throws NuageVspApiException

Throws:

NuageVspApiException

linkRelatedEntity

public void linkRelatedEntity(NuageVspObject nuageVspObject,
                              NuageVspEntity nuageChildEntityType,
                              String nuageChildEntityId)
                       throws NuageVspException

Throws:

NuageVspException

linkRelatedEntity

public boolean linkRelatedEntity(NuageVspEntity nuageEntityType,
                                 String entityId,
                                 NuageVspEntity nuageChildEntityType,
                                 String nuageChildEntityId)
                          throws NuageVspException

Throws:

NuageVspException

unlinkRelatedEntity

public boolean unlinkRelatedEntity(NuageVspEntity nuageEntityType,
                                   String entityId,
                                   NuageVspEntity nuageChildEntityType,
                                   String nuageChildEntityId)
                            throws NuageVspException

Throws:

NuageVspException

setRelatedEntities

public boolean setRelatedEntities(NuageVspObject nuageVspObject,
                                  NuageVspEntity nuageChildEntityType,
                                  Set<String> nuageChildEntityIds)
                           throws NuageVspException

Throws:

NuageVspException

setRelatedEntities

public boolean setRelatedEntities(NuageVspEntity nuageEntityType,
                                  String entityId,
                                  NuageVspEntity nuageChildEntityType,
                                  Set<String> nuageChildEntityIds)
                           throws NuageVspException

Throws:

NuageVspException

createFilter

protected static NuageVspFilter createFilter(NuageVspAttribute filterAttr,
                                             Object filterAttrValue)

getOnlyJsonEntity

public NuageVspObject getOnlyJsonEntity(NuageVspEntity entityType,
                                        String jsonString)
                                 throws NuageVspApiException

Throws:

NuageVspApiException

getFirstJsonEntity

public NuageVspObject getFirstJsonEntity(NuageVspEntity entityType,
                                         String jsonString)
                                  throws NuageVspApiException

Throws:

NuageVspApiException

getEntityByExternalId

public NuageVspObject getEntityByExternalId(NuageVspEntity entityType,
                                            String entityId,
                                            NuageVspEntity childEntityType,
                                            String externalId)
                                     throws NuageVspApiException

Throws:

NuageVspApiException

getEntityId

public String getEntityId(NuageVspEntity entityType,
                          String jsonString)
                   throws NuageVspApiException

Throws:

NuageVspApiException

executeNuageApi

public Pair<String,String> executeNuageApi(NuageVspEntity entityType,
                                           String entityId,
                                           NuageVspEntity childEntityType,
                                           Object entityDetails,
                                           RequestType type,
                                           boolean checkWarning,
                                           NuageVspPaging paging,
                                           NuageVspUser proxyUser,
                                           String restRelativePath)

executeNuageApi

public Pair<String,String> executeNuageApi(NuageVspEntity entityType,
                                           String entityId,
                                           NuageVspEntity childEntityType,
                                           Object entityDetails,
                                           RequestType type,
                                           Boolean checkWarning,
                                           NuageVspPaging paging,
                                           NuageVspUser proxyUser)
                                    throws NuageVspApiException

All Nuage APIs will be executed as CMS User in Nuage. This API uses proxy user API to view all the object that are permitted for the user in enterprise. Password of the CMS user will reset when the API fails with Authentication error. This is taken care by retry logic. Look at login() for more details

Parameters:

entityType -

entityId -

childEntityType -

entityDetails -

type -

checkWarning - TODO @return List that contains Map of attributes and their corresponding values

Throws:

Exception

NuageVspApiException

createHttpClient

protected void createHttpClient()

login

public void login()
           throws NuageVspApiException

Login will set the APIKey value for the CMS User. When any REST API call fails with AuthenticationException a retry will call login and set the correct APIKey. There is not retry for this API.

Throws:

NuageVspApiException

getJsonString

public String getJsonString(Object entityDetails)
                     throws NuageJsonParsingException

Throws:

NuageJsonParsingException

parseJsonString

public List<NuageVspObject> parseJsonString(NuageVspEntity nuageEntity,
                                            String jsonResult)
                                     throws NuageJsonParsingException,
                                            UnsupportedNuageEntityException

Throws:

NuageJsonParsingException

UnsupportedNuageEntityException

parseJsonString

public <T> T parseJsonString(NuageVspEntity nuageEntity,
                             String jsonResult,
                             Type type)
                      throws NuageJsonParsingException,
                             UnsupportedNuageEntityException

Throws:

NuageJsonParsingException

UnsupportedNuageEntityException

createNuageVspObject

protected NuageVspObject createNuageVspObject(NuageVspEntity entity)

createNuageVspObject

protected NuageVspObject createNuageVspObject(NuageVspEntity entity,
                                              String entityId)

handleException

protected static NuageVspApiException handleException(String message,
                                                      NuageVspException cause,
                                                      Object... args)

isExistingResource

public boolean isExistingResource(NuageVspEntity entity,
                                  String entityId)