• Home
• com.rometools
• rome-propono
• 1.7.3
• source code
• ClientEntry.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.rometools.propono.atom.client.ClientEntry Maven / Gradle / Ivy

/*
 * Copyright 2007 Sun Microsystems, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.rometools.propono.atom.client;

import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Locale;

import org.apache.commons.beanutils.BeanUtils;
import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpMethodBase;
import org.apache.commons.httpclient.methods.DeleteMethod;
import org.apache.commons.httpclient.methods.EntityEnclosingMethod;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.PutMethod;
import org.apache.commons.httpclient.methods.StringRequestEntity;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.rometools.propono.utils.ProponoException;
import com.rometools.propono.utils.Utilities;
import com.rometools.rome.feed.atom.Content;
import com.rometools.rome.feed.atom.Entry;
import com.rometools.rome.feed.atom.Link;
import com.rometools.rome.io.impl.Atom10Generator;
import com.rometools.rome.io.impl.Atom10Parser;

/**
 * Client implementation of Atom entry, extends ROME Entry to add methods for easily getting/setting
 * content, updating and removing the entry from the server.
 *
 * @deprecated Propono will be removed in Rome 2.
 */
@Deprecated
public class ClientEntry extends Entry {

    private static final long serialVersionUID = 1L;

    private static final Logger LOG = LoggerFactory.getLogger(ClientEntry.class);

    private ClientAtomService service = null;
    private ClientCollection collection = null;
    protected boolean partial = false;

    public ClientEntry(final ClientAtomService service, final ClientCollection collection) {
        this.service = service;
        this.collection = collection;
    }

    public ClientEntry(final ClientAtomService service, final ClientCollection collection, final Entry entry, final boolean partial) throws ProponoException {
        this.service = service;
        this.collection = collection;
        this.partial = partial;
        try {
            BeanUtils.copyProperties(this, entry);
        } catch (final Exception e) {
            throw new ProponoException("ERROR: copying fields from ROME entry", e);
        }
    }

    /**
     * Set content of entry.
     *
     * @param contentString content string.
     * @param type Must be "text" for plain text, "html" for escaped HTML, "xhtml" for XHTML or a
     *            valid MIME content-type.
     */
    public void setContent(final String contentString, final String type) {
        final Content newContent = new Content();
        newContent.setType(type == null ? Content.HTML : type);
        newContent.setValue(contentString);
        final ArrayList contents = new ArrayList();
        contents.add(newContent);
        setContents(contents);
    }

    /**
     * Convenience method to set first content object in content collection. Atom 1.0 allows only
     * one content element per entry.
     */
    public void setContent(final Content c) {
        final ArrayList contents = new ArrayList();
        contents.add(c);
        setContents(contents);
    }

    /**
     * Convenience method to get first content object in content collection. Atom 1.0 allows only
     * one content element per entry.
     */
    public Content getContent() {
        if (getContents() != null && !getContents().isEmpty()) {
            final Content c = getContents().get(0);
            return c;
        }
        return null;
    }

    /**
     * Determines if entries are equal based on edit URI.
     */
    @Override
    public boolean equals(final Object o) {
        if (o instanceof ClientEntry) {
            final ClientEntry other = (ClientEntry) o;
            if (other.getEditURI() != null && getEditURI() != null) {
                return other.getEditURI().equals(getEditURI());
            }
        }
        return false;
    }

