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

Class IpamModule

java.lang.Object

org.neotropic.kuwaiba.core.apis.integration.modules.AbstractModule

org.neotropic.kuwaiba.core.apis.integration.modules.AbstractCommercialModule

com.neotropic.kuwaiba.modules.commercial.ipam.IpamModule

@Component
public class IpamModule
extends AbstractCommercialModule

IP address manager module definition. This module allows managing addressing space and subnetting for IPv4 and IPv6 networks.

Author:

Adrian Martinez <adrian.martinez@kuwaiba.org>

Nested Class Summary

Nested classes/interfaces inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.AbstractModule

AbstractModule.ModuleType

Field Summary

Fields

Modifier and Type	Field	Description
static String	MODULE_ID	The module id.
static String	RELATIONSHIP_IPAMBELONGSTOVLAN	This relationship is used to connect a VLAN with a Subnet
static String	RELATIONSHIP_IPAMBELONGSTOVRFINSTACE	This relationship is used to relate a VRF with a Subnet
static String	RELATIONSHIP_IPAMHASADDRESS	This relationship is used to connect a GenericPort with an IP address
static String	RELATIONSHIP_IPAMPORTRELATEDTOINTERFACE	TODO: place this relationships in other place This relationship is used to relate a network element with extra logical configuration

Fields inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.AbstractModule

aem, bem, CATEGORY_ADMINISTRATION, CATEGORY_BUSINESS, CATEGORY_INTEGRATION, CATEGORY_LOGICAL, CATEGORY_NAVIGATION, CATEGORY_OTHER, CATEGORY_PHYSICAL, CATEGORY_PLANNING, CATEGORY_SETTINGS, CATEGORY_VIRTUALIZATION, enabled, mem

Constructor Summary

Constructors

Constructor	Description
IpamModule()

Method Summary

Modifier and Type	Method	Description
void	configureModule(MetadataEntityManager mem, ApplicationEntityManager aem, BusinessEntityManager bem)	This method initializes the module.
int	getCategory()	Assigns the module a category, so it can be placed in menus and context actions.
String	getDescription()	Gets the module description
String	getId()	A simple unique string that identifies the module so it is easier to refer to it in automated processes such as defining if a user can user certain functionality based on his/her privileges.
AbstractModule.ModuleType	getModuleType()	Gets the module's type.
String	getName()	Gets the module's name.
String	getVendor()	Gets the module's vendor
String	getVersion()	Gets the module's version
void	init()
void	validate()	Says if the module can be used or not (for example, if the license has expired or not) or if there are unmet dependencies.

Methods inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.AbstractModule

isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

MODULE_ID

public static final String MODULE_ID

The module id.

See Also:

Constant Field Values

RELATIONSHIP_IPAMHASADDRESS

public static final String RELATIONSHIP_IPAMHASADDRESS

This relationship is used to connect a GenericPort with an IP address

See Also:

Constant Field Values

RELATIONSHIP_IPAMBELONGSTOVLAN

public static final String RELATIONSHIP_IPAMBELONGSTOVLAN

This relationship is used to connect a VLAN with a Subnet

See Also:

Constant Field Values

RELATIONSHIP_IPAMBELONGSTOVRFINSTACE

public static final String RELATIONSHIP_IPAMBELONGSTOVRFINSTACE

This relationship is used to relate a VRF with a Subnet

See Also:

Constant Field Values

RELATIONSHIP_IPAMPORTRELATEDTOINTERFACE

public static final String RELATIONSHIP_IPAMPORTRELATEDTOINTERFACE

TODO: place this relationships in other place This relationship is used to relate a network element with extra logical configuration

See Also:

Constant Field Values

Constructor Detail

IpamModule

public IpamModule()

Method Detail

init

@PostConstruct
public void init()

getName

public String getName()

Description copied from class: AbstractModule

Gets the module's name. Must be unique, otherwise, the system will only take last one loaded at application's startup

Specified by:

getName in class AbstractModule

Returns:

The module's name

getDescription

public String getDescription()

Description copied from class: AbstractModule

Gets the module description

Specified by:

getDescription in class AbstractModule

Returns:

he module's description

getVersion

public String getVersion()

Description copied from class: AbstractModule

Gets the module's version

Specified by:

getVersion in class AbstractModule

Returns:

The module's version

getVendor

public String getVendor()

Description copied from class: AbstractModule

Gets the module's vendor

Specified by:

getVendor in class AbstractModule

Returns:

The module's vendor

getModuleType

public AbstractModule.ModuleType getModuleType()

Description copied from class: AbstractModule

Gets the module's type. For valid values #ModuleTypes

Specified by:

getModuleType in class AbstractModule

Returns:

The module's types

configureModule

public void configureModule(MetadataEntityManager mem,
                            ApplicationEntityManager aem,
                            BusinessEntityManager bem)

Description copied from class: AbstractModule

This method initializes the module. Must be called before anything else, otherwise the other modules won't be able to use the persistence service.

Overrides:

configureModule in class AbstractModule

Parameters:

mem - The MetadataEntityManager instance. Might be null if not needed by the module

aem - The ApplicationEntityManager instance. Might be null if not needed by the module

bem - The BusinessEntityManager instance. Might be null if not needed by the module

validate

public void validate()
              throws OperationNotPermittedException

Description copied from class: AbstractCommercialModule

Says if the module can be used or not (for example, if the license has expired or not) or if there are unmet dependencies.

Specified by:

validate in class AbstractCommercialModule

Throws:

OperationNotPermittedException - The reason why the module could not be started.

getId

public String getId()

Description copied from class: AbstractModule

A simple unique string that identifies the module so it is easier to refer to it in automated processes such as defining if a user can user certain functionality based on his/her privileges.

Specified by:

getId in class AbstractModule

Returns:

getCategory

public int getCategory()

Description copied from class: AbstractModule

Assigns the module a category, so it can be placed in menus and context actions. See CATEGORY_XXX for valid values.

Specified by:

getCategory in class AbstractModule

Returns:

The category.