A B C D E F G I L M N P R S T U V

A

addConversion(Class<?>) - Method in class com.serotonin.m2m2.module.DwrConversionDefinition

Declares that objects of the given class are allowed to be converted using a bean converter.

addConversion(Class<?>, String) - Method in class com.serotonin.m2m2.module.DwrConversionDefinition

Declares that objects of the given class are allowed to be converted using the given converter type.

addConversions() - Method in class com.serotonin.m2m2.module.DwrConversionDefinition

addConversionTableNames(List<String>) - Method in class com.serotonin.m2m2.module.DatabaseSchemaDefinition

Modules should add all table names that they manage to the given list.

addConversionWithExclusions(Class<?>, String) - Method in class com.serotonin.m2m2.module.DwrConversionDefinition

Declares that objects of the given class are allowed to be converted using a bean converter.

addConversionWithInclusions(Class<?>, String) - Method in class com.serotonin.m2m2.module.DwrConversionDefinition

Declares that objects of the given class are allowed to be converted using a bean converter.

addDefinition(ModuleElementDefinition) - Method in class com.serotonin.m2m2.module.Module

addLicenseDefinition(LicenseDefinition) - Method in class com.serotonin.m2m2.module.Module

addLicenseErrors(List<TranslatableMessage>) - Method in interface com.serotonin.m2m2.module.LicenseDefinition

Allows the license definition to provide error messages to the user regarding the module's license.

addLicenseWarnings(List<TranslatableMessage>) - Method in interface com.serotonin.m2m2.module.LicenseDefinition

Allows the license definition to provide warning messages to the user regarding the module's license.

addLocaleDefinition(String) - Method in class com.serotonin.m2m2.module.Module

addModule(Module) - Static method in class com.serotonin.m2m2.module.ModuleRegistry

Should not be used by client code.

afterDelete(int) - Method in class com.serotonin.m2m2.module.DataPointChangeDefinition

Called immediately after the point is deleted from the database.

afterInsert(DataPointVO) - Method in class com.serotonin.m2m2.module.DataPointChangeDefinition

Called immediately after the point is inserted into the database.

afterUpdate(DataPointVO) - Method in class com.serotonin.m2m2.module.DataPointChangeDefinition

Called immediately after the point is updated in the database.

AuditEventTypeDefinition - Class in com.serotonin.m2m2.module

Used for creating custom audit event types.

AuditEventTypeDefinition() - Constructor for class com.serotonin.m2m2.module.AuditEventTypeDefinition

autoAckEventWithMessage(EventType) - Method in class com.serotonin.m2m2.module.EventManagerListenerDefinition

Provides both notification of a new event, and the opportunity to automatically acknowledge it.

B

baseCreateDataSourceVO() - Method in class com.serotonin.m2m2.module.DataSourceDefinition

Used by m2m2 core code to create a new data source instance as required.

baseCreatePublisherVO() - Method in class com.serotonin.m2m2.module.PublisherDefinition

Used by m2m2 core code to create a new publisher instance as required.

beforeDelete(int) - Method in class com.serotonin.m2m2.module.DataPointChangeDefinition

Called immediately before the point is to be deleted from the database.

beforeInsert(DataPointVO) - Method in class com.serotonin.m2m2.module.DataPointChangeDefinition

Called immediately before the point is to be inserted into the database.

beforeUpdate(DataPointVO) - Method in class com.serotonin.m2m2.module.DataPointChangeDefinition

Called immediately before the point is to be update in the database.

C

com.serotonin.m2m2.module - package com.serotonin.m2m2.module

createDataSourceVO() - Method in class com.serotonin.m2m2.module.DataSourceDefinition

Create and return an instance of the data source.

createEventType(String, int, int) - Method in class com.serotonin.m2m2.module.EventTypeDefinition

Create an instance of the event type using the given parameters.

createPublisherVO() - Method in class com.serotonin.m2m2.module.PublisherDefinition

Create and return an instance of the publisher.

D

DatabaseSchemaDefinition - Class in com.serotonin.m2m2.module

