Package com.neotropic.kuwaiba.modules.commercial.ipam

Class IpamService

java.lang.Object

com.neotropic.kuwaiba.modules.commercial.ipam.IpamService

@Service
public class IpamService
extends Object

The logic behind the IPAM module.

Author:

Charles Edward Bedon Cortazar <charles.bedon@kuwaiba.org>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	IpamService.IPAddressComparator	Custom comparator to sort lists of IP addresses
class	IpamService.SubnetComparator	Custom subnet comparator to sort subnets lists

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_MASK	default mask for individual IP addresses created in folders

Constructor Summary

Constructors

Constructor	Description
IpamService()

Method Summary

Modifier and Type	Method	Description
String	addIPAddressesToFolder(String parentFolderId, List<HashMap<String,String>> ipAddressesAttributes)	Creates multiple IP addresses that has no subnet parent as direct child of a folder
String	addIPAddressesToSubnet(String parentSubnetId, String parentSubnetClassName, List<HashMap<String,String>> ipAddresesAttributes)	Creates multiple an IP addresses inside a subnet
String	addIPAddressToFolder(String parentFolderId, HashMap<String,String> attributes)	Creates an IP address that has no subnet parent as direct child of a folder
String	addIPAddressToSubnet(String parentSubnetId, String parentSubnetClassName, HashMap<String,String> attributes)	creates an IP address inside a subnet
void	createAllIpAddressInSubnet()
String	createFolder(String parentId, String subnetPoolName, String subnetPoolDescription, String className)	Creates a pool(folder) of subnets if the parentId is -1 the pool will be created in the default root for pools of subnets
String	createSubnet(String parentId, String className, HashMap<String,String> attributes)	create a subnet
List<String>	createSubnets(String parentId, String className, List<HashMap<String,String>> subnetsAttributes)	Creates several subnets in a subnet
void	deleteBridgeDomain(String className, String oid, boolean releaseRelationships)	Deletes a bridge domain.
void	deleteIpAddress(List<String> ipAddressesIds, boolean releaseRelationships)	Removes an IP address from a subnet or folder
void	deleteSubnetPools(String[] subnetPoolsId)	deletes a subnet Pool
void	deleteSubnets(String className, List<String> subnetIds, boolean releaseRelationships)	Deletes a subnet
List<BusinessObjectLight>	existInInventory(List<String> ipAddresses, String className)	Checks if a a list of subnet or IP addresses names exist in the whole inventory it will return a list of all the existing subnet found
InventoryObjectPool	getFolder(String oid)	Retrieves a subnet pool by its id
long	getFolderInFolderCount(String parentId, String className)	Returns the count of subnets folders Retrieves a pool of subnets pools from a pool of subnets or from the root
List<BusinessObjectLight>	getFolderItems(String subnetPoolId, String classNameToFilter, int page, int limit)	Get a set of subnets from a pool folder
long	getFolderItemsCount(String subnetPoolId, String className)	Retrieve the count of subnets from a pool of subnets
List<InventoryObjectPool>	getFoldersInFolder(String parentId, String className, int page, int limit)	Returns the folders Retrieves a pool of subnets pools from a pool of subnets or from the root
InventoryObjectPool	getIpv4Root()
InventoryObjectPool	getIpv6Root()
void	getOverlapedSubnets(String cidr, String className, String newNetworkIpAddress, String newBroadcastIpAddress)	Checks if the new subnet exists or overlaps with in other created subnets
BusinessObject	getSubnet(String className, String oid)	Retrieves a subnet by its className and id
List<BusinessObjectLight>	getSubnetIpAddrCreated(String id, String className, int page, int limit)	Retrieves all the IP address created in a subnet
List<BusinessObjectLight>	getSubnetIpAddrsInUse(String subnetId, String subnetClassName)	Gets the number of IP addresses instantiated (created) in the subnet that has a relationship with an inventory object e.g.
List<BusinessObjectLight>	getSubnetIpAddrsReserved(String subnetId, String subnetClassName)
List<BusinessObjectLight>	getSubnetsInSubnet(String id, String className, int page, int limit)	Retrieves all the Subnets created inside a subnet
long	getSubnetsInSubnetCount(String id, String className)	Retrieves all the Subnets created inside a subnet
void	relateIpAddressToNetworkInterface(String ipAddrId, String portClassName, String portId)	Relates an IP address with a generic communication port
void	relatePortToInterface(String portId, String portClassName, String interfaceClassName, String interfaceId)	Relates an interface with a GenericCommunicationPort
void	relateSubnetToVLAN(String subnetId, String className, String vlanId)	Relate a Subnet with a VLAN, this method also allow to relate VLANs to BDIs, VFRIs.
void	relateSubnetToVRF(String subnetId, String className, String vrfId)	Relate a Subnet with a VRF
void	releaseIpAddrFromNetworkInterface(String portClass, String portId, String id)	Release the relationship between a GenericPort and an IP Address.
void	releasePortFromInterface(String interfaceClassName, String interfaceId, String portId)	Release the relationship between a GenericCommunicationPort and an interface
void	releaseSubnetFromVLAN(String subnetId, String vlanId)	Release a relationship between a subnet and a VLAN, this method also allow to relate VLANs to BDIs, VFRIs.
void	releaseSubnetFromVRF(String subnetId, String vrfId)	Release a relationship between a subnet and a VRF
void	updateIpAdress(String id, HashMap<String,String> attributes)	Updates some attributes of the ip address, description, state are the only editable attributes of an ip address

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MASK

