Package org.biffle.cliff.pearl

This package provides various interfaces to devices using the Pearl protocol.

See:
          Description

Interface Summary
FileDataListener Used by objects that handle callbacks while a PearlConnection implementation is receiving a file.
FileInfoListener Used by objects that handle FileInfo callbacks from PearlConnection.
PearlConnection Objects implementing PearlConnection provide a reasonably low-level interface to the Pearl protocol, with no caching.
ProgressListener Implemented by objects that handle command-progress callbacks from PearlConnection.
 

Class Summary
DeviceInfo Provides details on a Pearl device.
DeviceSettings Wrapper for the Device Settings properties file returned from the Pearl device.
FileInfo Wrapper for a file metainfo properties file.
Message Represents a Pearl protocol message.
PearlTCPConnection Provides a TCP implementation of the Pearl protocol.
PropSet Encapsulates the 'properties files' used by Pearl devices for both device settings and file metadata.
StorageInfo Provides details on a storage device within the Pearl device.
Util Utility functions -- anything I found myself repeating over and over.
 

Exception Summary
FailureException Thrown when a Pearl command returns a normal response with a failure status code.
NAKException Thrown when the Pearl device replies to a command with a NAK message.
PearlException Thrown when something goes awry in the Pearl protocol internals.
PearlIOException Used as a wrapper for unexpected IOExceptions thrown during Pearl processing.
UnexpectedResponseException Thrown when the Pearl device sends a message other than what was expected -- namely, a message whose Message Type differs from the request.
VersionException Thrown when something goes awry in the Pearl protocol internals.
 

Package org.biffle.cliff.pearl Description

This package provides various interfaces to devices using the Pearl protocol.

The most basic interface is PearlConnection, which provides a reasonably low-level interface to the protocol and leaves duties such as caching to the user. The command-line example class, Client, demonstrates the use of PearlConnection and its network-minded implementation, PearlTCPConnection.