com.rometools.propono.atom.client

Class ClientCollection

java.lang.Object

com.rometools.propono.atom.common.Collection

com.rometools.propono.atom.client.ClientCollection

Deprecated.

Propono will be removed in Rome 2.

@Deprecated
public class ClientCollection
extends Collection

Models an Atom collection, extends Collection and adds methods for adding, retrieving, updateing and deleting entries.

Field Summary

Fields

Modifier and Type	Field and Description
private AuthStrategy	authStrategy Deprecated.
private org.apache.commons.httpclient.HttpClient	httpClient Deprecated.
private ClientAtomService	service Deprecated.
private ClientWorkspace	workspace Deprecated.
private boolean	writable Deprecated.

Fields inherited from class com.rometools.propono.atom.common.Collection

ENTRY_TYPE

Constructor Summary

Constructors

Constructor and Description
ClientCollection(org.jdom2.Element e, ClientWorkspace workspace, java.lang.String baseURI) Deprecated.
ClientCollection(java.lang.String href, AuthStrategy authStrategy) Deprecated.

Method Summary

Modifier and Type	Method and Description
(package private) void	addAuthentication(org.apache.commons.httpclient.HttpMethodBase method) Deprecated.
void	addEntry(ClientEntry entry) Deprecated. Save to collection a new entry that was created by a createEntry() or createMediaEntry() and save it to the server.
ClientEntry	createEntry() Deprecated. Create new entry associated with collection, but do not save to server.
ClientMediaEntry	createMediaEntry(java.lang.String title, java.lang.String slug, java.lang.String contentType, byte[] bytes) Deprecated. Create new media entry assocaited with collection, but do not save.
ClientMediaEntry	createMediaEntry(java.lang.String title, java.lang.String slug, java.lang.String contentType, java.io.InputStream is) Deprecated. Create new media entry assocaited with collection, but do not save.
java.util.Iterator<ClientEntry>	getEntries() Deprecated. Get iterator over entries in this collection.
ClientEntry	getEntry(java.lang.String uri) Deprecated. Get full entry specified by entry edit URI.
(package private) org.apache.commons.httpclient.HttpClient	getHttpClient() Deprecated. Package access to httpClient to allow use by ClientEntry and ClientMediaEntry.
Workspace	getWorkspace() Deprecated. Get workspace or null if collection is not associated with a workspace.
boolean	isWritable() Deprecated. Determines if collection is writable.
protected void	parseCollectionElement(org.jdom2.Element element) Deprecated.

Methods inherited from class com.rometools.propono.atom.common.Collection

accepts, addAccept, addCategories, collectionToElement, elementToCollection, getAccepts, getCategories, getHref, getHrefResolved, getHrefResolved, getTitle, getTitleType, setAccepts, setHref, setTitle, setTitleType

Methods inherited from class java.lang.Object

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

Field Detail

writable

private final boolean writable

Deprecated.

See Also:

Constant Field Values

httpClient

private org.apache.commons.httpclient.HttpClient httpClient

Deprecated.

authStrategy

private AuthStrategy authStrategy

Deprecated.

workspace

private ClientWorkspace workspace

Deprecated.

service

private ClientAtomService service

Deprecated.

Constructor Detail

ClientCollection

ClientCollection(org.jdom2.Element e,
                 ClientWorkspace workspace,
                 java.lang.String baseURI)
          throws ProponoException

Deprecated.

Throws:

ProponoException

ClientCollection

ClientCollection(java.lang.String href,
                 AuthStrategy authStrategy)
          throws ProponoException

Deprecated.

Throws:

ProponoException

Method Detail

addAuthentication

void addAuthentication(org.apache.commons.httpclient.HttpMethodBase method)
                throws ProponoException

Deprecated.

Throws:

ProponoException

getHttpClient

org.apache.commons.httpclient.HttpClient getHttpClient()

Deprecated.

Package access to httpClient to allow use by ClientEntry and ClientMediaEntry.

getEntries

public java.util.Iterator<ClientEntry> getEntries()
                                           throws ProponoException

Deprecated.

Get iterator over entries in this collection. Entries returned are considered to be partial entries cannot be saved/updated.

Throws:

ProponoException

getEntry

public ClientEntry getEntry(java.lang.String uri)
                     throws ProponoException

Deprecated.

Get full entry specified by entry edit URI. Note that entry may or may not be associated with this collection.

Returns:

ClientEntry or ClientMediaEntry specified by URI.

Throws:

ProponoException

getWorkspace

public Workspace getWorkspace()

Deprecated.

Get workspace or null if collection is not associated with a workspace.

isWritable

public boolean isWritable()

Deprecated.

Determines if collection is writable.

createEntry

public ClientEntry createEntry()
                        throws ProponoException

Deprecated.

Create new entry associated with collection, but do not save to server.

Throws:

ProponoException - if collecton is not writable.

createMediaEntry

public ClientMediaEntry createMediaEntry(java.lang.String title,
                                         java.lang.String slug,
                                         java.lang.String contentType,
                                         byte[] bytes)
                                  throws ProponoException

Deprecated.

Create new media entry assocaited with collection, but do not save. server. Depending on the Atom server, you may or may not be able to persist the properties of the entry that is returned.

Parameters:

title - Title to used for uploaded file.

slug - String to be used in file-name of stored file

contentType - MIME content-type of file.

bytes - Data to be uploaded as byte array.

Throws:

ProponoException - if collecton is not writable

createMediaEntry

public ClientMediaEntry createMediaEntry(java.lang.String title,
                                         java.lang.String slug,
                                         java.lang.String contentType,
                                         java.io.InputStream is)
                                  throws ProponoException

Deprecated.

Create new media entry assocaited with collection, but do not save. server. Depending on the Atom server, you may or may not be able to. persist the properties of the entry that is returned.

Parameters:

title - Title to used for uploaded file.

slug - String to be used in file-name of stored file

contentType - MIME content-type of file.

is - Data to be uploaded as InputStream.

Throws:

ProponoException - if collecton is not writable

addEntry

public void addEntry(ClientEntry entry)
              throws ProponoException

Deprecated.

Save to collection a new entry that was created by a createEntry() or createMediaEntry() and save it to the server.

Parameters:

entry - Entry to be saved.

Throws:

ProponoException - on error, if collection is not writable or if entry is partial.

parseCollectionElement

protected void parseCollectionElement(org.jdom2.Element element)
                               throws ProponoException

Deprecated.

Overrides:

parseCollectionElement in class Collection

Throws:

ProponoException