public static final String DEFAULT_MASK

default mask for individual IP addresses created in folders

See Also:

Constant Field Values

Constructor Detail

IpamService

public IpamService()

Method Detail

getIpv4Root

public InventoryObjectPool getIpv4Root()

getIpv6Root

public InventoryObjectPool getIpv6Root()

createFolder

public String createFolder(String parentId,
                           String subnetPoolName,
                           String subnetPoolDescription,
                           String className)
                    throws InvalidArgumentException,
                           MetadataObjectNotFoundException,
                           NotAuthorizedException,
                           ApplicationObjectNotFoundException

Creates a pool(folder) of subnets if the parentId is -1 the pool will be created in the default root for pools of subnets

Parameters:

parentId - the given parent id if the id is -1 it means the parent could be one of the default root nodes.

subnetPoolName - subnet pool name

subnetPoolDescription - subnet pool description

className - if is a IPv4 subnet or if is a IPv6 subnet

Returns:

the id of the created new subnet pool

Throws:

InvalidArgumentException - if something goes wrong and can't reach the backend

MetadataObjectNotFoundException - If the class IPv4 o IPv6 doesn't exists

NotAuthorizedException - If the user is not authorized to create pool nodes

ApplicationObjectNotFoundException - if the IPAM root nodes doesn't exists

getSubnet

public BusinessObject getSubnet(String className,
                                String oid)
                         throws MetadataObjectNotFoundException,
                                BusinessObjectNotFoundException,
                                InvalidArgumentException,
                                NotAuthorizedException

Retrieves a subnet by its className and id

Parameters:

className - if the subnet is IPv4 or IPv6

oid - the subnet id

Returns:

a business object that represents the subnet, note: the name of the subnet is in CIDR format networkAddress/mask bits

Throws:

MetadataObjectNotFoundException - If the class IPv4 o IPv6 can't be find

BusinessObjectNotFoundException - if the requested object(subnet) can't be found

InvalidArgumentException - if the requested object(subnet) can't be found

NotAuthorizedException - If the user is not authorized to get subnets

getFolder

public InventoryObjectPool getFolder(String oid)
                              throws NotAuthorizedException,
                                     InvalidArgumentException,
                                     ApplicationObjectNotFoundException

Retrieves a subnet pool by its id

Parameters:

oid - the subnet id

Returns:

a subnet pool

Throws:

ApplicationObjectNotFoundException - if the subnet pool can't be found

NotAuthorizedException - If the user is not authorized to use the IPAM module

InvalidArgumentException - It the subnet pool does not have uuid

