org.openbaton.sdk.api.rest

Class NetworkServiceDescriptorRestAgent

java.lang.Object

org.openbaton.sdk.api.util.RestRequest

org.openbaton.sdk.api.util.AbstractRestAgent<org.openbaton.catalogue.mano.descriptor.NetworkServiceDescriptor>

org.openbaton.sdk.api.rest.NetworkServiceDescriptorRestAgent

public class NetworkServiceDescriptorRestAgent
extends AbstractRestAgent<org.openbaton.catalogue.mano.descriptor.NetworkServiceDescriptor>

OpenBaton network-service-descriptor-related api requester.

Field Summary

Fields inherited from class org.openbaton.sdk.api.util.RestRequest

baseUrl, mapper

Constructor Summary

Constructors

Constructor and Description
NetworkServiceDescriptorRestAgent(java.lang.String username, java.lang.String password, java.lang.String projectId, boolean sslEnabled, java.lang.String nfvoIp, java.lang.String nfvoPort, java.lang.String path, java.lang.String version) Create a NetworkServiceDescriptor requester with a given url path

Method Summary

Methods

Modifier and Type	Method and Description
org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor	createPhysicalNetworkFunctionDescriptor(java.lang.String idNSD, org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor physicalNetworkFunctionDescriptor) Store the PhysicalNetworkFunctionDescriptor
org.openbaton.catalogue.mano.common.Security	createSecurity(java.lang.String idNSD, org.openbaton.catalogue.mano.common.Security security) Store the Security into NSD
org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor	createVNFD(java.lang.String idNSD, org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor virtualNetworkFunctionDescriptor) Deprecated.
org.openbaton.catalogue.mano.descriptor.VNFDependency	createVNFDependency(java.lang.String idNSD, org.openbaton.catalogue.mano.descriptor.VNFDependency vnfDependency) Create a VNFDependency
void	deletePhysicalNetworkFunctionDescriptor(java.lang.String idNSD, java.lang.String idPnf) Delete the PhysicalNetworkFunctionDescriptor with the idPnf
void	deleteSecurity(java.lang.String idNSD, java.lang.String id_s) Delete the Security with the id_s
void	deleteVirtualNetworkFunctionDescriptors(java.lang.String idNSD, java.lang.String id_vfn) Deprecated.
void	deleteVNFDependency(java.lang.String idNSD, java.lang.String id_vnfd) Delets a VNFDependency
org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor	getPhysicalNetworkFunctionDescriptor(java.lang.String idNSD, java.lang.String idPnf) Returns the PhysicalNetworkFunctionDescriptor into a NSD with id
java.util.List<org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor>	getPhysicalNetworkFunctionDescriptors(java.lang.String idNSD) Return the list of PhysicalNetworkFunctionDescriptor into a NSD with id
org.openbaton.catalogue.mano.common.Security	getSecurities(java.lang.String idNSD) Return the Security into a NSD
org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor	getVirtualNetworkFunctionDescriptor(java.lang.String idNSD, java.lang.String id_vfn) Deprecated.
java.util.List<org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor>	getVirtualNetworkFunctionDescriptors(java.lang.String idNSD) Deprecated.
java.util.List<org.openbaton.catalogue.mano.descriptor.VNFDependency>	getVNFDependencies(java.lang.String idNSD) Return the list of VNFDependencies into a NSD
org.openbaton.catalogue.mano.descriptor.VNFDependency	getVNFDependency(java.lang.String idNSD, java.lang.String id_vnfd) Return a VNFDependency into a NSD
org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor	updatePNFD(java.lang.String idNSD, java.lang.String idPnf, org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor physicalNetworkFunctionDescriptor) Update the PhysicalNetworkFunctionDescriptor
org.openbaton.catalogue.mano.common.Security	updateSecurity(java.lang.String idNSD, java.lang.String id_s, org.openbaton.catalogue.mano.common.Security security) Update the Security into NSD
org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor	updateVNFD(java.lang.String idNSD, java.lang.String id_vfn, org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor virtualNetworkFunctionDescriptor) Deprecated.
org.openbaton.catalogue.mano.descriptor.VNFDependency	updateVNFD(java.lang.String idNSD, java.lang.String id_vnfd, org.openbaton.catalogue.mano.descriptor.VNFDependency vnfDependency) Update the VNFDependency

Methods inherited from class org.openbaton.sdk.api.util.AbstractRestAgent

create, delete, findAll, findById, getClazz, update

Methods inherited from class org.openbaton.sdk.api.util.RestRequest

getProjectId, requestDelete, requestGet, requestGetAll, requestGetWithStatusAccepted, requestPost, requestPost, requestPost, requestPost, requestPostPackage, requestPut, setProjectId

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkServiceDescriptorRestAgent

public NetworkServiceDescriptorRestAgent(java.lang.String username,
                                 java.lang.String password,
                                 java.lang.String projectId,
                                 boolean sslEnabled,
                                 java.lang.String nfvoIp,
                                 java.lang.String nfvoPort,
                                 java.lang.String path,
                                 java.lang.String version)

Create a NetworkServiceDescriptor requester with a given url path

Parameters:

nfvoIp - the url path used for the api requests

Method Detail

getVirtualNetworkFunctionDescriptors

@Deprecated
public java.util.List<org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor> getVirtualNetworkFunctionDescriptors(java.lang.String idNSD)
                                                                                                                              throws SDKException

Deprecated.

Parameters:

idNSD - : The id of NSD

Returns:

The List of VirtualNetworkFunctionDescriptor into NSD

Throws:

SDKException

getVirtualNetworkFunctionDescriptor

@Deprecated
public org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor getVirtualNetworkFunctionDescriptor(java.lang.String idNSD,
                                                                                                                      java.lang.String id_vfn)
                                                                                                             throws SDKException

Deprecated.

Return a VirtualNetworkFunctionDescriptor into a NSD with id

Parameters:

idNSD - : The id of NSD

id_vfn - : The id of the VNF Descriptor

Returns:

: The List of VirtualNetworkFunctionDescriptor into NSD

Throws:

SDKException

deleteVirtualNetworkFunctionDescriptors

@Deprecated
public void deleteVirtualNetworkFunctionDescriptors(java.lang.String idNSD,
                                                      java.lang.String id_vfn)
                                             throws SDKException

Deprecated.

Delete the VirtualNetworkFunctionDescriptor

Parameters:

idNSD - : The id of NSD

id_vfn - : The id of the VNF Descriptor

Throws:

SDKException

createVNFD

@Deprecated
public org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor createVNFD(java.lang.String idNSD,
                                                                                             org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor virtualNetworkFunctionDescriptor)
                                                                                    throws SDKException

Deprecated.

Create a VirtualNetworkFunctionDescriptor

Parameters:

virtualNetworkFunctionDescriptor - : : the Network Service Descriptor to be updated

idNSD - : The id of the networkServiceDescriptor the vnfd shall be created at

Throws:

SDKException

updateVNFD

@Deprecated
public org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor updateVNFD(java.lang.String idNSD,
                                                                                             java.lang.String id_vfn,
                                                                                             org.openbaton.catalogue.mano.descriptor.VirtualNetworkFunctionDescriptor virtualNetworkFunctionDescriptor)
                                                                                    throws SDKException

Deprecated.

Update the VirtualNetworkFunctionDescriptor

Parameters:

virtualNetworkFunctionDescriptor - : : the Network Service Descriptor to be updated

idNSD - : The id of the (old) VNF Descriptor

id_vfn - : The id of the VNF Descriptor

Returns:

: The updated virtualNetworkFunctionDescriptor

Throws:

SDKException

getVNFDependencies

public java.util.List<org.openbaton.catalogue.mano.descriptor.VNFDependency> getVNFDependencies(java.lang.String idNSD)
                                                                                         throws SDKException

Return the list of VNFDependencies into a NSD

Parameters:

idNSD - : The id of the networkServiceDescriptor

Returns:

: The List of VNFDependency into NSD

Throws:

SDKException

getVNFDependency

public org.openbaton.catalogue.mano.descriptor.VNFDependency getVNFDependency(java.lang.String idNSD,
                                                                     java.lang.String id_vnfd)
                                                                       throws SDKException

Return a VNFDependency into a NSD

Parameters:

idNSD - : The id of the VNF Descriptor

id_vnfd - : The VNFDependencies id

Returns:

VNFDependency: The List of VNFDependency into NSD

Throws:

SDKException

deleteVNFDependency

public void deleteVNFDependency(java.lang.String idNSD,
                       java.lang.String id_vnfd)
                         throws SDKException

Delets a VNFDependency

Parameters:

idNSD - : The id of the networkServiceDescriptor

id_vnfd - : The id of the VNFDependency

Throws:

SDKException

createVNFDependency

public org.openbaton.catalogue.mano.descriptor.VNFDependency createVNFDependency(java.lang.String idNSD,
                                                                        org.openbaton.catalogue.mano.descriptor.VNFDependency vnfDependency)
                                                                          throws SDKException

Create a VNFDependency

Parameters:

vnfDependency - : The VNFDependency to be updated

idNSD - : The id of the networkServiceDescriptor

Throws:

SDKException

updateVNFD