    /**
     * Update entry by posting new representation of entry to server. Note that you should not
     * attempt to update entries that you get from iterating over a collection they may be "partial"
     * entries. If you want to update an entry, you must get it via one of the
     * getEntry() methods in {@link com.rometools.rome.propono.atom.common.Collection}
     * or {@link com.rometools.rome.propono.atom.common.AtomService}.
     *
     * @throws ProponoException If entry is a "partial" entry.
     */
    public void update() throws ProponoException {
        if (partial) {
            throw new ProponoException("ERROR: attempt to update partial entry");
        }
        final EntityEnclosingMethod method = new PutMethod(getEditURI());
        addAuthentication(method);
        final StringWriter sw = new StringWriter();
        final int code = -1;
        try {
            Atom10Generator.serializeEntry(this, sw);
            method.setRequestEntity(new StringRequestEntity(sw.toString(), null, null));
            method.setRequestHeader("Content-type", "application/atom+xml; charset=utf-8");
            getHttpClient().executeMethod(method);
            final InputStream is = method.getResponseBodyAsStream();
            if (method.getStatusCode() != 200 && method.getStatusCode() != 201) {
                throw new ProponoException("ERROR HTTP status=" + method.getStatusCode() + " : " + Utilities.streamToString(is));
            }

        } catch (final Exception e) {
            final String msg = "ERROR: updating entry, HTTP code: " + code;
            LOG.debug(msg, e);
            throw new ProponoException(msg, e);
        } finally {
            method.releaseConnection();
        }
    }

    /**
     * Remove entry from server.
     */
    public void remove() throws ProponoException {
        if (getEditURI() == null) {
            throw new ProponoException("ERROR: cannot delete unsaved entry");
        }
        final DeleteMethod method = new DeleteMethod(getEditURI());
        addAuthentication(method);
        try {
            getHttpClient().executeMethod(method);
        } catch (final IOException ex) {
            throw new ProponoException("ERROR: removing entry, HTTP code", ex);
        } finally {
            method.releaseConnection();
        }
    }

    void setCollection(final ClientCollection collection) {
        this.collection = collection;
    }

    ClientCollection getCollection() {
        return collection;
    }

    /**
     * Get the URI that can be used to edit the entry via HTTP PUT or DELETE.
     */
    public String getEditURI() {
        for (int i = 0; i < getOtherLinks().size(); i++) {
            final Link link = getOtherLinks().get(i);
            if (link.getRel() != null && link.getRel().equals("edit")) {
                return link.getHrefResolved();
            }
        }
        return null;
    }

    void addToCollection(final ClientCollection col) throws ProponoException {
        setCollection(col);
        final EntityEnclosingMethod method = new PostMethod(getCollection().getHrefResolved());
        addAuthentication(method);
        final StringWriter sw = new StringWriter();
        int code = -1;
        try {
            Atom10Generator.serializeEntry(this, sw);
            method.setRequestEntity(new StringRequestEntity(sw.toString(), null, null));
            method.setRequestHeader("Content-type", "application/atom+xml; charset=utf-8");
            getHttpClient().executeMethod(method);
            final InputStream is = method.getResponseBodyAsStream();
            code = method.getStatusCode();
            if (code != 200 && code != 201) {
                throw new ProponoException("ERROR HTTP status=" + code + " : " + Utilities.streamToString(is));
            }
            final Entry romeEntry = Atom10Parser.parseEntry(new InputStreamReader(is), getCollection().getHrefResolved(), Locale.US);
            BeanUtils.copyProperties(this, romeEntry);

        } catch (final Exception e) {
            final String msg = "ERROR: saving entry, HTTP code: " + code;
            LOG.debug(msg, e);
            throw new ProponoException(msg, e);
        } finally {
            method.releaseConnection();
        }
        final Header locationHeader = method.getResponseHeader("Location");
        if (locationHeader == null) {
            LOG.warn("WARNING added entry, but no location header returned");
        } else if (getEditURI() == null) {
            final List links = getOtherLinks();
            final Link link = new Link();
            link.setHref(locationHeader.getValue());
            link.setRel("edit");
            links.add(link);
            setOtherLinks(links);
        }
    }

    void addAuthentication(final HttpMethodBase method) throws ProponoException {
        if (service != null) {
            service.addAuthentication(method);
        } else if (collection != null) {
            collection.addAuthentication(method);
        }
    }

    HttpClient getHttpClient() {
        if (service != null) {
            return service.getHttpClient();
        } else if (collection != null) {
            return collection.getHttpClient();
        }
        return null;
    }

    @Override
    public void setCreated(final Date d) {
        // protected against null created property (an old Atom 0.3 property)
        if (d != null) {
            super.setCreated(d);
        }
    }
}