getFoldersInFolder

public List<InventoryObjectPool> getFoldersInFolder(String parentId,
                                                    String className,
                                                    int page,
                                                    int limit)
                                             throws NotAuthorizedException,
                                                    ApplicationObjectNotFoundException,
                                                    InvalidArgumentException,
                                                    MetadataObjectNotFoundException

Returns the folders Retrieves a pool of subnets pools from a pool of subnets or from the root

Parameters:

parentId - parent id

className - if is a IPv4 subnet or if is a IPv6 subnet

page - number of results to skip

limit - the number of results per page

Returns:

a list of subnet pools

Throws:

NotAuthorizedException - If the user is not authorized to use the IPAM module

ApplicationObjectNotFoundException - if can't get the pools of a subnet pool

MetadataObjectNotFoundException - if there are not IPAM root nodes

InvalidArgumentException - If the parent does not have uuid public List getFoldersInFolder(String parentId, String className, int page, int limit)

getFolderInFolderCount

public long getFolderInFolderCount(String parentId,
                                   String className)
                            throws NotAuthorizedException,
                                   ApplicationObjectNotFoundException,
                                   InvalidArgumentException

Returns the count of subnets folders Retrieves a pool of subnets pools from a pool of subnets or from the root

Parameters:

parentId - parent id

className - if is a IPv4 subnet or if is a IPv6 subnet

Returns:

a list of subnet pools

Throws:

NotAuthorizedException - If the user is not authorized to use the IPAM module

ApplicationObjectNotFoundException - if can't get the pools of a subnet pool

InvalidArgumentException - If the parent does not have uuid

getFolderItems

public List<BusinessObjectLight> getFolderItems(String subnetPoolId,
                                                String classNameToFilter,
                                                int page,
                                                int limit)
                                         throws ApplicationObjectNotFoundException,
                                                NotAuthorizedException,
                                                InvalidArgumentException

Get a set of subnets from a pool folder

Parameters:

subnetPoolId - subnet pool id

classNameToFilter - the className of the wished folder objects, subents or ip address

page - the page or the number of elements to skip, to no pagination -1.

limit - the limit of elements by page, no limit -1

Returns:

a list of subnets

Throws:

ApplicationObjectNotFoundException - if the given subnet pool id is not valid

NotAuthorizedException - If the user is not authorized to use the IPAM module

InvalidArgumentException - If the subnet pool does not have uuid public List getFolderItems(String subnetPoolId, HashMap filters, int page, int limit)

getFolderItemsCount

public long getFolderItemsCount(String subnetPoolId,
                                String className)
                         throws ApplicationObjectNotFoundException,
                                NotAuthorizedException,
                                InvalidArgumentException

Retrieve the count of subnets from a pool of subnets

Parameters:

subnetPoolId - subnet pool id

className - the classname of the objects in pool

Returns:

a list of subnets

Throws:

ApplicationObjectNotFoundException - if the given subnet pool id is not valid

NotAuthorizedException - If the user is not authorized to use the IPAM module

InvalidArgumentException - If the subnet pool does not have uuid

getSubnetsInSubnet

public List<BusinessObjectLight> getSubnetsInSubnet(String id,
                                                    String className,
                                                    int page,
                                                    int limit)
                                             throws MetadataObjectNotFoundException,
                                                    BusinessObjectNotFoundException,
                                                    NotAuthorizedException,
                                                    InvalidArgumentException

Retrieves all the Subnets created inside a subnet

Parameters:

id - a given subnet id

className - If the subnet has IPv4 or an IPv6 addresses

page - the results page or number of elements skipped

limit - limit of elements per page

Returns:

A list of subnets for the given subnet id

Throws:

MetadataObjectNotFoundException - If can't find IPv4 or IPV6 classes

BusinessObjectNotFoundException - If the object(subnet) could not be found.

NotAuthorizedException - If the user is not authorized to use the IPAM module

InvalidArgumentException - If the subnet does not have uuid

getSubnetsInSubnetCount