public org.openbaton.catalogue.mano.descriptor.VNFDependency updateVNFD(java.lang.String idNSD,
                                                               java.lang.String id_vnfd,
                                                               org.openbaton.catalogue.mano.descriptor.VNFDependency vnfDependency)
                                                                 throws SDKException

Update the VNFDependency

Parameters:

vnfDependency - : The VNFDependency to be updated

idNSD - : The id of the networkServiceDescriptor

id_vnfd - : The id of the VNFDependency

Returns:

The updated VNFDependency

Throws:

SDKException

getPhysicalNetworkFunctionDescriptors

public java.util.List<org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor> getPhysicalNetworkFunctionDescriptors(java.lang.String idNSD)
                                                                                                                                throws SDKException

Return the list of PhysicalNetworkFunctionDescriptor into a NSD with id

Parameters:

idNSD - : The id of NSD

Returns:

: The List of PhysicalNetworkFunctionDescriptor into NSD

Throws:

SDKException

getPhysicalNetworkFunctionDescriptor

public org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor getPhysicalNetworkFunctionDescriptor(java.lang.String idNSD,
                                                                                                             java.lang.String idPnf)
                                                                                                               throws SDKException

Returns the PhysicalNetworkFunctionDescriptor into a NSD with id

Parameters:

idNSD - : The NSD id

idPnf - : The PhysicalNetworkFunctionDescriptor id

Returns:

PhysicalNetworkFunctionDescriptor: The PhysicalNetworkFunctionDescriptor selected

Throws:

SDKException

deletePhysicalNetworkFunctionDescriptor

public void deletePhysicalNetworkFunctionDescriptor(java.lang.String idNSD,
                                           java.lang.String idPnf)
                                             throws SDKException

Delete the PhysicalNetworkFunctionDescriptor with the idPnf

Parameters:

idNSD - : The NSD id

idPnf - : The PhysicalNetworkFunctionDescriptor id

Throws:

SDKException

createPhysicalNetworkFunctionDescriptor

public org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor createPhysicalNetworkFunctionDescriptor(java.lang.String idNSD,
                                                                                                                org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor physicalNetworkFunctionDescriptor)
                                                                                                                  throws SDKException

Store the PhysicalNetworkFunctionDescriptor

Parameters:

physicalNetworkFunctionDescriptor - : The PhysicalNetworkFunctionDescriptor to be stored

idNSD - : The NSD id

Returns:

PhysicalNetworkFunctionDescriptor: The PhysicalNetworkFunctionDescriptor stored

Throws:

SDKException

updatePNFD

public org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor updatePNFD(java.lang.String idNSD,
                                                                                   java.lang.String idPnf,
                                                                                   org.openbaton.catalogue.mano.descriptor.PhysicalNetworkFunctionDescriptor physicalNetworkFunctionDescriptor)
                                                                                     throws SDKException

Update the PhysicalNetworkFunctionDescriptor

Parameters:

physicalNetworkFunctionDescriptor - : The PhysicalNetworkFunctionDescriptor to be edited

idNSD - : The NSD id

idPnf - : The PhysicalNetworkFunctionDescriptor id

Returns:

PhysicalNetworkFunctionDescriptor: The PhysicalNetworkFunctionDescriptor edited

Throws:

SDKException

getSecurities

public org.openbaton.catalogue.mano.common.Security getSecurities(java.lang.String idNSD)
                                                           throws SDKException

Return the Security into a NSD

Parameters:

idNSD - : The id of NSD

Returns:

Security: The Security of PhysicalNetworkFunctionDescriptor into NSD

Throws:

SDKException

deleteSecurity

public void deleteSecurity(java.lang.String idNSD,
                  java.lang.String id_s)
                    throws SDKException

Delete the Security with the id_s

Parameters:

idNSD - : The NSD id

id_s - : The Security id

Throws:

SDKException

createSecurity

public org.openbaton.catalogue.mano.common.Security createSecurity(java.lang.String idNSD,
                                                          org.openbaton.catalogue.mano.common.Security security)
                                                            throws SDKException

Store the Security into NSD

Parameters:

security - : The Security to be stored

idNSD - : The id of NSD

Returns:

Security: The Security stored

Throws:

SDKException

updateSecurity

public org.openbaton.catalogue.mano.common.Security updateSecurity(java.lang.String idNSD,
                                                          java.lang.String id_s,
                                                          org.openbaton.catalogue.mano.common.Security security)
                                                            throws SDKException

Update the Security into NSD

Parameters:

security - : The Security to be stored

idNSD - : The id of NSD

id_s - : The security id

Returns:

Security: The Security stored

Throws:

SDKException