Class SyndicationService

java.lang.Object

org.deltava.service.WebService

org.deltava.service.rss.SyndicationService

Direct Known Subclasses:

CoolerSyndicationService, EventSyndicationService, NewsSyndicationService, NoticeSyndicationService

abstract class SyndicationService
extends WebService

An abstract Web Service to support RSS feed generation.

Since:

12.2

Version:

12.2

Author:

Luke

Constructor Summary

Constructors

Constructor	Description
SyndicationService()

Method Summary

Modifier and Type	Method	Description
protected static int	getCount(ServiceContext sctxt, int defaultValue)	Helper method to return the number of entries to display.
protected static Document	initRSS(String title, String desc, String url)	Creates the initial RSS document.

Methods inherited from class WebService

error, error, error, execute, isLogged, isSecure

Modifier and Type	Method	Description
protected static ServiceException	error(int code, String msg)	Creates a ServiceException.
protected static ServiceException	error(int code, String msg, boolean dumpStack)	Creates a ServiceException.
protected static ServiceException	error(int code, String msg, Throwable t)	Creates a ServiceException.
abstract int	execute(ServiceContext ctx)	Executes the Web Service.
boolean	isLogged()	Returns whether this web service calls are logged.
boolean	isSecure()	Returns whether this web service requires authentication.

Methods inherited from class Object

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

Constructor Details

SyndicationService

SyndicationService()

Method Details

getCount

protected static int getCount(ServiceContext sctxt,
 int defaultValue)

Helper method to return the number of entries to display.

Parameters:

sctxt - the Service Context

defaultValue - the default number of entries

Returns:

the value of the count parameter, or defaultVlue

initRSS

protected static Document initRSS(String title,
 String desc,
 String url)

Creates the initial RSS document.

Parameters:

title - the RSS feed title

desc - the RSS feed description

url - the RSS feed URL

Returns:

a Document with the RSS header