public long getSubnetsInSubnetCount(String id,
                                    String className)
                             throws MetadataObjectNotFoundException,
                                    BusinessObjectNotFoundException,
                                    NotAuthorizedException,
                                    InvalidArgumentException

Retrieves all the Subnets created inside a subnet

Parameters:

id - a given subnet id

className - If the subnet has IPv4 or an IPv6 addresses

Returns:

A list of subnets for the given subnet id

Throws:

MetadataObjectNotFoundException - If can't find IPv4 or IPV6 classes

BusinessObjectNotFoundException - If the object(subnet) could not be found.

NotAuthorizedException - If the user is not authorized to use the IPAM module

InvalidArgumentException - If the subnet does not have uuid

createSubnet

public String createSubnet(String parentId,
                           String className,
                           HashMap<String,String> attributes)
                    throws InvalidArgumentException,
                           ArraySizeMismatchException,
                           NotAuthorizedException,
                           MetadataObjectNotFoundException,
                           OperationNotPermittedException,
                           BusinessObjectNotFoundException,
                           ApplicationObjectNotFoundException

create a subnet

Parameters:

parentId - subnet pool id

className - subnet class name

attributes - subnet attributes, networkIP, broadcastIP, hosts

Returns:

new subnet id

Throws:

ApplicationObjectNotFoundException - can't find the parent(a subnet pool) to create the subnet

InvalidArgumentException - If any of the attributes or its type is invalid

ArraySizeMismatchException - If attributeNames and attributeValues have different sizes.

NotAuthorizedException - If the user is not authorized to use the IPAM module

MetadataObjectNotFoundException - If can't find IPv4 or IPV6 classes

BusinessObjectNotFoundException - Thrown if the parent id is not found

OperationNotPermittedException - If the update can't be performed due to a format issue

createSubnets

public List<String> createSubnets(String parentId,
                                  String className,
                                  List<HashMap<String,String>> subnetsAttributes)
                           throws InvalidArgumentException,
                                  ArraySizeMismatchException,
                                  NotAuthorizedException,
                                  MetadataObjectNotFoundException,
                                  OperationNotPermittedException,
                                  BusinessObjectNotFoundException,
                                  ApplicationObjectNotFoundException

Creates several subnets in a subnet

Parameters:

parentId - subnet pool id

className - subnet class name

subnetsAttributes - all the attributes of the subnets to be created: networkIP, broadcastIP, hosts, etc

Returns:

a list of the new subnet ids

Throws:

ApplicationObjectNotFoundException - can't find the parent(a subnet pool) to create the subnet

InvalidArgumentException - If any of the attributes or its type is invalid

ArraySizeMismatchException - If attributeNames and attributeValues have different sizes.

NotAuthorizedException - If the user is not authorized to use the IPAM module

MetadataObjectNotFoundException - If can't find IPv4 or IPV6 classes

BusinessObjectNotFoundException - Thrown if the parent id is not found

OperationNotPermittedException - If the update can't be performed due to a format issue

existInInventory

public List<BusinessObjectLight> existInInventory(List<String> ipAddresses,
                                                  String className)
                                           throws InvalidArgumentException

Checks if a a list of subnet or IP addresses names exist in the whole inventory it will return a list of all the existing subnet found

Parameters:

ipAddresses - subnets name should be in cidr format, or ip addresses

className - class of subnets ipv4 or ipv 6

Returns:

a list of found subnets

Throws:

InvalidArgumentException

deleteSubnets

public void deleteSubnets(String className,
                          List<String> subnetIds,
                          boolean releaseRelationships)
                   throws BusinessObjectNotFoundException,
                          MetadataObjectNotFoundException,
                          OperationNotPermittedException,
                          InvalidArgumentException

Deletes a subnet

Parameters:

subnetIds - subnet ids

className - subnets class name

releaseRelationships - release any relationship

Throws:

BusinessObjectNotFoundException - If the requested subnet can't be found

MetadataObjectNotFoundException - If the requested object class can't be found (problems with IPv4 or IPV6 classes)

