dekoh.portal.syndication
Interface ChannelProvider

public interface ChannelProvider

A ChannelProvider creates Channel.

Content applications to be deployed on Dekoh platform may register various ChannelProvider instances by calling method registerChannelProvider() on SyndicationService.

ChannelProvider determines the events the accessor is authorized to know about and creates the Data transfer object Channel.

Since:

Mar 1, 2007

See Also:

helper class that can be extended by implementations.

Nested Class Summary

static class

ChannelProvider.AccessLevel Describes if a channel provided by this provider is accessible to remote, local or all requests.

Method Summary

ChannelProvider.AccessLevel	getAccessLevel()
Channel	getChannel(HttpServletRequest request)
String	getComponentId()
ChannelErrorHandler	getErrorHandler()
long	getLastModified(HttpServletRequest request)
String	getProviderName()

Method Detail

getProviderName

String getProviderName()

Returns:

a pithy word that describes what kind of news this channel provides.

getComponentId

String getComponentId()

Returns:

value of ID element in component.xml of this implementation's application.

getChannel

Channel getChannel(HttpServletRequest request)

Parameters:

request -

Returns:

Channel for this request

getLastModified

long getLastModified(HttpServletRequest request)

Parameters:

request -

Returns:

last time when an event is generated for this Channel

getAccessLevel

ChannelProvider.AccessLevel getAccessLevel()

getErrorHandler

ChannelErrorHandler getErrorHandler()