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

## Package com.sun.syndication.propono.atom.server.impl

Simple APP server implementation that stores entries on disk.

See:
Description

Class Summary
FileBasedAtomHandler | File-based `AtomHandler` implementation that stores entries and media-entries to disk.
FileBasedAtomHandlerFactory | Extends `AtomHandlerFactory` to create and return `FileBasedAtomHandler`.
FileBasedAtomService | File based Atom service.
FileBasedCollection | File based Atom collection implementation.
FileBasedWorkspace | File based Atom service Workspace.

## Package com.sun.syndication.propono.atom.server.impl Description

Simple APP server implementation that stores entries on disk.

This implementation is made up of an `AtomHandler` named `FileBasedAtomHandler` and `FileBasedAtomHandlerFactory`, which sub-classes `AtomHandlerFactory`.

To use this implementation in your web application, here are the steps:

- 1. Add rome-propono-X.Y.jar to your webapp's classpath
- 2. Add the Propono `AtomServlet` to your webapp's web.xml file
- 3. Add a propono.properties file to your webapp's classpath
- 4. Specify which collections you'd like to support
- 5. Deploy your webapp and accesss your new Atom service

Now let's go over each of those steps:

### 1. Add rome-propono-X.Y.jar to your webapp's classpath

Normally this is done by placing the Propono jar in your webapp's `WEB-INF/lib` directory.

### 2. Add the Propono `AtomServlet` to your webapp's web.xml file

For example, you might add something like the following to declare the `AtomServlet` and then to map it to the path `/app`

        <servlet>
            <description>Atom Publishing Protocol Servlet</description>
            <servlet-name>AtomServlet</servlet-name>
            <servlet-class>com.sun.syndication.propono.atom.server.AtomServlet</servlet-class>
        </servlet>

        <servlet-mapping>
            <servlet-name>AtomServlet</servlet-name>
            <url-pattern>/app/*</url-pattern>
        </servlet-mapping>

### 3. Add a propono.properties file to your webapp's classpath

You'll need to specify the name of the file-based Atom factory in `propono.properties`. Here's an example:

        com.sun.syndication.propono.atom.server.AtomHandlerFactory=\
           com.sun.syndication.propono.atom.server.impl.FileBasedAtomHandlerFactory

### 4. Specify which collections you'd like to support

If you put nothing else in the properties file, you'll have an Atom server that supports two collections: "entries" for Atom entries and "resources" for any type of file. If you'd like to setup a different set of collections then see the comments in `FileBasedAtomService` for details on configuring your own collections.

### 5. Deploy your webapp and accesss your new Atom service

Start your webapp and point your Atom client at `/app` to start using your new Atom server capability.

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