com.rometools.propono.blogclient.atomprotocol

Class AtomBlog

java.lang.Object

com.rometools.propono.blogclient.atomprotocol.AtomBlog

All Implemented Interfaces:

Blog

Deprecated.

Propono will be removed in Rome 2.

@Deprecated
public class AtomBlog
extends java.lang.Object
implements Blog

Atom protocol implementation of the BlogClient Blog interface.

Nested Class Summary

Nested classes/interfaces inherited from interface com.rometools.propono.blogclient.Blog

Blog.Collection

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,AtomCollection>	collections Deprecated.
private AtomCollection	entriesCollection Deprecated.
private java.lang.String	name Deprecated.
private AtomCollection	resourcesCollection Deprecated.
private ClientAtomService	service Deprecated.
private ClientWorkspace	workspace Deprecated.

Constructor Summary

Constructors

Constructor and Description
AtomBlog(ClientAtomService service, ClientWorkspace workspace) Deprecated. Create AtomBlog using specified HTTPClient, user account and workspace, called by AtomConnection.

Method Summary

Modifier and Type	Method and Description
(package private) void	deleteEntry(BlogEntry entry) Deprecated.
(package private) void	deleteResource(BlogResource resource) Deprecated.
java.util.List<BlogEntry.Category>	getCategories() Deprecated. Returns list of available BlogEntry.Category in primary entries collection.
Blog.Collection	getCollection(java.lang.String token) Deprecated. Get collection by token.
java.util.List<Blog.Collection>	getCollections() Deprecated. Gets listing of entry and resource collections available in the blog, including the primary collections.
java.util.Iterator<BlogEntry>	getEntries() Deprecated. Get iterator over entries in primary entries collection (the first collection that accepts entries).
BlogEntry	getEntry(java.lang.String token) Deprecated. Get a single BlogEntry (or BlogResource) by token.
java.lang.String	getName() Deprecated. Name of this blog.
java.util.Iterator<BlogEntry>	getResources() Deprecated. Get entries in primary resources collection (the first collection that accepts anything other than entries).
(package private) ClientAtomService	getService() Deprecated.
java.lang.String	getToken() Deprecated. Token can be used to fetch this blog again from getBlog() method.
(package private) ClientWorkspace	getWorkspace() Deprecated.
BlogEntry	newEntry() Deprecated. Create but do not save it to server new BlogEntry in primary entries collection (the first collection found that accepts entries).
BlogResource	newResource(java.lang.String name, java.lang.String contentType, byte[] bytes) Deprecated. Create but do not save it to server new BlogResource in primary resources collection (the first collection found that accepts resources).
(package private) java.lang.String	saveEntry(BlogEntry entry) Deprecated.
(package private) java.lang.String	saveResource(BlogResource res) Deprecated.
(package private) void	setService(ClientAtomService service) Deprecated.
(package private) void	setWorkspace(ClientWorkspace workspace) Deprecated.
java.lang.String	toString() Deprecated. String display of blog, returns name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

private java.lang.String name

Deprecated.

service

private ClientAtomService service

Deprecated.

workspace

private ClientWorkspace workspace

Deprecated.

entriesCollection

private AtomCollection entriesCollection

Deprecated.

resourcesCollection

private AtomCollection resourcesCollection

Deprecated.

collections

private final java.util.Map<java.lang.String,AtomCollection> collections

Deprecated.

Constructor Detail

AtomBlog

AtomBlog(ClientAtomService service,
         ClientWorkspace workspace)

Deprecated.

Create AtomBlog using specified HTTPClient, user account and workspace, called by AtomConnection. Fetches Atom Service document and creates an AtomCollection object for each collection found. The first entry collection is considered the primary entry collection. And the first resource collection is considered the primary resource collection.

Method Detail

getName

public java.lang.String getName()

Deprecated.

Name of this blog.

Specified by:

getName in interface Blog

Returns:

Display name of this blog.

toString

public java.lang.String toString()

Deprecated.

String display of blog, returns name.

Overrides:

toString in class java.lang.Object

getToken

public java.lang.String getToken()

Deprecated.

