Package org.apache.abdera.protocol.server.impl

Class AbstractEntityCollectionAdapter<T>

java.lang.Object

org.apache.abdera.protocol.server.impl.AbstractCollectionAdapter

org.apache.abdera.protocol.server.impl.AbstractEntityCollectionAdapter<T>

Type Parameters:

T - The entity that this is backed by.

All Implemented Interfaces:

CollectionAdapter, CollectionInfo, MediaCollectionAdapter, Transactional

@Deprecated
public abstract class AbstractEntityCollectionAdapter<T>
extends AbstractCollectionAdapter

Deprecated.

Legacy AEM 6.x API.

By extending this class it becomes easy to build Collections which are backed by a set of entities - such as a database row, domain objects, or files.

Constructor Summary

Constructors

Constructor	Description
AbstractEntityCollectionAdapter()	Deprecated.

Method Summary

Modifier and Type	Method	Description
abstract void	deleteEntry(String resourceName, RequestContext request)	Deprecated. Delete an entry
ResponseContext	deleteEntry(RequestContext request)	Deprecated. Delete an entry from the collection
void	deleteMedia(String resourceName, RequestContext request)	Deprecated. Delete a media resource.
ResponseContext	deleteMedia(RequestContext request)	Deprecated. Delete a media resource from the collection
List<org.apache.abdera.model.Person>	getAuthors(T entry, RequestContext request)	Deprecated. Get the authors for an entry.
abstract Object	getContent(T entry, RequestContext request)	Deprecated. Get the content for the entry.
String	getContentType(T entry)	Deprecated. Get the content-type for the entry.
abstract Iterable<T>	getEntries(RequestContext request)	Deprecated. Get the listing of entries requested
abstract T	getEntry(String resourceName, RequestContext request)	Deprecated. Get a specific entry
ResponseContext	getEntry(RequestContext request)	Deprecated. Get an entry from the collection
ResponseContext	getFeed(RequestContext request)	Deprecated. Get the collections Atom feed document
abstract String	getId(T entry)	Deprecated. Gets the UUID for the specified entry.
ResponseContext	getMedia(RequestContext request)	Deprecated. Get a media resource
String	getMediaName(T entry)	Deprecated. Get the name of the media resource.
InputStream	getMediaStream(T entry)	Deprecated. Get an input stream for the media resource.
abstract String	getName(T entry)	Deprecated. Get the name of the entry resource (used to construct links)
org.apache.abdera.model.Text	getSummary(T entry, RequestContext request)	Deprecated. Get the summary of the entry.
abstract String	getTitle(T entry)	Deprecated. Get the title fo the entry
abstract Date	getUpdated(T entry)	Deprecated. Get the value to use in the atom:updated element
ResponseContext	headEntry(RequestContext request)	Deprecated. Get metadata for an entry from the collection
ResponseContext	headMedia(RequestContext request)	Deprecated. Get metdata for a media resource
boolean	isMediaEntry(T entry)	Deprecated. True if this entry is a media-link entry.
abstract T	postEntry(String title, org.apache.abdera.i18n.iri.IRI id, String summary, Date updated, List<org.apache.abdera.model.Person> authors, org.apache.abdera.model.Content content, RequestContext request)	Deprecated. Create a new entry
ResponseContext	postEntry(RequestContext request)	Deprecated. Post a new entry to the collection
T	postMedia(MimeType mimeType, String slug, InputStream inputStream, RequestContext request)	Deprecated. Post a new media resource to the collection.
ResponseContext	postMedia(RequestContext request)	Deprecated. Add a new media resource to the collection, resulting in the creation of a new Media Link Entry.
ResponseContext	putEntry(RequestContext request)	Deprecated. Update an existing entry
abstract void	putEntry(T entry, String title, Date updated, List<org.apache.abdera.model.Person> authors, String summary, org.apache.abdera.model.Content content, RequestContext request)	Deprecated. Update an entry.
ResponseContext	putMedia(RequestContext request)	Deprecated. Update a media resource
void	putMedia(T entryObj, MimeType contentType, String slug, InputStream inputStream, RequestContext request)	Deprecated. Update a media resource.

