net.nuage.vsp.acs.client.api

Interface NuageVspManagerClient

All Superinterfaces:

NuageVspClient

All Known Implementing Classes:

NuageVspManagerClientImpl

public interface NuageVspManagerClient
extends NuageVspClient

Method Summary

Modifier and Type	Method and Description
void	addDomain(VspDomain vspDomain)
Pair<Boolean,String>	auditNuageVspCmsId(String nuageVspCmsId, boolean auditOnly) Audit a CMS ID
boolean	cleanUpDomain(VspDomainCleanUp vspDomainCleanUp) Clean up a domain
void	deleteDomain(VspDomain vspDomain)
VspApiDefaults	getApiDefaults() Get a map of configured defaults
List<VspDomainTemplate>	getDomainTemplates(VspDomain vspDomain, String filter) Lists all the VSP Domain templates for a domain.
List<NuageVspApiVersion>	getSupportedVersionList() Get supported VSD versions (list is sorted by version number
Map<NuageVspApiVersion,NuageVspApiVersion.Status>	getSupportedVersions() Get supported VSD versions (list is sorted by version number
boolean	isSupportedApiVersion(String version) Check if the API version is supported by the client and the vsd
String	registerNuageVspCmsId() Register a CMS ID
boolean	syncDomainWithNuageVsp(VspDomain vspDomain, boolean add, boolean remove) Deprecated. use addDomain/deleteDomain instead
boolean	unregisterNuageVspCmsId(String nuageVspCmsId) Unregister a CMS ID

Methods inherited from interface net.nuage.vsp.acs.client.api.NuageVspClient

getAttachedNetworkDetails, getAttachedNetworkDetails

Method Detail

auditNuageVspCmsId

Pair<Boolean,String> auditNuageVspCmsId(String nuageVspCmsId,
                                        boolean auditOnly)
                                 throws NuageVspException

Audit a CMS ID

Parameters:

nuageVspCmsId - The CMS ID to audit

auditOnly - True if audit only, false if modify allowed

Returns:

A pair of

Throws:

NuageVspException

registerNuageVspCmsId

String registerNuageVspCmsId()
                      throws NuageVspException

Register a CMS ID

Returns:

The registered CMS ID

Throws:

NuageVspException

unregisterNuageVspCmsId

boolean unregisterNuageVspCmsId(String nuageVspCmsId)
                         throws NuageVspException

Unregister a CMS ID

Parameters:

nuageVspCmsId - The CMS ID to unregister

Returns:

True if unregistration was successful, false if not

Throws:

NuageVspException

isSupportedApiVersion

boolean isSupportedApiVersion(String version)
                       throws NuageVspException

Check if the API version is supported by the client and the vsd

Parameters:

version - The API version to check

Returns:

True if supported, false if not

Throws:

NuageVspException

getApiDefaults

VspApiDefaults getApiDefaults()
                       throws NuageVspException

Get a map of configured defaults

Returns:

The map of configured defaults

Throws:

NuageVspException

syncDomainWithNuageVsp

@Deprecated
boolean syncDomainWithNuageVsp(VspDomain vspDomain,
                                           boolean add,
                                           boolean remove)
                                    throws NuageVspException

Deprecated. use addDomain/deleteDomain instead

Sync a domain

Parameters:

vspDomain - The domain to sync

add - True to add the domain

remove - True to remove the domain

Returns:

True if syncing was successful, false if not

Throws:

NuageVspException

addDomain

void addDomain(VspDomain vspDomain)
        throws NuageVspException

Throws:

NuageVspException

deleteDomain

void deleteDomain(VspDomain vspDomain)
           throws NuageVspException

Throws:

NuageVspException

cleanUpDomain

boolean cleanUpDomain(VspDomainCleanUp vspDomainCleanUp)
               throws NuageVspException

Clean up a domain

Parameters:

vspDomainCleanUp - The domain to clean up

Returns:

True if clean up successful, false if not

Throws:

NuageVspException

getDomainTemplates

List<VspDomainTemplate> getDomainTemplates(VspDomain vspDomain,
                                           String filter)
                                    throws NuageVspException

Lists all the VSP Domain templates for a domain.

Parameters:

vspDomain - The domain where to retrieve the list

Returns:

list of domain templates

Throws:

NuageVspException

getSupportedVersionList

List<NuageVspApiVersion> getSupportedVersionList()
                                          throws NuageVspException

Get supported VSD versions (list is sorted by version number

Returns:

list of all the versions the VSD knows and the status of the support for a the versions.

Throws:

NuageVspException

getSupportedVersions

Map<NuageVspApiVersion,NuageVspApiVersion.Status> getSupportedVersions()
                                                                throws NuageVspException

Get supported VSD versions (list is sorted by version number

Returns:

list of all the versions the VSD knows and the status of the support for a the versions.

Throws:

NuageVspException