OperationNotPermittedException - If the update can't be performed due a business rule or because the object is blocked or it has relationships and releaseRelationships is false

InvalidArgumentException - If it was not possible to release the possible unique attributes

deleteSubnetPools

public void deleteSubnetPools(String[] subnetPoolsId)
                       throws OperationNotPermittedException,
                              ApplicationObjectNotFoundException

deletes a subnet Pool

Parameters:

subnetPoolsId - subnet ids

Throws:

OperationNotPermittedException - If any of the objects in the pool can not be deleted because it's not a business related instance (it's more a security restriction)

ApplicationObjectNotFoundException - If the subnet pool can't be found

deleteBridgeDomain

public void deleteBridgeDomain(String className,
                               String oid,
                               boolean releaseRelationships)
                        throws BusinessObjectNotFoundException,
                               MetadataObjectNotFoundException,
                               OperationNotPermittedException,
                               InvalidArgumentException

Deletes a bridge domain.

Parameters:

className - Bridge domain class name

oid - Bridge domain id

releaseRelationships - Release any relationship

Throws:

BusinessObjectNotFoundException - If the requested object can't be found

MetadataObjectNotFoundException - If the requested object class can't be found

OperationNotPermittedException - If the update can't be performed due a business rule or because the object is blocked or it has relationships and releaseRelationships is false

InvalidArgumentException - If it was not possible to release the possible unique attributes

addIPAddressToSubnet

public String addIPAddressToSubnet(String parentSubnetId,
                                   String parentSubnetClassName,
                                   HashMap<String,String> attributes)
                            throws ApplicationObjectNotFoundException,
                                   InvalidArgumentException,
                                   ArraySizeMismatchException,
                                   NotAuthorizedException,
                                   MetadataObjectNotFoundException,
                                   BusinessObjectNotFoundException,
                                   OperationNotPermittedException

creates an IP address inside a subnet

Parameters:

parentSubnetId - subnet Id

parentSubnetClassName - if is a IPv4 or an IPv6 subnet

attributes - ip Address attributes, name description

Returns:

IP address id

Throws:

ApplicationObjectNotFoundException - Can't find the parent(a subnet) to create the IP address

InvalidArgumentException - If any of the attributes or its type is invalid

ArraySizeMismatchException - If attributeNames and attributeValues have different sizes.

NotAuthorizedException - If the user is not authorized to use the IPAM module

MetadataObjectNotFoundException - if can't find IPv4 or IPV6 classes

BusinessObjectNotFoundException - Thrown if the parent(the subnet) id is not found

OperationNotPermittedException - If the update can't be performed due to a format issue

addIPAddressesToSubnet

public String addIPAddressesToSubnet(String parentSubnetId,
                                     String parentSubnetClassName,
                                     List<HashMap<String,String>> ipAddresesAttributes)
                              throws ApplicationObjectNotFoundException,
                                     InvalidArgumentException,
                                     ArraySizeMismatchException,
                                     NotAuthorizedException,
                                     MetadataObjectNotFoundException,
                                     BusinessObjectNotFoundException,
                                     OperationNotPermittedException

Creates multiple an IP addresses inside a subnet

Parameters:

parentSubnetId - subnet Id

parentSubnetClassName - if is a IPv4 or an IPv6 subnet

ipAddresesAttributes - ip Address attributes, name description

Returns:

IP Address id

Throws:

ApplicationObjectNotFoundException - Can't find the parent(a subnet) to create the IP address

InvalidArgumentException - If any of the attributes or its type is invalid

ArraySizeMismatchException - If attributeNames and attributeValues have different sizes.

NotAuthorizedException - If the user is not authorized to use the IPAM module

MetadataObjectNotFoundException - if can't find IPv4 or IPV6 classes

BusinessObjectNotFoundException - Thrown if the parent(the subnet) id is not found

OperationNotPermittedException - If the update can't be performed due to a format issue

updateIpAdress

public void updateIpAdress(String id,
                           HashMap<String,String> attributes)
                    throws MetadataObjectNotFoundException,
                           BusinessObjectNotFoundException,
                           OperationNotPermittedException,
                           InvalidArgumentException

