org.rifidi.edge.api

Interface RifidiApp

All Superinterfaces:

java.lang.Comparable<RifidiApp>, RifidiAppCommonProperties

All Known Implementing Classes:

AbstractRifidiApp, DBApp, DynamicReaderApp, DynamoDBApp, GPIOApp, GPISimulatorApp, HelloWorldApp, LimitStableSetServiceImpl, NorthwindApp, ReadZoneMonitoringServiceImpl, RifidiAppService, RifidiManagementApp, RifidiMqttApp, RifidiServicesApp, RSSIMonitoringServiceImpl, SensorMonitor, SensorStatusMonitoringServiceImpl, SerialApp, StableSetServiceImpl, TagApp, TagGeneratorApp, TagMonitor, TemplateApp, ThingworxApp, TrackingApp, UniqueTagBatchIntervalServiceImpl, UniqueTagIntervalServiceImpl

public interface RifidiApp
extends java.lang.Comparable<RifidiApp>, RifidiAppCommonProperties

This is the interface for a RifidiApp. A RifidiApp provides some base set of services to applications running on the Rifidi edge server. This interface should not be implemented directlry. Instead, clients should extend the AbstractRifidiApp

Author:

Kyle Neumeier - kyle@pramari.com

Field Summary

Fields inherited from interface org.rifidi.edge.api.RifidiAppCommonProperties

LAZY_START

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getGroup() A group is a set of applications within some logical domain.
java.lang.String	getName() Each application has a name that is unique within it's group
AppState	getState() Each application has a state that is either running or stopped.
void	initialize() The initialize method can be used to do any work that needs to be done right before the start method is called.
boolean	lazyStart() If this method returns true, the application will not be started when it is loaded.
void	setAppProperties(java.util.Properties properties) Used to set the Properties for this application Set the properties for this application
void	setEsperService(EsperManagementService esperService) Used to set the esper service for this application
void	start() This method is called to start the application.
void	stop() This method is called to stop the application.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

java.lang.String getName()

Each application has a name that is unique within it's group

Returns:

The name of the application

getGroup

java.lang.String getGroup()

A group is a set of applications within some logical domain. For example, the Acme company maye have one set of applications that deal with dock door receiving, and another set of applications that deal with inventory management.

Returns:

The group the application belongs to.

getState

AppState getState()

Each application has a state that is either running or stopped.

Returns:

The state of the application

setEsperService

void setEsperService(EsperManagementService esperService)

Used to set the esper service for this application

Parameters:

esperService - the esperService to set

setAppProperties

void setAppProperties(java.util.Properties properties)

Used to set the Properties for this application Set the properties for this application

Parameters:

properties -

lazyStart

boolean lazyStart()

If this method returns true, the application will not be started when it is loaded.

Returns:

initialize

void initialize()

The initialize method can be used to do any work that needs to be done right before the start method is called. It can be used to set properties read in from the properties file.

start

void start()

This method is called to start the application.

stop

void stop()

This method is called to stop the application.