/*
 * ====================================================================
 * Copyright (c) 2005-2012 sventon project. All rights reserved.
 *
 * This software is licensed as described in the file LICENSE, which
 * you should have received as part of this distribution. The terms
 * are also available at http://www.sventon.org.
 * If newer versions of this license are posted there, you may use a
 * newer version instead, at your option.
 * ====================================================================
 */
package org.sventon.rss;

import org.sventon.appl.RepositoryConfiguration;
import org.sventon.model.LogEntry;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.List;

/**
 * Interface to be implemented by feed generators.
 *
 * @author jesper@sventon.org
 */
public interface RssFeedGenerator {

  /**
   * Outputs the generated feed to given writer.
   *
   * @param repositoryConfiguration Repository configuration.
   * @param logEntries              The log entries.
   * @param request                 Servlet request.
   * @param response                Servlet response.
   * @throws Exception if unable to output feed.
   */
  void outputFeed(final RepositoryConfiguration repositoryConfiguration,
                  final List<LogEntry> logEntries,
                  final HttpServletRequest request,
                  final HttpServletResponse response) throws Exception;
}