Token can be used to fetch this blog again from getBlog() method.

Specified by:

getToken in interface Blog

Returns:

Blog object specified by token.

newEntry

public BlogEntry newEntry()
                   throws BlogClientException

Deprecated.

Create but do not save it to server new BlogEntry in primary entries collection (the first collection found that accepts entries). To save the entry to the server to a collection, use the entry's save() method.

Specified by:

newEntry in interface Blog

Returns:

Unsaved BlogEntry in primary entries collection.

Throws:

BlogClientException - On error or if there is no primary entries collection.

getEntry

public BlogEntry getEntry(java.lang.String token)
                   throws BlogClientException

Deprecated.

Get a single BlogEntry (or BlogResource) by token.

Specified by:

getEntry in interface Blog

Parameters:

token - Token from blog entry's getToken() method.

Returns:

Blog entry specified by token.

Throws:

BlogClientException

getEntries

public java.util.Iterator<BlogEntry> getEntries()
                                         throws BlogClientException

Deprecated.

Get iterator over entries in primary entries collection (the first collection that accepts entries). Note that entries may be partial, so don't try to update and save them: to update and entry, first fetch it with getEntry(), change fields, then call entry.save();

Specified by:

getEntries in interface Blog

Returns:

To iterate over all entries in collection.

Throws:

BlogClientException - On failure or if there is no primary entries collection.

getResources

public java.util.Iterator<BlogEntry> getResources()
                                           throws BlogClientException

Deprecated.

Get entries in primary resources collection (the first collection that accepts anything other than entries).

Specified by:

getResources in interface Blog

Returns:

To iterate over all resojrces in collection.

Throws:

BlogClientException - On failure or if there is no primary resources collection.

saveEntry

java.lang.String saveEntry(BlogEntry entry)
                    throws BlogClientException

Deprecated.

Throws:

BlogClientException

deleteEntry

void deleteEntry(BlogEntry entry)
          throws BlogClientException

Deprecated.

Throws:

BlogClientException

getCategories

public java.util.List<BlogEntry.Category> getCategories()
                                                 throws BlogClientException

Deprecated.

Returns list of available BlogEntry.Category in primary entries collection.

Specified by:

getCategories in interface Blog

Returns:

List of BlogEntry.Category objects.

Throws:

BlogClientException - On error or if there is no primary entries collection.

newResource

public BlogResource newResource(java.lang.String name,
                                java.lang.String contentType,
                                byte[] bytes)
                         throws BlogClientException

Deprecated.

Create but do not save it to server new BlogResource in primary resources collection (the first collection found that accepts resources). To save the resource to the server to a collection, use the resource's save() method.

Specified by:

newResource in interface Blog

Parameters:

name - Name of resource to be saved.

contentType - MIME content type of resource data.

bytes - Bytes of resource data.

Returns:

Unsaved BlogEntry in primary resources collection.

Throws:

BlogClientException - On error or if there is no primary respurces collection.

saveResource

java.lang.String saveResource(BlogResource res)
                       throws BlogClientException

Deprecated.

Throws:

BlogClientException

deleteResource

void deleteResource(BlogResource resource)
             throws BlogClientException

Deprecated.

Throws:

BlogClientException

getCollections

public java.util.List<Blog.Collection> getCollections()
                                               throws BlogClientException

Deprecated.

Gets listing of entry and resource collections available in the blog, including the primary collections.

Specified by:

getCollections in interface Blog

Returns:

List of Blog.Collection objects.

Throws:

BlogClientException - On error fetching collections.

getCollection

public Blog.Collection getCollection(java.lang.String token)
                              throws BlogClientException

Deprecated.

Get collection by token.

Specified by:

getCollection in interface Blog

Parameters:

token - Token from a collection's getToken() method.

Returns:

Blog.Collection object.

Throws:

BlogClientException - On error fetching collection.

getService

ClientAtomService getService()

Deprecated.

setService

void setService(ClientAtomService service)

Deprecated.

getWorkspace

ClientWorkspace getWorkspace()

Deprecated.

setWorkspace

void setWorkspace(ClientWorkspace workspace)

Deprecated.