ROME - Home

Welcome to ROME

ROME is a Java framework for RSS and Atom feeds. It's open source and licensed under the Apache 2.0 license.

ROME includes a set of parsers and generators for the various flavors of syndication feeds, as well as converters to convert from one format to another. The parsers can give you back Java objects that are either specific for the format you want to work with, or a generic normalized SyndFeed class that lets you work on with the data without bothering about the incoming or outgoing feed type.

ROME Subprojects

Subproject	Purpose
Modules	Provide support for feed extensions such as GeoRSS, iTunes, Microsoft SSE and SLE, Google GData and others.
Fetcher (deprecated)	A caching feed fetcher that supports retrieval of feeds via HTTP conditional GET. Supports ETags, GZip compression, and RFC3229 Delta encoding.
Propono	Supports publishing protocols, specifically the Atom Publishing Protocol and the legacy MetaWeblog API. Propono includes an Atom client library, an Atom server framework and a Blog client that supports both Atom protocol and the MetaWeblog API.
OPML	Outline Processor Markup Language (OPML) parser and tools.

Further information

ROME Releases (rome)
Working with ROME
- What part of the API you should be using (rome)
- Tutorials and Articles (rome)
Articles about ROME
- Project Motivation - why we started ROME
- API FAQ, why things are like they are
- Evaluation of existing RSS parsing libraries
Inside ROME, How Things Work
- How ROME Works, Understanding ROME, a detailed overview by Dave Johnson (This doc is based on ROME v0.4)
- ROME Plugins Mechanism, bootstrap, adding and changing parsers, generators, converters and modules
- Feeds Date Elements, how Date data is mapped to SyndFeed and SyndEntry
- Feed and Entry URI Mapping, how SyndFeed and SyndEntry 'uri' properties map to concrete feed elements
- XML Charset Encoding Detection, how ROME helps getting the right charset encoding
- Creating a custom Module, creating all necessary pieces, bean, parser and generator
- The CopyFrom interface (rome)
- ROME bean utilities, equals, toString and cloning
- Customizing Date and time parsing in the rome.properties file
- Using ROME from Maven2
- Using ROME with OSGi
- Preserving Wire Feeds to obtain access to Atom/RSS specific fields
ROME development
- How to build ROME (ROME uses Maven)
- Changes Log, what and when
- ROME Development Process (rome)
- ROME Development Proposals (rome) - proposals for new ROME features and releases