org.apache.abdera.protocol.server
Interface CollectionAdapter

All Known Subinterfaces:

MediaCollectionAdapter

All Known Implementing Classes:

org.apache.abdera.protocol.server.impl.AbstractCollectionAdapter, org.apache.abdera.protocol.server.impl.AbstractEntityCollectionAdapter, AbstractMultipartCollectionAdapter, BasicAdapter, CouchDbAdapter, EmployeeCollectionAdapter, FilesystemAdapter, IBatisCollectionAdapter, JcrCollectionAdapter, ManagedCollectionAdapter, SimpleAdapter

public interface CollectionAdapter

The CollectionAdapter interface is the component that provides the business logic of an Atompub server. The Provider will use it's WorkspaceManager to determine which CollectionAdapter to dispatch a request to. Once an adapter is selected, the Provider will determine what kind of request is being made and will forward the request on to the appropriate CollectionAdapter method.

Method Summary

ResponseContext	deleteEntry(RequestContext request) Delete an entry from the collection
ResponseContext	extensionRequest(RequestContext request) Any request that is not covered by the postEntry, deleteEntry, etc methods will be passed on to the extensionRequest method.
ResponseContext	getCategories(RequestContext request) Get an Atompub Categories document
ResponseContext	getEntry(RequestContext request) Get an entry from the collection
ResponseContext	getFeed(RequestContext request) Get the collections Atom feed document
ResponseContext	headEntry(RequestContext request) Get metadata for an entry from the collection
ResponseContext	optionsEntry(RequestContext request) Get options for an entry from the collection
ResponseContext	postEntry(RequestContext request) Post a new entry to the collection
ResponseContext	putEntry(RequestContext request) Update an existing entry

Method Detail

postEntry

ResponseContext postEntry(RequestContext request)

Post a new entry to the collection

deleteEntry

ResponseContext deleteEntry(RequestContext request)

Delete an entry from the collection

getEntry

ResponseContext getEntry(RequestContext request)

Get an entry from the collection

headEntry

ResponseContext headEntry(RequestContext request)

Get metadata for an entry from the collection

optionsEntry

ResponseContext optionsEntry(RequestContext request)

Get options for an entry from the collection

putEntry

ResponseContext putEntry(RequestContext request)

Update an existing entry

getFeed

ResponseContext getFeed(RequestContext request)

Get the collections Atom feed document

getCategories

ResponseContext getCategories(RequestContext request)

Get an Atompub Categories document

extensionRequest

ResponseContext extensionRequest(RequestContext request)

Any request that is not covered by the postEntry, deleteEntry, etc methods will be passed on to the extensionRequest method. This provides an Adapter with the ability to support Atompub protocol extensions.