A database schema definition allows a module to create an manage database tables and other objects as necessary to perform its functionality.

DatabaseSchemaDefinition() - Constructor for class com.serotonin.m2m2.module.DatabaseSchemaDefinition

DataPointChangeDefinition - Class in com.serotonin.m2m2.module

A definition allowing a hook into the data point delete event.

DataPointChangeDefinition() - Constructor for class com.serotonin.m2m2.module.DataPointChangeDefinition

DataSourceDefinition - Class in com.serotonin.m2m2.module

A data source is the means by which m2m2 gets values into a data point, and writes set point values back to source equipment (if possible).

DataSourceDefinition() - Constructor for class com.serotonin.m2m2.module.DataSourceDefinition

DataSourceDefinition.StartPriority - Enum in com.serotonin.m2m2.module

The available start priorities for data sources.

doImport(JsonValue, ImportContext) - Method in class com.serotonin.m2m2.module.EmportDefinition

Import the given JSON data.

DwrConversionDefinition - Class in com.serotonin.m2m2.module

A DWR conversion definition determines how Java objects will be converted to Javascript objects and vice versa.

DwrConversionDefinition() - Constructor for class com.serotonin.m2m2.module.DwrConversionDefinition

DwrDefinition - Class in com.serotonin.m2m2.module

A DWR definition registers a DWR proxy.

DwrDefinition() - Constructor for class com.serotonin.m2m2.module.DwrDefinition

E

EmportDefinition - Class in com.serotonin.m2m2.module

Import/Export functionality (aka 'emport') is a powerful feature that allows configuration to be imported or exported via JSON files.

EmportDefinition() - Constructor for class com.serotonin.m2m2.module.EmportDefinition

EventManagerListenerDefinition - Class in com.serotonin.m2m2.module

Provides a hook for modules to "listen" for things that happen in the event manager.

EventManagerListenerDefinition() - Constructor for class com.serotonin.m2m2.module.EventManagerListenerDefinition

EventTypeDefinition - Class in com.serotonin.m2m2.module

Used for creating custom event types.

EventTypeDefinition() - Constructor for class com.serotonin.m2m2.module.EventTypeDefinition

execute(long) - Method in class com.serotonin.m2m2.module.PurgeDefinition

Called as part of the purge process, which runs nightly.

F

FiledataDefinition - Class in com.serotonin.m2m2.module

