Package com.spinn3r.api

Java Spinn3r API Reference

See:
Description

Interface Summary

Client	Base interface for interacting with clients.
EventListener	New and BETA event listener for detecting events in the Spinn3r API core.

Class Summary

BandwidthSampler	Simple performance monitoring system similar to benchmark4j.
BaseClient	Generic client support used which need to be in all APIs.
BaseItem	Represents a single item returned from the API.
BaseResult	Represents a single item returned from the API.
CommentClient	This class is NOT threadsafe.
CommentConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
CommentHistoryClient
CommentHistoryConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
CommentItem	Represents a comment item returned from the API.
Config	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
Debug	Command line debug client for testing the API.
Feed	Represents a source within Spinn3r.
FeedClient	Reference API implementation for fetching Feed content form Spinn3r.
FeedConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
FeedEntryClient
FeedEntryConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
FeedHistoryClient
FeedHistoryConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
FeedItem	Represents a feed item returned from the API.
ISO8601DateParser	ISO 8601 date parsing utility.
LinkClient	This class is NOT threadsafe.
LinkConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
LinkHistoryClient
LinkHistoryConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
LinkItem
Main	Spinn3r command line debug client for testing the API.
PerformanceSampler	Simple performance monitoring system similar to benchmark4j.
PermalinkClient	Reference API implementation for fetching Permalink content form Spinn3r.
PermalinkConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
PermalinkEntryClient
PermalinkEntryConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
PermalinkHistoryClient
PermalinkHistoryConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
PermalinkItem	Represents a single item returned from the API.
PermalinkStatusClient	Deprecated. This code is deprecated and will be removed after 2008-11-01.
PermalinkStatusConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
PrefetchThread
RFC822DateParser	RFC 822 date parsing utility.
Source	Represents a source within Spinn3r.
SourceClient	API client that implements Spinn3r's source registration API.
SourceListClient
SourceListConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.
SourceRegisterClient	API client that implements Spinn3r's source registration API.
SourceRegisterConfig	Used to startup the API and specify defaults for limits, where to start indexing, tiers, language, etc.

Exception Summary

MissingRequiredFieldException
ParseException	Thrown if there's any problem with the underlying XML parsing infrastructure.
UnimplementedException

Package com.spinn3r.api Description

Java Spinn3r API Reference

This is the reference library for the Spinn3r client API.

It provides implementations for both the feed.getDelta and feed.getPermalink methods.

This code was designed to be extremely portable to other langauges which should facilitate bindings in Java, Python, Lisp, Perl, Ruby, etc.

Full API Support

This implementation also correctly handles all features of the API including all fields at the time it was shipped, throttling when no more results were found, pagination, gzip encoding, etc.

Dependencies

The reference API was designed to function without any external dependencies. It uses the internal java.net.URL for HTTP transport and JAXP and DOM for parsing the XML results.

Portability

Right now this library requires JDK 1.5. It should be easy to back port it to JDK 1.4 which we might do if we see a client request.