org.sakaiproject.component.app.podcasts

Class BasicPodfeedService

java.lang.Object

org.sakaiproject.component.app.podcasts.BasicPodfeedService

All Implemented Interfaces:

org.sakaiproject.api.app.podcasts.PodfeedService

public class BasicPodfeedService
extends Object
implements org.sakaiproject.api.app.podcasts.PodfeedService

Field Summary

Fields inherited from interface org.sakaiproject.api.app.podcasts.PodfeedService

PODFEED_CATEGORY

Constructor Summary

Constructors

Constructor and Description
BasicPodfeedService()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowAccess(String id) Determines if authenticated user has 'read' access to podcast collection folder
protected void	enablePodfeedSecurityAdvisor() Establish a security advisor to allow the "embedded" azg work to occur with no need for additional security permissions.
String	generatePodcastRSS() This method generates the RSS feed
String	generatePodcastRSS(String siteId, String ftype) This method generates the RSS feed
String	getPodfeedCopyright()
String	getPodfeedCopyright(String siteId) Returns the global feed generator string.
String	getPodfeedDescription() Returns the String of the global feed description
String	getPodfeedDescription(String siteId) Returns the global feed description.
String	getPodfeedGenerator()
String	getPodfeedGenerator(String siteId) Returns the global feed generator string.
String	getPodfeedTitle() Returns the podfeed global title from content hosting via the podcastService
String	getPodfeedTitle(String siteId) Gets the title for the feed from podcast folder's properties.
void	init()
String	retrievePodcastFolderId(String siteId) Returns podcast folder id using either 'podcasts' or 'Podcasts'.
void	setPodcastPermissionsService(org.sakaiproject.api.app.podcasts.PodcastPermissionsService podcastPermissionsService)
void	setPodcastService(org.sakaiproject.api.app.podcasts.PodcastService podcastService)
void	setPodfeedCopyright(String feedCopyright) Sets feed copyright statement from within site.
void	setPodfeedCopyright(String feedCopyright, String siteId) Sets the description for the feed.
void	setPodfeedDescription(String feedDescription) Returns the global feed generator String.
void	setPodfeedDescription(String feedDescription, String siteId) Sets the description for the feed.
void	setPodfeedGenerator(String feedGenerator)
void	setPodfeedGenerator(String feedGenerator, String siteId) Sets the description for the feed.
void	setPodfeedTitle(String feedTitle) Stores the title for the feed in the podcast folder's resources
void	setPodfeedTitle(String feedTitle, String siteId) Stores the title for the feed in the podcast folder's resources.
void	setSecurityService(org.sakaiproject.authz.api.SecurityService securityService)
void	setSiteService(org.sakaiproject.site.api.SiteService siteService)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicPodfeedService

public BasicPodfeedService()

Method Detail

setSecurityService

public void setSecurityService(org.sakaiproject.authz.api.SecurityService securityService)

Parameters:

securityService - The securityService to set.

setPodcastService

public void setPodcastService(org.sakaiproject.api.app.podcasts.PodcastService podcastService)

Parameters:

podcastService - The podcastService to set.

setSiteService

public void setSiteService(org.sakaiproject.site.api.SiteService siteService)

Parameters:

siteService - The siteService to set.

setPodcastPermissionsService

public void setPodcastPermissionsService(org.sakaiproject.api.app.podcasts.PodcastPermissionsService podcastPermissionsService)

init

public void init()

getPodfeedTitle

public String getPodfeedTitle()

Returns the podfeed global title from content hosting via the podcastService

Specified by:

getPodfeedTitle in interface org.sakaiproject.api.app.podcasts.PodfeedService

Returns:

String The global podfeed title

getPodfeedTitle

public String getPodfeedTitle(String siteId)

Gets the title for the feed from podcast folder's properties.

Specified by:

getPodfeedTitle in interface org.sakaiproject.api.app.podcasts.PodfeedService

Parameters:

siteId - The site id

Returns:

String The global podfeed title

setPodfeedTitle

public void setPodfeedTitle(String feedTitle)

Stores the title for the feed in the podcast folder's resources

Specified by:

setPodfeedTitle in interface org.sakaiproject.api.app.podcasts.PodfeedService

Parameters:

String - The title for the feed

setPodfeedTitle

public void setPodfeedTitle(String feedTitle,
                   String siteId)

Stores the title for the feed in the podcast folder's resources. Used by the actual feed so need to pass in the siteId also.

Parameters:

feedTitle - The title for the feed

siteId - The siteId whose feed is being titled

getPodfeedDescription

public String getPodfeedDescription()

Returns the String of the global feed description

Specified by:

getPodfeedDescription in interface org.sakaiproject.api.app.podcasts.PodfeedService

getPodfeedDescription

public String getPodfeedDescription(String siteId)

Returns the global feed description.

Specified by:

getPodfeedDescription in interface org.sakaiproject.api.app.podcasts.PodfeedService

Parameters:

siteId - The site id to get the feed description from

Returns:

String The global feed description

setPodfeedDescription

public void setPodfeedDescription(String feedDescription)

Returns the global feed generator String.

Specified by:

setPodfeedDescription in interface org.sakaiproject.api.app.podcasts.PodfeedService

setPodfeedDescription

public void setPodfeedDescription(String feedDescription,
                         String siteId)

Sets the description for the feed.

Parameters:

feedDescription - The String containing the feed description.

siteId - The siteId where to store the description

getPodfeedGenerator

public String getPodfeedGenerator()

Specified by:

getPodfeedGenerator in interface org.sakaiproject.api.app.podcasts.PodfeedService

getPodfeedGenerator

public String getPodfeedGenerator(String siteId)

Returns the global feed generator string.

Specified by:

getPodfeedGenerator in interface org.sakaiproject.api.app.podcasts.PodfeedService

Parameters:

siteId - The site id to get the feed description from

Returns:

String The global feed generator string.

setPodfeedGenerator

public void setPodfeedGenerator(String feedGenerator)

Specified by:

setPodfeedGenerator in interface org.sakaiproject.api.app.podcasts.PodfeedService

setPodfeedGenerator

public void setPodfeedGenerator(String feedGenerator,
                       String siteId)

Sets the description for the feed.

Parameters:

feedDescription - The String containing the feed description.

siteId - The siteId where to store the description

getPodfeedCopyright

public String getPodfeedCopyright()

Specified by:

getPodfeedCopyright in interface org.sakaiproject.api.app.podcasts.PodfeedService

getPodfeedCopyright

public String getPodfeedCopyright(String siteId)

Returns the global feed generator string.

Specified by:

getPodfeedCopyright in interface org.sakaiproject.api.app.podcasts.PodfeedService

Parameters:

siteId - The site id to get the feed description from

Returns:

String The global feed generator string.

setPodfeedCopyright

public void setPodfeedCopyright(String feedCopyright)

Sets feed copyright statement from within site.

Specified by:

setPodfeedCopyright in interface org.sakaiproject.api.app.podcasts.PodfeedService

setPodfeedCopyright

public void setPodfeedCopyright(String feedCopyright,
                       String siteId)

Sets the description for the feed.

Parameters:

feedDescription - The String containing the feed description.

siteId - The siteId where to store the description

generatePodcastRSS

public String generatePodcastRSS()

This method generates the RSS feed

Specified by:

generatePodcastRSS in interface org.sakaiproject.api.app.podcasts.PodfeedService

Returns:

String The feed XML file as a string

generatePodcastRSS

public String generatePodcastRSS(String siteId,
                        String ftype)

This method generates the RSS feed

Specified by:

generatePodcastRSS in interface org.sakaiproject.api.app.podcasts.PodfeedService

Parameters:

siteID - The site id whose feed needs to be generated

ftyle - The feed type (for potential future development) - currently rss 2.0

Returns:

String The feed document as a String

enablePodfeedSecurityAdvisor

protected void enablePodfeedSecurityAdvisor()

Establish a security advisor to allow the "embedded" azg work to occur with no need for additional security permissions.

retrievePodcastFolderId

public String retrievePodcastFolderId(String siteId)

Returns podcast folder id using either 'podcasts' or 'Podcasts'. If it cannot find or is denied access, it will return null.

Specified by:

retrievePodcastFolderId in interface org.sakaiproject.api.app.podcasts.PodfeedService

Parameters:

siteId - The site to search

Returns:

String Contains the complete id for the podcast folder

allowAccess

public boolean allowAccess(String id)

Determines if authenticated user has 'read' access to podcast collection folder

Specified by:

allowAccess in interface org.sakaiproject.api.app.podcasts.PodfeedService

Parameters:

id - The id for the podcast collection folder

Returns:

TRUE - has read access, FALSE - does not