org.xwiki.rendering.internal.macro.rss.DefaultRomeFeedFactory.java Source code

Introduction

Here is the source code for org.xwiki.rendering.internal.macro.rss.DefaultRomeFeedFactory.java

Source

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.rendering.internal.macro.rss;

import java.net.SocketTimeoutException;
import java.net.URLConnection;
import java.text.MessageFormat;

import org.xwiki.rendering.macro.MacroExecutionException;
import org.xwiki.rendering.macro.rss.RssMacroParameters;
import org.apache.commons.lang3.StringUtils;

import com.sun.syndication.feed.synd.SyndFeed;
import com.sun.syndication.io.SyndFeedInput;
import com.sun.syndication.io.XmlReader;

/**
 * Factory implementation using Rome to return the feed's data.
 * 
 * @version $Id: 9ddd162dfd4526a970846bff81f6de173f20d1c0 $
 * @since 1.9
 */
public class DefaultRomeFeedFactory implements RomeFeedFactory {
    /**
     * The maximum number of milliseconds to wait when inquiring the RSS feed provider.
     */
    private static final int TIMEOUT_MILLISECONDS = 5000;

    /**
     * {@inheritDoc}
     * @see RomeFeedFactory#createFeed(org.xwiki.rendering.macro.rss.RssMacroParameters)
     */
    public SyndFeed createFeed(RssMacroParameters parameters) throws MacroExecutionException {
        if (StringUtils.isEmpty(parameters.getFeed())) {
            throw new MacroExecutionException("The required 'feed' parameter is missing");
        }

        SyndFeedInput syndFeedInput = new SyndFeedInput();

        SyndFeed feed;
        try {
            URLConnection connection = parameters.getFeedURL().openConnection();
            connection.setConnectTimeout(TIMEOUT_MILLISECONDS);
            feed = syndFeedInput.build(new XmlReader(connection));
        } catch (SocketTimeoutException ex) {
            throw new MacroExecutionException(
                    MessageFormat.format("Connection timeout when trying to reach [{0}]", parameters.getFeedURL()));
        } catch (Exception ex) {
            throw new MacroExecutionException(
                    MessageFormat.format("Error processing [{0}] : {1}", parameters.getFeedURL(), ex.getMessage()),
                    ex);
        }
        if (feed == null) {
            throw new MacroExecutionException(
                    MessageFormat.format("No feed found at [{0}]", parameters.getFeedURL()));
        }

        return feed;
    }
}