org.rifidi.edge.api

Class AbstractRifidiApp

java.lang.Object

org.rifidi.edge.api.AbstractRifidiApp

All Implemented Interfaces:

java.lang.Comparable<RifidiApp>, RifidiApp, RifidiAppCommonProperties, org.springframework.osgi.context.BundleContextAware

Direct Known Subclasses:

DBApp, DynamicReaderApp, DynamoDBApp, EdgeMobileApp, GPIOApp, GPISimulatorApp, HelloWorldApp, MqttNotifierApp, MqttNotifierApp, NorthwindApp, PerformanceApp, RifidiAppService, RifidiManagementApp, RifidiServicesApp, SensorMonitor, StatsApp, TagApp, TagGeneratorApp, TagMonitor, TemplateApp, ThingworxApp, TrackingApp, TrackingApp

public abstract class AbstractRifidiApp
extends java.lang.Object
implements RifidiApp, org.springframework.osgi.context.BundleContextAware

This is a base class for all Rifidi Applications to extend.

Author:

Kyle Neumeier - kyle@pramari.com

Field Summary

Fields

Modifier and Type	Field and Description
java.util.HashMap<java.lang.String,ReadZone>	readZones This is a map of ReadZones read in from the readzones directory

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

LAZY_START

Constructor Summary

Constructors

Constructor and Description
AbstractRifidiApp(java.lang.String group, java.lang.String name) Constructor for a AbstractRifidiApp

Method Summary

Modifier and Type	Method and Description
int	compareTo(RifidiApp o)
boolean	equals(java.lang.Object obj)
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.
int	hashCode()
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	setBundleContext(org.osgi.framework.BundleContext arg0)
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

readZones

public java.util.HashMap<java.lang.String,ReadZone> readZones

This is a map of ReadZones read in from the readzones directory

Constructor Detail

AbstractRifidiApp

public AbstractRifidiApp(java.lang.String group,
                         java.lang.String name)

Constructor for a AbstractRifidiApp

Parameters:

group - the group this application is a part of

name - The name of the application

Method Detail

getName

public java.lang.String getName()

Description copied from interface: RifidiApp

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

Specified by:

getName in interface RifidiApp

Returns:

The name of the application

getGroup

public java.lang.String getGroup()

Description copied from interface: RifidiApp

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.

Specified by:

getGroup in interface RifidiApp

Returns:

The group the application belongs to.

getState

public AppState getState()

Description copied from interface: RifidiApp

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

Specified by:

getState in interface RifidiApp

Returns:

The state of the application

setEsperService

public void setEsperService(EsperManagementService esperService)

Description copied from interface: RifidiApp

Used to set the esper service for this application

Specified by:

setEsperService in interface RifidiApp

Parameters:

esperService - the esperService to set

setAppProperties

public void setAppProperties(java.util.Properties properties)

Description copied from interface: RifidiApp

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

Specified by:

setAppProperties in interface RifidiApp

setBundleContext

public void setBundleContext(org.osgi.framework.BundleContext arg0)

Specified by:

setBundleContext in interface org.springframework.osgi.context.BundleContextAware

initialize

public void initialize()

Description copied from interface: RifidiApp

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.

Specified by:

initialize in interface RifidiApp

lazyStart

public boolean lazyStart()

Description copied from interface: RifidiApp

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

Specified by:

lazyStart in interface RifidiApp

Returns:

start

public final void start()

Description copied from interface: RifidiApp

This method is called to start the application.

Specified by:

start in interface RifidiApp

stop

public final void stop()

Description copied from interface: RifidiApp

This method is called to stop the application.

Specified by:

stop in interface RifidiApp

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(RifidiApp o)

Specified by:

compareTo in interface java.lang.Comparable<RifidiApp>