The class allows a module to declare a SQL statement (with no parameters) that provides a list of file data IDs (i.e.

FiledataDefinition() - Constructor for class com.serotonin.m2m2.module.FiledataDefinition

G

getAuditEventTypeDefinition(String) - Static method in class com.serotonin.m2m2.module.ModuleRegistry

getConversions() - Method in class com.serotonin.m2m2.module.DwrConversionDefinition

getDataSourceDefinition(String) - Static method in class com.serotonin.m2m2.module.ModuleRegistry

getDataSourceDefinitionTypes() - Static method in class com.serotonin.m2m2.module.ModuleRegistry

getDataSourceTypeName() - Method in class com.serotonin.m2m2.module.DataSourceDefinition

An internal identifier for this type of data source.

getDefaultAlarmLevel() - Method in class com.serotonin.m2m2.module.SystemEventTypeDefinition

The default alarm level of the event.

getDefinitions(Class<T>) - Method in class com.serotonin.m2m2.module.Module

getDefinitions(Class<T>) - Static method in class com.serotonin.m2m2.module.ModuleRegistry

getDependencies() - Method in class com.serotonin.m2m2.module.Module

getDescription() - Method in class com.serotonin.m2m2.module.Module

getDescriptionKey() - Method in class com.serotonin.m2m2.module.AuditEventTypeDefinition

A reference to a human readable and translatable name of the audit event type.

getDescriptionKey() - Method in class com.serotonin.m2m2.module.DataSourceDefinition

A reference to a human readable and translatable brief description of the data source.

getDescriptionKey() - Method in class com.serotonin.m2m2.module.EmportDefinition

getDescriptionKey() - Method in class com.serotonin.m2m2.module.EventTypeDefinition

The reference key to the description of the event type.

getDescriptionKey() - Method in class com.serotonin.m2m2.module.PublisherDefinition

A reference to a human readable and translatable brief description of the publisher.

getDescriptionKey() - Method in class com.serotonin.m2m2.module.SystemEventTypeDefinition

A reference to a human readable and translatable name of the system event type.

getDescriptionKey() - Method in class com.serotonin.m2m2.module.SystemSettingsDefinition

The reference key to the description used as the section header.

getDirectoryPath() - Method in class com.serotonin.m2m2.module.Module

getDwrClass() - Method in class com.serotonin.m2m2.module.DataSourceDefinition

The class of the DWR with which the data source editing page communicates.

getDwrClass() - Method in class com.serotonin.m2m2.module.DwrDefinition

The class of a DWR proxy.

getDwrClass() - Method in class com.serotonin.m2m2.module.PublisherDefinition

The class of the DWR page with which the publisher editing page communicates.

getEditPagePath() - Method in class com.serotonin.m2m2.module.DataSourceDefinition

The path to the data source editing page relative to the module.

getEditPagePath() - Method in class com.serotonin.m2m2.module.PublisherDefinition

The path to the publisher editing page relative to the module.

getElementId() - Method in class com.serotonin.m2m2.module.EmportDefinition

getEmailTemplatesDir() - Method in class com.serotonin.m2m2.module.Module

getEventListLink(int, int, Translations) - Method in class com.serotonin.m2m2.module.AuditEventTypeDefinition

This method provides an opportunity for the client code to return HTML code that will be used verbatim in the events list snippet.

getEventListLink(String, int, int, Translations) - Method in class com.serotonin.m2m2.module.EventTypeDefinition

Optional.

getEventListLink(int, int, Translations) - Method in class com.serotonin.m2m2.module.SystemEventTypeDefinition

This method provides an opportunity for the client code to return HTML code that will be used verbatim in the events list snippet.

getEventTypeClass() - Method in class com.serotonin.m2m2.module.EventTypeDefinition

The class that represents the event type.

getEventTypeDefinition(String) - Static method in class com.serotonin.m2m2.module.ModuleRegistry

getEventTypeVOs() - Method in class com.serotonin.m2m2.module.EventTypeDefinition

Returns a list of EventTypeVOs representing the list of events to which handlers can be added/edited.

getExportData() - Method in class com.serotonin.m2m2.module.EmportDefinition

getFiledataQuery() - Method in class com.serotonin.m2m2.module.FiledataDefinition

getGraphicsDir() - Method in class com.serotonin.m2m2.module.Module

getHandler() - Method in class com.serotonin.m2m2.module.LongPollDefinition

getHandler() - Method in class com.serotonin.m2m2.module.UrlMappingDefinition

An instance of the handler for the URL.

getHandlersRequireAdmin() - Method in class com.serotonin.m2m2.module.EventTypeDefinition

Whether admin permission is required to create and edit event handlers for this even type.

getIconPath() - Method in class com.serotonin.m2m2.module.EventTypeDefinition

Optional.

getInitializationPriority() - Method in class com.serotonin.m2m2.module.RuntimeManagerDefinition

Determines where in the system initialization this class's initialize method will be called.

getInitOrder() - Method in class com.serotonin.m2m2.module.ServletDefinition

getInitParameters() - Method in class com.serotonin.m2m2.module.ServletDefinition

getJspPath() - Method in class com.serotonin.m2m2.module.UrlMappingDefinition

The path to the JSP file that renders the page at this URL.

getLicenseDefinitions() - Method in class com.serotonin.m2m2.module.Module

getLicenseErrors() - Method in class com.serotonin.m2m2.module.Module

getLicenseWarnings() - Method in class com.serotonin.m2m2.module.Module

getLocales() - Method in class com.serotonin.m2m2.module.Module

getLocales() - Static method in class com.serotonin.m2m2.module.ModuleRegistry

getMenuImage() - Method in class com.serotonin.m2m2.module.UrlMappingDefinition

If the menu key is not null, this is a path relative to the module to the image to use for the URL in the menu.

getMenuImagePath() - Method in class com.serotonin.m2m2.module.UrlMappingDefinition

getMenuItems() - Static method in class com.serotonin.m2m2.module.ModuleRegistry

getMenuKey() - Method in class com.serotonin.m2m2.module.UrlMappingDefinition

If not null, this is the reference key to the description that will be provided in the menu for this URL.

getModule() - Method in class com.serotonin.m2m2.module.ModuleElementDefinition

Access to the module class that owns this definition.

getModule(String) - Static method in class com.serotonin.m2m2.module.ModuleRegistry

Returns the instance of the module or null if not found for the given module name.

getModules() - Static method in class com.serotonin.m2m2.module.ModuleRegistry

getName() - Method in class com.serotonin.m2m2.module.Module

getPermission() - Method in class com.serotonin.m2m2.module.UrlMappingDefinition

The permission to use when allowing access to the URL, or displaying the URL to a user.

getPublisherDefinition(String) - Static method in class com.serotonin.m2m2.module.ModuleRegistry

getPublisherDefinitionTypes() - Static method in class com.serotonin.m2m2.module.ModuleRegistry

getPublisherTypeName() - Method in class com.serotonin.m2m2.module.PublisherDefinition

An internal identifier for this type of publisher.

getSectionJspPath() - Method in class com.serotonin.m2m2.module.SystemSettingsDefinition

The module relative path to the JSP file that provides the user interface for editing the system settings.

getServletClass() - Method in class com.serotonin.m2m2.module.ServletDefinition

getSourceDisabledMessage() - Method in class com.serotonin.m2m2.module.EventTypeDefinition

Optional.

getStartPriority() - Method in class com.serotonin.m2m2.module.DataSourceDefinition

Override this method as required.

getSystemEventTypeDefinition(String) - Static method in class com.serotonin.m2m2.module.ModuleRegistry

getTypeName() - Method in class com.serotonin.m2m2.module.AuditEventTypeDefinition

The type name of the audit event.

getTypeName() - Method in class com.serotonin.m2m2.module.EventTypeDefinition

The type name of the system event.

getTypeName() - Method in class com.serotonin.m2m2.module.SystemEventTypeDefinition

The type name of the system event.

getUpgradePackage() - Method in class com.serotonin.m2m2.module.DatabaseSchemaDefinition

The Java package in which upgrade classes can be found.

getUriPattern() - Method in class com.serotonin.m2m2.module.ServletDefinition

getUrlPath() - Method in class com.serotonin.m2m2.module.UrlMappingDefinition

The absolute URL path.

getVendor() - Method in class com.serotonin.m2m2.module.Module

getVendorUrl() - Method in class com.serotonin.m2m2.module.Module

getVersion() - Method in class com.serotonin.m2m2.module.Module

getWebPath() - Method in class com.serotonin.m2m2.module.Module

I

importAsList() - Method in class com.serotonin.m2m2.module.EmportDefinition

initialize() - Method in class com.serotonin.m2m2.module.DwrConversionDefinition

initialize() - Method in class com.serotonin.m2m2.module.ModuleElementDefinition

initialize(boolean) - Method in class com.serotonin.m2m2.module.RuntimeManagerDefinition

Run code that initializes things within the module.

isMarkedForDeletion() - Method in class com.serotonin.m2m2.module.Module

L

LICDEF - Static variable in class com.serotonin.m2m2.module.ModuleRegistry

licenseCheck(boolean) - Method in interface com.serotonin.m2m2.module.LicenseDefinition

Provides the module an opportunity to check it's license.

LicenseDefinition - Interface in com.serotonin.m2m2.module

A license definition allows the module to check the validity of its license, take action as necessary.

LongPollDefinition - Class in com.serotonin.m2m2.module

m2m2 uses AJAX extensively to implement both an effective and simple user interface, and rapid and automatic page updating for system monitoring.

LongPollDefinition() - Constructor for class com.serotonin.m2m2.module.LongPollDefinition

M

Module - Class in com.serotonin.m2m2.module

All information regarding a module required by the core.

Module(String, String, TranslatableMessage, String, String, String) - Constructor for class com.serotonin.m2m2.module.Module

Module constructor.

ModuleElementDefinition - Class in com.serotonin.m2m2.module

The base level of a module definition class.

ModuleElementDefinition() - Constructor for class com.serotonin.m2m2.module.ModuleElementDefinition

ModuleRegistry - Class in com.serotonin.m2m2.module

The registry of all modules in an m2m2 instance.

ModuleRegistry() - Constructor for class com.serotonin.m2m2.module.ModuleRegistry

N

newInstallationCheck(ExtendedJdbcTemplate) - Method in class com.serotonin.m2m2.module.DatabaseSchemaDefinition

Provides the module an opportunity to check if it is a new installation (typically by checking if a table that it uses exists or not).

P

PublisherDefinition - Class in com.serotonin.m2m2.module

A publisher allows point values to be written (or published) to targets outside of the m2m2 instance.

PublisherDefinition() - Constructor for class com.serotonin.m2m2.module.PublisherDefinition

PurgeDefinition - Class in com.serotonin.m2m2.module

Provides a hook into the system purge process.

PurgeDefinition() - Constructor for class com.serotonin.m2m2.module.PurgeDefinition

R

RuntimeManagerDefinition - Class in com.serotonin.m2m2.module

This definition is notified upon initialization and termination of the application.

RuntimeManagerDefinition() - Constructor for class com.serotonin.m2m2.module.RuntimeManagerDefinition

S

ServletDefinition - Class in com.serotonin.m2m2.module

A servlet definition provides the necessary information to register a servlet into the m2m2 instance.

ServletDefinition() - Constructor for class com.serotonin.m2m2.module.ServletDefinition

setEmailTemplatesDir(String) - Method in class com.serotonin.m2m2.module.Module

setGraphicsDir(String) - Method in class com.serotonin.m2m2.module.Module

setMarkedForDeletion(boolean) - Method in class com.serotonin.m2m2.module.Module

sortByName(List<Module>) - Static method in class com.serotonin.m2m2.module.Module

SystemEventTypeDefinition - Class in com.serotonin.m2m2.module

Used for creating custom system event types.

SystemEventTypeDefinition() - Constructor for class com.serotonin.m2m2.module.SystemEventTypeDefinition

SystemSettingsDefinition - Class in com.serotonin.m2m2.module

This class provides a means to insert a section into the system settings page.

SystemSettingsDefinition() - Constructor for class com.serotonin.m2m2.module.SystemSettingsDefinition

T

terminate() - Method in class com.serotonin.m2m2.module.RuntimeManagerDefinition

Run code that terminates things within the module/

U

uninstall() - Method in class com.serotonin.m2m2.module.DataSourceDefinition

If the module is uninstalled, delete any data sources of this type.

uninstall() - Method in class com.serotonin.m2m2.module.Module

Called upon shutdown on modules that have been marked for deletion.

uninstall() - Method in class com.serotonin.m2m2.module.ModuleElementDefinition

This method is run once at shutdown if the owning module has been marked for deletion.

UrlMappingDefinition - Class in com.serotonin.m2m2.module

A URL mapping definition creates a page - and optionally a menu item - accessible by m2m2 users.

UrlMappingDefinition() - Constructor for class com.serotonin.m2m2.module.UrlMappingDefinition

UrlMappingDefinition.Permission - Enum in com.serotonin.m2m2.module

The available permission types for the URL.

V

valueOf(String) - Static method in enum com.serotonin.m2m2.module.DataSourceDefinition.StartPriority

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.serotonin.m2m2.module.UrlMappingDefinition.Permission

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.serotonin.m2m2.module.DataSourceDefinition.StartPriority

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.serotonin.m2m2.module.UrlMappingDefinition.Permission

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G I L M N P R S T U V