Package com.neotropic.kuwaiba.modules.commercial.sdh

Class SdhModule

java.lang.Object

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

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

com.neotropic.kuwaiba.modules.commercial.sdh.SdhModule

@Component
public class SdhModule
extends AbstractCommercialModule

This class implements the functionality corresponding to the SDH module

Author:

Charles Edward Bedon Cortazar <charles.bedon@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	CLASS_GENERICSDHHIGHORDERTRIBUTARYLINK	Root class of all high order tributary links (VC4)
static String	CLASS_GENERICSDHLOWORDERTRIBUTARYLINK	Root class of all low order tributary links (VC12/VC3)
static String	MODULE_ID	Module id.
static String	PROPERTY_SDHPOSITION	The timeslot used by a container in a transport link or in another container
static String	RELATIONSHIP_SDHCONTAINERLINK	The relationship used to connect two GenericCommunicationsEquipment to represent that ports within the equipment are connected with Container Links.
static String	RELATIONSHIP_SDHCONTAINS	This relationship describes how a Container Link carries another Container link of a lower order
static String	RELATIONSHIP_SDHDELIVERS	This relationship describes how a Container Link carries a Tributary Link
static String	RELATIONSHIP_SDHTLENDPOINTA	A side in a transport link
static String	RELATIONSHIP_SDHTLENDPOINTB	B side in a transport link
static String	RELATIONSHIP_SDHTRANSPORTLINK	The relationship used to connect two GenericCommunicationsEquipment to represent that ports within the equipment are connected with Transport Links.
static String	RELATIONSHIP_SDHTRANSPORTS	This relationship describes how a Transport Link carries a Container Link
static String	RELATIONSHIP_SDHTTLENDPOINTA	A side in a tributary link
static String	RELATIONSHIP_SDHTTLENDPOINTB	B side in a tributary link

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
SdhModule()

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

Module id.

See Also:

Constant Field Values

CLASS_GENERICSDHHIGHORDERTRIBUTARYLINK

public static String CLASS_GENERICSDHHIGHORDERTRIBUTARYLINK

Root class of all high order tributary links (VC4)

CLASS_GENERICSDHLOWORDERTRIBUTARYLINK

public static String CLASS_GENERICSDHLOWORDERTRIBUTARYLINK

Root class of all low order tributary links (VC12/VC3)

RELATIONSHIP_SDHTLENDPOINTA

public static String RELATIONSHIP_SDHTLENDPOINTA

A side in a transport link

RELATIONSHIP_SDHTLENDPOINTB

public static String RELATIONSHIP_SDHTLENDPOINTB

B side in a transport link

RELATIONSHIP_SDHTRANSPORTLINK

public static String RELATIONSHIP_SDHTRANSPORTLINK

The relationship used to connect two GenericCommunicationsEquipment to represent that ports within the equipment are connected with Transport Links. This is used to ease the way to find routes between elements

RELATIONSHIP_SDHCONTAINERLINK

public static String RELATIONSHIP_SDHCONTAINERLINK

The relationship used to connect two GenericCommunicationsEquipment to represent that ports within the equipment are connected with Container Links. This is used to ease the way to find routes between elements

RELATIONSHIP_SDHTTLENDPOINTA

public static String RELATIONSHIP_SDHTTLENDPOINTA

A side in a tributary link

RELATIONSHIP_SDHTTLENDPOINTB

public static String RELATIONSHIP_SDHTTLENDPOINTB

B side in a tributary link

RELATIONSHIP_SDHTRANSPORTS

public static String RELATIONSHIP_SDHTRANSPORTS

This relationship describes how a Transport Link carries a Container Link

RELATIONSHIP_SDHCONTAINS

public static String RELATIONSHIP_SDHCONTAINS

This relationship describes how a Container Link carries another Container link of a lower order

RELATIONSHIP_SDHDELIVERS

public static String RELATIONSHIP_SDHDELIVERS

This relationship describes how a Container Link carries a Tributary Link

PROPERTY_SDHPOSITION

public static String PROPERTY_SDHPOSITION

The timeslot used by a container in a transport link or in another container

Constructor Detail

SdhModule

public SdhModule()

Method Detail

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

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.

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

init

@PostConstruct
public void init()

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.

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

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: