org.apache.shindig.gadgets.FeedProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of shindig-gadgets Show documentation

Renders gadgets, provides the gadget metadata service, and serves all javascript required by the OpenSocial specification.

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.shindig.gadgets;

import org.json.JSONObject;
import com.google.inject.ImplementedBy;

/**
 * Processes RSS & Atom Feeds and converts them into JSON output.
 */
@ImplementedBy(FeedProcessorImpl.class)
public interface FeedProcessor {

  /**
   * Converts feed XML to JSON.
   * 
   * @param feedUrl
   *            The url that the feed was retrieved from.
   * @param feedXml
   *            The raw XML of the feed to be converted.
   * @param getSummaries
   *            True if summaries should be returned.
   * @param numEntries
   *            Number of entries to return.
   * @return The JSON representation of the feed.
   */
  JSONObject process(String feedUrl, String feedXml, boolean getSummaries, int numEntries)
      throws GadgetException;
}