Overview | Package | Class | Tree | Deprecated | Index | Help
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

## Package com.connecterra.ale.api

The interface to the Application Level Events (ALE) API.

See:
Description

Interface Summary
ALE | The Application Level Events (ALE) application programming interface.
ALEFactory | A factory for creating instances of complex types used by the `ALE` API.
ECCountReport | Deprecated. Use the following method to include a count in the ECReport: `ECReportSpec.setIncludeCount(boolean)`
ECCountReportOutputSpec | Deprecated. Use `ECReportSpec`
ECInterval | Deprecated. New methods available for setting time intervals in ECSpec.
ECListReport | Deprecated. Use one or more of the following methods to include an EPC list : {@link ECReportSpec#setIncludeEPC(boolean) ,
ECListReportOutputSpec | Deprecated. Use `ECReportSpec`
ECReport | This interface defines the methods which are common to all event cycle report types.
ECReportGroup | This interface defines the methods for the ECReportGroup.
ECReportGroupListMember | This interface defines the methods for the ECReportGroupListMember.
ECReportGroupListMemberMemory |
ECReportOutputSpec | Deprecated. Use `ECReportSpec`.
ECReports | An ECReports object is generated by a single activation of an event cycle within the ALE engine.
ECReportSpec | This interface must be implemented by the objects which describe the individual reports which will be generated by an event cycle.
ECSpec | A specification of an event cycle.
ECSpecInfo | Describes administrative information for an event cycle specification.
ECSubscriptionControls | Describes information pertaining to handling of notification delivery failure.
ECSubscriptionInfo | Describes administrative information for an event cycle specification.

Class Summary
ECIntervalUnit | Deprecated. New methods available for setting time intervals in ECSpec.
ECReportSetSpec | This is a type-safe enum which represents the sets of EPCs which can be included in a report.
ECTerminationCondition | This is a type-safe enum which represents the conditions which can cause an event cycle to terminate.
XMLSerializationSyntax | This is a type-safe enum which represents the types of XML Syntax supported by the ALE Engine.

Exception Summary
ALEException | This is the base class of all exceptions thrown by the ALE api.
DuplicateNameException | This exception is thrown by the ALE API `define` method if the ECSpec already exists.
DuplicateSubscriptionException | This exception is thrown by the ALE API `ALE.subscribe(String, URI)` or `ALE.subscribe(String, URI, ECSubscriptionControls)` methods if the subscription already exists.
ECSpecValidationException | This exception is thrown by the ALE API methods which take an ECSpec argument if the ECSpec is invalid.
EngineException | This exception is thrown when there is an internal failure within the ALE implementation.
ImplementationException | This exception is thrown when there is an internal failure within the ALE implementation.
InvalidURIException | This exception is thrown by the ALE API methods which take a URI argument if the URI has an invalid format, refers to an unimplemented scheme, has an invalid scheme-specific part, or is otherwise unusable by the implementation.
NoSuchNameException | This exception is thrown by the ALE API methods which refer to an ECSpec by name if the name does not refer to any ECSpec.
NoSuchSubscriberException | This exception is thrown by the ALE API `unsubscribe` method if the URI does not refer to an existing subscription.

## Package com.connecterra.ale.api Description

The interface to the Application Level Events (ALE) API. This package contains the primary set of classes and interfaces that applications use to interact with the RFTagAware Edge Server. Through this API, applications can define event cycle specifications (`ECSpec`s) that say how data is to be collected from tags and readers, obtain event cycle data synchronously, and define subscriptions to asynchronous notifications of event cycles.

The main components of the API are:

- The `ALE` interface. This is the primary means of interacting withe the RFTagAware Edge Server. Applications obtain concrete implementations of this interface by using constructors provided in other packages.
- Exception classes thrown by methods of the ALE interface.
- Interfaces that stand for complex types used as arguments and results within the ALE interface. These include event cycle specifications (`ECSpec`), event cycle reports (`ECReports`), and event cycle specification administrative information (`ECSpecInfo`) along with other classes and interfaces that represent subcomponents of these three types.
- A factory interface, `ALEFactory`, for creating instances of the complex types. Each concrete implementation of the `ALE` interface provides a method for obtaining a concrete instance of this factory interface.
- Interfaces for XML serializers and deserializers of the complex types, `XMLSerializer` and `XMLDeserializer`). These interfaces provide the ability to import and export the complex types (`ECSpec`, `ECReports`, and `ECSpecInfo`) via XML. (These interfaces are provided in a different package, `com.connecterra.ale.encoding`.)

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES