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

## Package com.connecterra.alepc.api

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

See:
Description

Interface Summary
AccessReport | The subpart of the PCWriteReport that corresponds to an AccessSpec in the PCSpec.
AccessSpec | A specification for a series of operations to perform on each tag in the field during a programming cycle.
ALEPC | The Application Level Events (ALE) tag programming API.
ALEPCFactory | A factory for creating instances of complex types used by the `ALEPC` API.
DataSpec | The superclass for the data specs that provide reference to ways of getting content from various sources.
EPCCacheDataSpec | Specifies an EPC Cache data source for tag data to be written to a tag.
EPCCacheReport | Report issued to indicate that an EPC cache has reached a low-level reporting threshold.
EPCCacheSpec | A specification of an EPC cache.
EPCCacheSpecInfo | Describes administrative information for an EPC cache.
EPCPatterns | Simple value object that holds a list of EPC pattern URIs.
KillOpSpec | Operation Spec representing a request to transition the tag into "killed" state.
LiteralDataSpec | Specifies a static, literal value, as either data to be written to a tag, or a password to gain access a tag's capabilities.
LockOpSpec | Operation Spec representing a request to set the lock values on a tag.
OpReport | The result of a single operation on a tag.
OpSpec | The superclass for the operation specs that can be included in an AccessSpec.
ParamDataSpec | Specifies a parameterized value, either retrieved from the PCSpec reader parameters or from the parameters provided in an ALEPC immediate or poll call.
PasswordOpSpec | Operation Spec representing a request to move the tag into "secured" state.
PCSpec | A specification of an EPC Programming Cycle.
PCSpecInfo | Describes administrative information for a programming cycle specification.
PCSubscriptionControls | Describes information pertaining to handling of notification delivery failure.
PCSubscriptionInfo | Describes administrative information for an event cycle specification.
PCWriteReport | Interface for reports issued when a programming cycle completes an EPC writing operation.
ReadOpSpec | Operation Spec representing a request to read data from a tag.
TagReport | The results of an AccessSpec working on a given tag in field.
WriteOpSpec | Operation Spec representing a request to write data to the tag.

Class Summary
PCStatus | This is a type-safe enum which represents the conditions under which a programming cycle can fail.
PCTerminationCondition | This is a type-safe enum which represents the conditions which can cause a programming cycle to terminate with a failure.

Exception Summary
CacheInUseException | This exception is thrown by the ALEPC API methods if an attempt is made to undefine an EPC cache that is referenced by any PCSpecs.
CacheSpecValidationException | This exception is thrown by the ALEPC API methods which take an EPCCacheSpec argument if the spec is invalid.
InvalidPatternsException | This exception is thrown by the ALEPC API methods which take a EPCPatterns argument if the EPCPatterns is invalid or unusable.
NoSuchCacheException | This exception is thrown by the ALEPC API methods when a PCSpec to be defined references an EPC cache that does not exist.
NoSuchSpecException | This exception is thrown by the ALEPC API methods which take a PCSpec name argument if there is no such programming specification defined.
PCSpecValidationException | This exception is thrown by the ALEPC API methods which take an PCSpec argument if the spec is invalid.

## Package com.connecterra.alepc.api Description

The interface to the Application Level Events (ALE) Tag Programming API. The term "tag programming" refers to the act of causing an EPC value to become associated with some physical entity, such as an RFID tag or a printed label.

This package contains the primary set of classes and interfaces that applications use to interact with the RFTagAware Edge Server for programming EPC-compliant tags. Through this API, applications can define programming cycle specifications (`PCSpec`s) that say how tag values are to be written to tags using readers, obtain tag writing results synchronously, and define subscriptions to asynchronous notifications of programming cycles.

Applications can also define EPC cache specifications (`EPCCacheSpec`s) that provide EPC patterns which are used to obtain EPC values for programming cycles, and define subscriptions to asynchronous notifications of EPC cache-low events.

The main components of the tag programming API are:

- The `ALEPC` interface. This is the primary means of interacting withe the RFTagAware Edge Server for programming tags and administering EPC caches. Applications obtain concrete implementations of this interface by using constructors provided in other packages.
- Exception classes thrown by methods of the ALEPC interface.
- Interfaces that stand for complex types used as arguments and results within the ALEPC interface. These include programming cycle specifications (`PCSpec`), programming cycle reports (`PCWriteReport`), programming cycle specification administrative information (`PCSpecInfo`), EPC cache specifications (`EPCCacheSpec`), cache reports (`EPCCacheReport`), and cache specification administrative information (`EPCCacheSpecInfo`), along with other classes and interfaces that represent subcomponents of these types.
- A factory interface, `ALEPCFactory`, for creating instances of the complex types. Each concrete implementation of the `ALEPC` interface provides a method for obtaining a concrete instance of this factory interface.
- Interfaces for XML serializers and deserializers of the complex types, `PCXMLSerializer` and `PCXMLDeserializer`). These interfaces provide the ability to import and export the complex types (`PCSpec`, `EPCCacheSpec`, `PCWriteReport`, `EPCCacheReport`, `PCSpecInfo`, and `EPCCacheSpecInfo`) via XML. (These interfaces are provided in a different package, `com.connecterra.alepc.encoding`.)

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