Methods inherited from class org.apache.abdera.protocol.server.impl.AbstractCollectionAdapter

asCollectionElement, compensate, end, extensionRequest, getAccepts, getAuthor, getCategories, getCategoriesInfo, getHref, getHref, getId, optionsEntry, optionsMedia, setHref, start

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.abdera.protocol.server.CollectionInfo

getTitle

Constructor Detail

AbstractEntityCollectionAdapter

public AbstractEntityCollectionAdapter()

Deprecated.

Method Detail

postEntry

public abstract T postEntry(String title,
                            org.apache.abdera.i18n.iri.IRI id,
                            String summary,
                            Date updated,
                            List<org.apache.abdera.model.Person> authors,
                            org.apache.abdera.model.Content content,
                            RequestContext request)
                     throws ResponseContextException

Deprecated.

Create a new entry

Parameters:

title - The title of the entry (assumes that type="text")

id - The value of the atom:id element

summary - The summary of the entry

updated - The value of the atom:updated element

authors - Listing of atom:author elements

context - The content of the entry

request - The request context

Throws:

ResponseContextException

postMedia

public ResponseContext postMedia(RequestContext request)

Deprecated.

Description copied from interface: MediaCollectionAdapter

Add a new media resource to the collection, resulting in the creation of a new Media Link Entry.

Specified by:

postMedia in interface MediaCollectionAdapter

Overrides:

postMedia in class AbstractCollectionAdapter

putMedia

public ResponseContext putMedia(RequestContext request)

Deprecated.

Description copied from interface: MediaCollectionAdapter

Update a media resource

Specified by:

putMedia in interface MediaCollectionAdapter

Overrides:

putMedia in class AbstractCollectionAdapter

putMedia

public void putMedia(T entryObj,
                     MimeType contentType,
                     String slug,
                     InputStream inputStream,
                     RequestContext request)
              throws ResponseContextException

Deprecated.

Update a media resource. By default this method is not allowed. Implementations must override this method to support media resource updates

Parameters:

entryObj -

contentType - The mime-type of the media resource

slug - The value of the Slug request header

inputStream - An input stream providing access to the request payload

request - The request context

Throws:

ResponseContextException

postEntry

public ResponseContext postEntry(RequestContext request)

Deprecated.

Description copied from interface: CollectionAdapter

Post a new entry to the collection

postMedia

public T postMedia(MimeType mimeType,
                   String slug,
                   InputStream inputStream,
                   RequestContext request)
            throws ResponseContextException

Deprecated.

Post a new media resource to the collection. By default, this method is not supported. Implementations must override this method to support posting media resources

Parameters:

mimeType - The mime-type of the resource

slug - The value of the Slug header

inputStream - An InputStream providing access to the request payload

request - The request context

Throws:

ResponseContextException

deleteEntry

public ResponseContext deleteEntry(RequestContext request)

Deprecated.

Description copied from interface: CollectionAdapter

Delete an entry from the collection

deleteEntry

public abstract void deleteEntry(String resourceName,
                                 RequestContext request)
                          throws ResponseContextException

Deprecated.

Delete an entry

Parameters:

resourceName - The entry to delete

request - The request context

Throws:

ResponseContextException

deleteMedia

public ResponseContext deleteMedia(RequestContext request)

Deprecated.

Description copied from interface: MediaCollectionAdapter

Delete a media resource from the collection

Specified by:

deleteMedia in interface MediaCollectionAdapter

Overrides:

deleteMedia in class AbstractCollectionAdapter

deleteMedia

public void deleteMedia(String resourceName,
                        RequestContext request)
                 throws ResponseContextException

Deprecated.

Delete a media resource. By default this method is not supported. Implementations must override this method to support deleting media resources

Throws:

ResponseContextException

getAuthors

public List<org.apache.abdera.model.Person> getAuthors(T entry,
                                                       RequestContext request)
                                                throws ResponseContextException

Deprecated.

Get the authors for an entry. By default this returns null. Implementations must override in order to providing a listing of authors for an entry

Throws:

ResponseContextException

getContent

public abstract Object getContent(T entry,
                                  RequestContext request)
                           throws ResponseContextException

Deprecated.

Get the content for the entry.

Throws:

ResponseContextException

getContentType

public String getContentType(T entry)

Deprecated.

Get the content-type for the entry. By default this operation is not supported.

getEntries

public abstract Iterable<T> getEntries(RequestContext request)
                                throws ResponseContextException

Deprecated.

Get the listing of entries requested

Throws:

ResponseContextException

getEntry

public ResponseContext getEntry(RequestContext request)

Deprecated.

Description copied from interface: CollectionAdapter

Get an entry from the collection

getEntry

public abstract T getEntry(String resourceName,
                           RequestContext request)
                    throws ResponseContextException

Deprecated.

Get a specific entry

Parameters:

resourceName - The entry to get

request - The request context

Throws:

ResponseContextException

headEntry

public ResponseContext headEntry(RequestContext request)

Deprecated.

Description copied from interface: CollectionAdapter

Get metadata for an entry from the collection

Specified by:

headEntry in interface CollectionAdapter

Overrides:

headEntry in class AbstractCollectionAdapter

headMedia

public ResponseContext headMedia(RequestContext request)

Deprecated.

Description copied from interface: MediaCollectionAdapter

Get metdata for a media resource

Specified by:

headMedia in interface MediaCollectionAdapter

Overrides:

headMedia in class AbstractCollectionAdapter

getFeed

public ResponseContext getFeed(RequestContext request)

Deprecated.

Description copied from interface: CollectionAdapter

Get the collections Atom feed document

getId

public abstract String getId(T entry)
                      throws ResponseContextException

Deprecated.

Gets the UUID for the specified entry.

Parameters:

entry -

Returns:

Throws:

ResponseContextException

getMedia

public ResponseContext getMedia(RequestContext request)

Deprecated.

Description copied from interface: MediaCollectionAdapter

Get a media resource

Specified by:

getMedia in interface MediaCollectionAdapter

Overrides:

getMedia in class AbstractCollectionAdapter

getMediaName

public String getMediaName(T entry)
                    throws ResponseContextException

Deprecated.

Get the name of the media resource. By default this method is unsupported. Implementations must override.

Throws:

ResponseContextException

getMediaStream

public InputStream getMediaStream(T entry)
                           throws ResponseContextException

Deprecated.

Get an input stream for the media resource. By default this method is unsupported. Implementations must override.

Throws:

ResponseContextException

getName

public abstract String getName(T entry)
                        throws ResponseContextException

Deprecated.

Get the name of the entry resource (used to construct links)

Throws:

ResponseContextException

getTitle

public abstract String getTitle(T entry)
                         throws ResponseContextException

Deprecated.

Get the title fo the entry

Throws:

ResponseContextException

getUpdated

public abstract Date getUpdated(T entry)
                         throws ResponseContextException

Deprecated.

Get the value to use in the atom:updated element

Throws:

ResponseContextException

isMediaEntry

public boolean isMediaEntry(T entry)
                     throws ResponseContextException

Deprecated.

True if this entry is a media-link entry. By default this always returns false. Implementations must override to support media link entries

Throws:

ResponseContextException

putEntry

public ResponseContext putEntry(RequestContext request)

Deprecated.

Description copied from interface: CollectionAdapter

Update an existing entry

putEntry

public abstract void putEntry(T entry,
                              String title,
                              Date updated,
                              List<org.apache.abdera.model.Person> authors,
                              String summary,
                              org.apache.abdera.model.Content content,
                              RequestContext request)
                       throws ResponseContextException

Deprecated.

Update an entry.

Parameters:

entry - The entry to update

title - The new title of the entry

updated - The new value of atom:updated

authors - To new listing of authors

summary - The new summary

content - The new content

request - The request context

Throws:

ResponseContextException

getSummary

public org.apache.abdera.model.Text getSummary(T entry,
                                               RequestContext request)
                                        throws ResponseContextException

Deprecated.

Get the summary of the entry. By default this returns null.

Throws:

ResponseContextException