Updates some attributes of the ip address, description, state are the only editable attributes of an ip address

Parameters:

id - ip address id

attributes - attribuetes to update description or state.

Throws:

MetadataObjectNotFoundException

BusinessObjectNotFoundException

OperationNotPermittedException

InvalidArgumentException

addIPAddressToFolder

public String addIPAddressToFolder(String parentFolderId,
                                   HashMap<String,String> attributes)
                            throws ApplicationObjectNotFoundException,
                                   InvalidArgumentException,
                                   ArraySizeMismatchException,
                                   NotAuthorizedException,
                                   MetadataObjectNotFoundException,
                                   BusinessObjectNotFoundException,
                                   OperationNotPermittedException

Creates an IP address that has no subnet parent as direct child of a folder

Parameters:

parentFolderId - the folder (pool) Id

attributes - IP Address attributes, name description

Returns:

IP address id

Throws:

ApplicationObjectNotFoundException - Can't find the parent(a subnet) to create the IP address

InvalidArgumentException - If any of the attributes or its type is invalid

ArraySizeMismatchException - If attributeNames and attributeValues have different sizes.

NotAuthorizedException - If the user is not authorized to use the IPAM module

MetadataObjectNotFoundException - if can't find IPv4 or IPV6 classes

BusinessObjectNotFoundException - Thrown if the parent(the subnet) id is not found

OperationNotPermittedException - If the update can't be performed due to a format issue

addIPAddressesToFolder

public String addIPAddressesToFolder(String parentFolderId,
                                     List<HashMap<String,String>> ipAddressesAttributes)
                              throws ApplicationObjectNotFoundException,
                                     InvalidArgumentException,
                                     ArraySizeMismatchException,
                                     NotAuthorizedException,
                                     MetadataObjectNotFoundException,
                                     BusinessObjectNotFoundException,
                                     OperationNotPermittedException

Creates multiple IP addresses that has no subnet parent as direct child of a folder

Parameters:

parentFolderId - the folder (pool) Id

ipAddressesAttributes - a list of the attribues(name, description) all IP Addreses that il be created

Returns:

IP address id

Throws:

ApplicationObjectNotFoundException - Can't find the parent(a subnet) to create the IP address

InvalidArgumentException - If any of the attributes or its type is invalid

ArraySizeMismatchException - If attributeNames and attributeValues have different sizes.

NotAuthorizedException - If the user is not authorized to use the IPAM module

MetadataObjectNotFoundException - if can't find IPv4 or IPV6 classes

BusinessObjectNotFoundException - Thrown if the parent(the subnet) id is not found

OperationNotPermittedException - If the update can't be performed due to a format issue

deleteIpAddress

public void deleteIpAddress(List<String> ipAddressesIds,
                            boolean releaseRelationships)
                     throws BusinessObjectNotFoundException,
                            MetadataObjectNotFoundException,
                            OperationNotPermittedException,
                            NotAuthorizedException,
                            InvalidArgumentException

Removes an IP address from a subnet or folder

Parameters:

ipAddressesIds -

releaseRelationships - release existing relationships

Throws:

BusinessObjectNotFoundException - If the requested IP address can't be found

MetadataObjectNotFoundException - If can't find IPv4 or IPV6 classes

OperationNotPermittedException - If the update can't be performed due a business rule or because the object is blocked or it has relationships and releaseRelationships is false

NotAuthorizedException - If the user is not authorized to use the IPAM module

InvalidArgumentException - If the ip ids do no have uuid

relateIpAddressToNetworkInterface

public void relateIpAddressToNetworkInterface(String ipAddrId,
                                              String portClassName,
                                              String portId)
                                       throws BusinessObjectNotFoundException,
                                              OperationNotPermittedException,
                                              MetadataObjectNotFoundException,
                                              InvalidArgumentException

Relates an IP address with a generic communication port

Parameters:

ipAddrId - subnet id

portClassName - Generic communications element

portId - generic communications id

Throws:

