com.cloupia.service.cIM.inframgr

Class AbstractCloupiaModule

java.lang.Object

com.cloupia.service.cIM.inframgr.AbstractFeatureComponent

com.cloupia.service.cIM.inframgr.CustomModule

com.cloupia.service.cIM.inframgr.AbstractCloupiaModule

All Implemented Interfaces:

FeatureComponentIf

public abstract class AbstractCloupiaModule
extends CustomModule

All external modules should extend this class to add support for new functionality in CUIC

Field Summary

Fields inherited from class com.cloupia.service.cIM.inframgr.CustomModule

ACCOUNT_ENTRY_TYPE, CATEGORY, CATEGORY_ID, CATEGORY_LABEL, CONTACT, DESCRIPTION, FORMAT, KEY, MODULE_FORMAT_V1, MODULE_ID, MODULE_ORG, MODULE_PROPERTIES, MODULE_SUBORG, NAME, properties, STATUS, UCSDVERSION, VERSION

Constructor Summary

Constructors

Constructor and Description
AbstractCloupiaModule()

Method Summary

Modifier and Type	Method and Description
void	addScheduleTask(AbstractScheduleTask task) Adds a schedule task to be executed by the system scheduler.
abstract CollectorFactory[]	getCollectors() External modules extending this class shall provide implementation for this method.
abstract CloupiaReport[]	getReports() External modules extending this class shall provide implementation for this method.
java.util.List<java.lang.String>	getTableNames() Iterates through the jdo.files contained in the jar to locate all the JDO annotated POJOs and returns the table names for each POJO
abstract AbstractTask[]	getTasks() External modules extending this class shall provide implementation for this method.
abstract void	onStart(CustomFeatureRegistry registry) Use this method to execute any initialization tasks.
void	registerCollectors()
void	registerComponents(CustomFeatureRegistry cfr)
void	registerReports(ReportRegistryProxy registry)
void	registerResourceLimiter(java.lang.String resourceTypeID, java.lang.String resourceTypeLabel, ResourceCountComputerIf computer) Use this method to introduce new resource types which you would like to monitor for limiting purposes.
void	registerRestFrameworkDefinitions(RestDefinitionWrapper wrapper)
protected void	registerTasks(CustomFeatureRegistry cfr)
void	removeScheduleTask(java.lang.String taskName) Removes a schedule task from the system scheduler.

Methods inherited from class com.cloupia.service.cIM.inframgr.CustomModule

getCategoryID, getFeatureName, getFormat, getProperties, initFeature, isValidated

Methods inherited from class com.cloupia.service.cIM.inframgr.AbstractFeatureComponent

getDependecies, initForms, initHealthChecker, initReports, initSchedules, installMoPointer, updateGlobalCache

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCloupiaModule

public AbstractCloupiaModule()

Method Detail

registerComponents

public void registerComponents(CustomFeatureRegistry cfr)
                        throws java.lang.Exception

Specified by:

registerComponents in class CustomModule

Throws:

java.lang.Exception

registerTasks

protected void registerTasks(CustomFeatureRegistry cfr)
                      throws java.lang.Exception

Throws:

java.lang.Exception

registerReports

public void registerReports(ReportRegistryProxy registry)
                     throws java.lang.Exception

Specified by:

registerReports in class CustomModule

Throws:

java.lang.Exception

registerCollectors

public void registerCollectors()

Specified by:

registerCollectors in class CustomModule

getTableNames

public java.util.List<java.lang.String> getTableNames()
                                               throws java.io.IOException

Iterates through the jdo.files contained in the jar to locate all the JDO annotated POJOs and returns the table names for each POJO

Returns:

List of table names used by this module.

Throws:

java.io.IOException

onStart

public abstract void onStart(CustomFeatureRegistry registry)

Use this method to execute any initialization tasks. For example, if you need to do some database table initialization, register LOV providers, initialize scheduled tasks, etc.

Parameters:

registry - The CustomFeatureRegistry gives you access to register various components into the system.

getTasks

public abstract AbstractTask[] getTasks()

External modules extending this class shall provide implementation for this method.

Returns:

an array of tasks supported by this module

getReports

public abstract CloupiaReport[] getReports()

External modules extending this class shall provide implementation for this method.

Returns:

an array of reports generated by this module

getCollectors

public abstract CollectorFactory[] getCollectors()

External modules extending this class shall provide implementation for this method.

Returns:

an array of collectors generated by this module

addScheduleTask

public void addScheduleTask(AbstractScheduleTask task)
                     throws java.lang.Exception

Adds a schedule task to be executed by the system scheduler. If you need a reference to your module to access this API, you can do the following: YourModule module = (YourModule) FeatureContainer.getInstance().getModuleById(yourModuleID);

Parameters:

task - the task to be added.

Throws:

java.lang.Exception - an exception is thrown if the task's name is not unique.

removeScheduleTask

public void removeScheduleTask(java.lang.String taskName)
                        throws java.lang.Exception

Removes a schedule task from the system scheduler. When using this API you are ONLY allowed to remove tasks that you added. Meaning you should only be passing strings you used in your implementations of getScheduleTaskName(), anything else we assume are tasks you are not allowed to modify. If you need a reference to your module to access this API, you can do the following: YourModule module = (YourModule) FeatureContainer.getInstance().getModuleById(yourModuleID);

Parameters:

taskName - the name of the task you wish to remove. this should be the same thing you put in your implementation of com.cloupia.service.cIM.inframgr.AbstractScheduleTask.getScheduleTaskName().

Throws:

java.lang.Exception - an exception is thrown when you try to remove a task you are not allowed to, i.e. tasks you did not implement yourself.

registerResourceLimiter

public void registerResourceLimiter(java.lang.String resourceTypeID,
                                    java.lang.String resourceTypeLabel,
                                    ResourceCountComputerIf computer)

Use this method to introduce new resource types which you would like to monitor for limiting purposes. When you introduce a new resource type to monitor, it is your responsibility to provide a UI form to associate resources to a Group. The computer is responsible for performing the computation on the resource type per group.

Parameters:

resourceTypeID - a string used to uniquely identify this resource type. it is recommended you prefix the id with your moduleID, e.g. foo_lun_use_by_gb, foo_cpu_use_by_server.

resourceTypeLabel - this string is displayed in the Edit Resources Limit UI for this new type you introduced.

computer - an instance of ResourceCountComputerIf specifically designed to perform the usage of the particular resource you have just introduced.

registerRestFrameworkDefinitions

public void registerRestFrameworkDefinitions(RestDefinitionWrapper wrapper)