BusinessObjectNotFoundException - If any of the objects can't be found

OperationNotPermittedException - If any of the objects involved can't be connected (i.e. if it's not an inventory object)

MetadataObjectNotFoundException - If any of the classes provided can not be found

InvalidArgumentException - If the subnet/port do not have uuid

relateSubnetToVLAN

public void relateSubnetToVLAN(String subnetId,
                               String className,
                               String vlanId)
                        throws BusinessObjectNotFoundException,
                               OperationNotPermittedException,
                               MetadataObjectNotFoundException,
                               InvalidArgumentException

Relate a Subnet with a VLAN, this method also allow to relate VLANs to BDIs, VFRIs.

Parameters:

subnetId - subnet id

className - if the subnet has IPv4 or IPv6 addresses

vlanId - VLAN id

Throws:

BusinessObjectNotFoundException - If any of the objects can't be found

OperationNotPermittedException - If any of the objects involved can't be connected (i.e. if it's not an inventory object)

MetadataObjectNotFoundException - If any of the classes provided can not be found

InvalidArgumentException - If the subnet/vlan do not have uuid

releaseSubnetFromVLAN

public void releaseSubnetFromVLAN(String subnetId,
                                  String vlanId)
                           throws BusinessObjectNotFoundException,
                                  MetadataObjectNotFoundException,
                                  InvalidArgumentException

Release a relationship between a subnet and a VLAN, this method also allow to relate VLANs to BDIs, VFRIs.

Parameters:

vlanId - the vlan Id

subnetId - the subnet id

Throws:

BusinessObjectNotFoundException - If any of the objects can't be found

MetadataObjectNotFoundException - If any of the classes provided can not be found

InvalidArgumentException - If the subnet/vlan do not have uuid

relateSubnetToVRF

public void relateSubnetToVRF(String subnetId,
                              String className,
                              String vrfId)
                       throws BusinessObjectNotFoundException,
                              OperationNotPermittedException,
                              MetadataObjectNotFoundException,
                              InvalidArgumentException

Relate a Subnet with a VRF

Parameters:

subnetId - subnet id

className - if the subnet has IPv4 or IPv6 addresses

vrfId - VLAN id

Throws:

BusinessObjectNotFoundException - If any of the objects can't be found

OperationNotPermittedException - If any of the objects involved can't be connected (i.e. if it's not an inventory object)

MetadataObjectNotFoundException - If any of the classes provided can not be found

InvalidArgumentException - If the subnet/vrf do not have uuid

releaseIpAddrFromNetworkInterface

public void releaseIpAddrFromNetworkInterface(String portClass,
                                              String portId,
                                              String id)
                                       throws BusinessObjectNotFoundException,
                                              MetadataObjectNotFoundException,
                                              InvalidArgumentException,
                                              NotAuthorizedException

Release the relationship between a GenericPort and an IP Address.

Parameters:

portClass - GenericCommunications Element

portId - GenericCommunications id

id - IP address id

Throws:

BusinessObjectNotFoundException - If the object can not be found

MetadataObjectNotFoundException - If the port class can not be found

NotAuthorizedException - If the user is not authorized to use the IPAM module

InvalidArgumentException - If the port does not have uuid

releaseSubnetFromVRF

public void releaseSubnetFromVRF(String subnetId,
                                 String vrfId)
                          throws BusinessObjectNotFoundException,
                                 MetadataObjectNotFoundException,
                                 NotAuthorizedException,
                                 InvalidArgumentException

Release a relationship between a subnet and a VRF

Parameters:

subnetId - the subnet id

vrfId - the VRF Id

Throws:

BusinessObjectNotFoundException - If the object can not be found

MetadataObjectNotFoundException - If the port class can not be found

NotAuthorizedException - If the user is not authorized to use the IPAM module

InvalidArgumentException - If the subnet/vrf do not have uuid

getSubnetIpAddrCreated

public List<BusinessObjectLight> getSubnetIpAddrCreated(String id,
                                                        String className,
                                                        int page,
                                                        int limit)
                                                 throws MetadataObjectNotFoundException,
                                                        BusinessObjectNotFoundException,
                                                        NotAuthorizedException,
                                                        InvalidArgumentException

Retrieves all the IP address created in a subnet

Parameters:

id - a given subnet id

className - If the subnet has IPv4 or an IPv6 addresses

Returns:

a list of IP addresses that are related to an interface

Throws:

MetadataObjectNotFoundException - If can't find IPv4 or IPV6 classes

BusinessObjectNotFoundException - If the object(subnet) could not be found.

NotAuthorizedException - If the user is not authorized to use the IPAM module

InvalidArgumentException - If the subnet does not have uuid

relatePortToInterface

public void relatePortToInterface(String portId,
                                  String portClassName,
                                  String interfaceClassName,
                                  String interfaceId)
                           throws BusinessObjectNotFoundException,
                                  OperationNotPermittedException,
                                  MetadataObjectNotFoundException,
                                  NotAuthorizedException,
                                  InvalidArgumentException

Relates an interface with a GenericCommunicationPort

Parameters:

portId - port id

portClassName - the class name of the configuration you want to relate with

interfaceClassName - the interface class name

interfaceId - interface id

Throws:

BusinessObjectNotFoundException - If any of the objects can't be found

OperationNotPermittedException - If any of the objects involved can't be connected (i.e. if it's not an inventory object)

MetadataObjectNotFoundException - If any of the classes provided can not be found

NotAuthorizedException - If the user is not authorized to use the IPAM module

InvalidArgumentException - If the port/interface do not have uuid

releasePortFromInterface

public void releasePortFromInterface(String interfaceClassName,
                                     String interfaceId,
                                     String portId)
                              throws BusinessObjectNotFoundException,
                                     MetadataObjectNotFoundException,
                                     NotAuthorizedException,
                                     InvalidArgumentException

Release the relationship between a GenericCommunicationPort and an interface

Parameters:

interfaceClassName - interface's class

interfaceId - interface id

portId - port id

Throws:

BusinessObjectNotFoundException - If the object can not be found

MetadataObjectNotFoundException - If the port class can not be found

NotAuthorizedException - If the user is not authorized to use the IPAM module

InvalidArgumentException - If the interface/port do not have uuid

getOverlapedSubnets

public void getOverlapedSubnets(String cidr,
                                String className,
                                String newNetworkIpAddress,
                                String newBroadcastIpAddress)
                         throws InvalidArgumentException

Checks if the new subnet exists or overlaps with in other created subnets

Parameters:

cidr - subnet's cidr format

className - if is subnet ip v4 or ip v6

newNetworkIpAddress -

newBroadcastIpAddress -

Throws:

InvalidArgumentException - if a subnet with the exact cidr already exists or if it overlaps with others created subnets

getSubnetIpAddrsInUse

public List<BusinessObjectLight> getSubnetIpAddrsInUse(String subnetId,
                                                       String subnetClassName)
                                                throws MetadataObjectNotFoundException,
                                                       BusinessObjectNotFoundException,
                                                       InvalidArgumentException

Gets the number of IP addresses instantiated (created) in the subnet that has a relationship with an inventory object e.g. port

Parameters:

subnetId - the subnet id

subnetClassName - subnet class name

Returns:

the number of IP addresses with relationships

Throws:

MetadataObjectNotFoundException - class name of the subnet not found

BusinessObjectNotFoundException - the IP address not found

InvalidArgumentException - if son parameter is missing in the methods used

getSubnetIpAddrsReserved

public List<BusinessObjectLight> getSubnetIpAddrsReserved(String subnetId,
                                                          String subnetClassName)
                                                   throws MetadataObjectNotFoundException,
                                                          BusinessObjectNotFoundException,
                                                          InvalidArgumentException,
                                                          ApplicationObjectNotFoundException

Throws:

MetadataObjectNotFoundException

BusinessObjectNotFoundException

InvalidArgumentException

ApplicationObjectNotFoundException

createAllIpAddressInSubnet

public void createAllIpAddressInSubnet()