org.sakaiproject.component.app.podcasts

Class PodcastServiceImpl

java.lang.Object

org.sakaiproject.component.app.podcasts.PodcastServiceImpl

All Implemented Interfaces:

org.sakaiproject.api.app.podcasts.PodcastService

public class PodcastServiceImpl
extends Object
implements org.sakaiproject.api.app.podcasts.PodcastService

Field Summary

Fields

Modifier and Type	Field and Description
protected String	m_relativeAccessPoint Needed for when Notification implemented *

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

COLLECTION_PODCASTS, COLLECTION_PODCASTS_ALT, COLLECTION_PODCASTS_DESCRIPTION, COLLECTION_PODCASTS_FEED, COLLECTION_PODCASTS_TITLE, DISPLAY_DATE, DISPLAY_TITLE, PODCASTS_SERVICE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	addPodcast(String title, Date displayDate, String description, byte[] body, String filename, String contentType) Add a podcast to the site's resources
boolean	allowAccess(String id) Determines if authenticated user has 'read' access to podcast collection folder
boolean	allowOptions(int option)
void	cancelContentCollection(org.sakaiproject.content.api.ContentCollectionEdit cce) Cancels attempt at changing this collection (releases the lock)
List	checkDISPLAY_DATE(List resourcesList) Checks if podcast resources have a DISPLAY_DATE set.
List	checkDISPLAY_DATE(List resourcesList, String siteId)
boolean	checkForActualPodcasts() Determines if folder contains actual files
boolean	checkPodcastFolder() Tests whether the podcasts folder exists and create it if it does not
void	commitContentCollection(org.sakaiproject.content.api.ContentCollectionEdit cce) Commits changes to ContentHosting (releases the lock)
void	destroy()
protected void	enablePodcastSecurityAdvisor() Establish a security advisor to allow the "embedded" azg work to occur with no need for additional security permissions.
List	filterPodcasts(List resourcesList) Returns only those podcasts whose DISPLAY_DATE property is today or earlier
List	filterPodcasts(List resourcesList, String siteId) Returns only those podcasts whose DISPLAY_DATE property is today or earlier This version for feed so can pass siteId
List	filterResources(List resourcesList) Remove non-file resources from list of potential podcasts and files restricted to groups user not part of
List	filterResources(List resourcesList, String siteId)
org.sakaiproject.content.api.ContentCollection	getContentCollection(String siteId) Get ContentCollection object for podcasts
org.sakaiproject.content.api.ContentCollectionEdit	getContentCollectionEditable(String siteId) Get ContentCollection object for podcasts
org.sakaiproject.time.api.Time	getDISPLAY_DATE(org.sakaiproject.entity.api.ResourceProperties rp) If Release Date property not set, check if DISPLAY_DATE exists and if it does, return it so it can be set as the Release Date.
Date	getGMTdate(long date) Returns the date set in GMT time
int	getOptions() Returns (from content hosting) whether the podcast folder is PUBLIC or SITE
String	getPodcastFileURL(String resourceId) Returns the file's URL
List	getPodcasts() Retrieve Podcasts for site and if podcast folder does not exist, create it.
List	getPodcasts(String siteId) Retrieve Podcasts for site and if podcast folder does not exist, create it.
String	getPodcastsFolderRef() Returns a reference to Podcasts folder in Resources to pass to permissions page.
String	getSiteId() Retrieve the site id
String	getSiteURL() Returns the site URL as a string
String	getUserId() Retrieve the current user id
String	getUserName() Retrieve the current user display name
void	init() FUTURE: needed to implement Notification services
boolean	isPodcastFolderHidden(String siteId) Returns TRUE if Podcasts folder has HIDDEN property set OR release date is in the future OR retract date is in the past 05/08 - enable security advisor since if folder is truly hidden and a student/access user attempts to access it will generate a Permissions error
boolean	isPublic(String podcastFolderId) Returns boolean TRUE = Display to non-members FALSE - Display to Site
void	removePodcast(String resourceId) Removes a podcast
String	retrievePodcastFolderId(String siteId) Returns podcast folder id using either 'podcasts' or 'Podcasts'.
void	reviseOptions(boolean option) Changes the podcast folder view status (either PUBLIC or SITE)
void	revisePodcast(String resourceId, String title, Date date, String description, byte[] body, String filename) Will apply changes made (if any) to podcast
void	setContentHostingService(org.sakaiproject.content.api.ContentHostingService chs) Injects ContentHostingService into this service
org.sakaiproject.content.api.ContentResource	setDISPLAY_DATE(String siteId, String resourceId, org.sakaiproject.time.api.Time releaseDate)
org.sakaiproject.content.api.ContentResource	setDISPLAY_DATE(String resourceId, org.sakaiproject.time.api.Time releaseDate) Sets the DISPLAY_DATE property to the creation date of the podcast.
void	setEventTrackingService(org.sakaiproject.event.api.EventTrackingService ets) Injects the EventTrackingService into this service
void	setPodcastPermissionsService(org.sakaiproject.api.app.podcasts.PodcastPermissionsService podcastPermissionsService) Injects PodcastAuthzService into this service
void	setSecurityService(org.sakaiproject.authz.api.SecurityService ss) Injects the SecurityService into this service
void	setSessionManager(org.sakaiproject.tool.api.SessionManager sm) Injects the SessionManager into this service
void	setSiteService(org.sakaiproject.site.api.SiteService ss) Injects the SiteService into this service
void	setTimeService(org.sakaiproject.time.api.TimeService ts) Injects the TimeService into this service
void	setToolManager(org.sakaiproject.tool.api.ToolManager tm) Injects ToolManager into this service
void	setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService uds) Injects the UserDirectoryService into this service

Methods inherited from class java.lang.Object

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

Field Detail

m_relativeAccessPoint

protected String m_relativeAccessPoint

Needed for when Notification implemented *

Method Detail

setContentHostingService

public void setContentHostingService(org.sakaiproject.content.api.ContentHostingService chs)

Injects ContentHostingService into this service

Specified by:

setContentHostingService in interface org.sakaiproject.api.app.podcasts.PodcastService

setToolManager

public void setToolManager(org.sakaiproject.tool.api.ToolManager tm)

Injects ToolManager into this service

Specified by:

setToolManager in interface org.sakaiproject.api.app.podcasts.PodcastService

setUserDirectoryService

public void setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService uds)

Injects the UserDirectoryService into this service

setSessionManager

public void setSessionManager(org.sakaiproject.tool.api.SessionManager sm)

Injects the SessionManager into this service

setTimeService

public void setTimeService(org.sakaiproject.time.api.TimeService ts)

Injects the TimeService into this service

setSecurityService

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

Injects the SecurityService into this service

setSiteService

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

Injects the SiteService into this service

setEventTrackingService

public void setEventTrackingService(org.sakaiproject.event.api.EventTrackingService ets)

Injects the EventTrackingService into this service

setPodcastPermissionsService

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

Injects PodcastAuthzService into this service

getSiteId

public String getSiteId()

Retrieve the site id

Specified by:

getSiteId in interface org.sakaiproject.api.app.podcasts.PodcastService

getUserId

public String getUserId()

Retrieve the current user id

Specified by:

getUserId in interface org.sakaiproject.api.app.podcasts.PodcastService

getUserName

public String getUserName()

Retrieve the current user display name

Specified by:

getUserName in interface org.sakaiproject.api.app.podcasts.PodcastService

getSiteURL

public String getSiteURL()

Returns the site URL as a string

Returns:

String containing the sites URL

filterPodcasts

public List filterPodcasts(List resourcesList)

Returns only those podcasts whose DISPLAY_DATE property is today or earlier

Specified by:

filterPodcasts in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

resourcesList - List of podcasts

Returns:

List List of podcasts whose DISPLAY_DATE is today or before

filterPodcasts

public List filterPodcasts(List resourcesList,
                  String siteId)

Returns only those podcasts whose DISPLAY_DATE property is today or earlier This version for feed so can pass siteId

Specified by:

filterPodcasts in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

resourcesList - List of podcasts

Returns:

List List of podcasts whose DISPLAY_DATE is today or before

getContentCollection

public org.sakaiproject.content.api.ContentCollection getContentCollection(String siteId)
                                                                    throws org.sakaiproject.exception.IdUnusedException,
                                                                           org.sakaiproject.exception.PermissionException

Get ContentCollection object for podcasts

Specified by:

getContentCollection in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

String - The siteId to grab the correct podcasts

Returns:

ContentCollection The ContentCollection object containing the podcasts

Throws:

org.sakaiproject.exception.IdUnusedException

org.sakaiproject.exception.PermissionException

getContentCollectionEditable

public org.sakaiproject.content.api.ContentCollectionEdit getContentCollectionEditable(String siteId)
                                                                                throws org.sakaiproject.exception.IdUnusedException,
                                                                                       org.sakaiproject.exception.PermissionException,
                                                                                       org.sakaiproject.exception.InUseException

Get ContentCollection object for podcasts

Specified by:

getContentCollectionEditable in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

String - The siteId to grab the correct podcasts

Returns:

ContentCollection The ContentCollection object containing the podcasts

Throws:

org.sakaiproject.exception.IdUnusedException

org.sakaiproject.exception.PermissionException

org.sakaiproject.exception.InUseException

getPodcastsFolderRef

public String getPodcastsFolderRef()

Returns a reference to Podcasts folder in Resources to pass to permissions page.

Specified by:

getPodcastsFolderRef in interface org.sakaiproject.api.app.podcasts.PodcastService

filterResources

public List filterResources(List resourcesList)

Remove non-file resources from list of potential podcasts and files restricted to groups user not part of

Parameters:

resourcesList - The list of potential podcasts

Returns:

List List of files to make up the podcasts

filterResources

public List filterResources(List resourcesList,
                   String siteId)

retrievePodcastFolderId

public String retrievePodcastFolderId(String siteId)
                               throws org.sakaiproject.exception.PermissionException

Returns podcast folder id using either 'podcasts' or 'Podcasts'. If it does not exist in either form, will create it.

Specified by:

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

Parameters:

siteId - The site to search

Returns:

String Contains the complete id for the podcast folder

Throws:

org.sakaiproject.exception.PermissionException - Access denied or Not found so not available

org.sakaiproject.exception.IdInvalidException - Constructed Id not valid

org.sakaiproject.exception.IdUsedException - When attempting to create Podcast folder, id is a duplicate

getPodcasts

public List getPodcasts()
                 throws org.sakaiproject.exception.PermissionException,
                        org.sakaiproject.exception.InUseException,
                        org.sakaiproject.exception.IdInvalidException,
                        org.sakaiproject.exception.InconsistentException,
                        org.sakaiproject.exception.IdUsedException

Retrieve Podcasts for site and if podcast folder does not exist, create it. Used within tool since siteId known

Specified by:

getPodcasts in interface org.sakaiproject.api.app.podcasts.PodcastService

Returns:

List A List of podcast resources

Throws:

org.sakaiproject.exception.PermissionException

org.sakaiproject.exception.InUseException

org.sakaiproject.exception.IdInvalidException

org.sakaiproject.exception.InconsistentException

org.sakaiproject.exception.IdUsedException

getPodcasts

public List getPodcasts(String siteId)
                 throws org.sakaiproject.exception.PermissionException,
                        org.sakaiproject.exception.InUseException,
                        org.sakaiproject.exception.IdInvalidException,
                        org.sakaiproject.exception.InconsistentException,
                        org.sakaiproject.exception.IdUsedException

Retrieve Podcasts for site and if podcast folder does not exist, create it. Used by feed since no context to pull siteId from

Specified by:

getPodcasts in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

String - The siteId the feed needs the podcasts from

Returns:

List A List of podcast resources

Throws:

org.sakaiproject.exception.PermissionException

org.sakaiproject.exception.InUseException

org.sakaiproject.exception.IdInvalidException

org.sakaiproject.exception.InconsistentException

org.sakaiproject.exception.IdUsedException

addPodcast

public void addPodcast(String title,
              Date displayDate,
              String description,
              byte[] body,
              String filename,
              String contentType)
                throws org.sakaiproject.exception.OverQuotaException,
                       org.sakaiproject.exception.ServerOverloadException,
                       org.sakaiproject.exception.InconsistentException,
                       org.sakaiproject.exception.IdInvalidException,
                       org.sakaiproject.exception.IdLengthException,
                       org.sakaiproject.exception.PermissionException,
                       org.sakaiproject.exception.IdUniquenessException

Add a podcast to the site's resources

Specified by:

addPodcast in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

title - The title of this podcast resource

displayDate - The display date for this podcast resource

description - The description of this podcast resource

body - The bytes of this podcast

Throws:

org.sakaiproject.exception.OverQuotaException - To display Over Quota Alert to user

org.sakaiproject.exception.ServerOverloadException - To display Internal Server Error Alert to user

org.sakaiproject.exception.InconsistentException - To display Internal Server Error Alert to user

org.sakaiproject.exception.IdInvalidException - To display Invalid Id Alert to user

org.sakaiproject.exception.IdLengthException - To display File path too long Alert to user

org.sakaiproject.exception.PermissionException - To display Permission denied Alert to user

org.sakaiproject.exception.IdUniquenessException - To display Duplicate id used Alert to user

removePodcast

public void removePodcast(String resourceId)
                   throws org.sakaiproject.exception.IdUnusedException,
                          org.sakaiproject.exception.InUseException,
                          org.sakaiproject.exception.TypeException,
                          org.sakaiproject.exception.PermissionException

Removes a podcast

Specified by:

removePodcast in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

id - The podcast to be removed from ContentHosting

Throws:

org.sakaiproject.exception.IdUnusedException

org.sakaiproject.exception.InUseException

org.sakaiproject.exception.TypeException

org.sakaiproject.exception.PermissionException

checkPodcastFolder

public boolean checkPodcastFolder()
                           throws org.sakaiproject.exception.PermissionException,
                                  org.sakaiproject.exception.InUseException

Tests whether the podcasts folder exists and create it if it does not

Specified by:

checkPodcastFolder in interface org.sakaiproject.api.app.podcasts.PodcastService

Returns:

True - if exists, false - otherwise

Throws:

org.sakaiproject.exception.PermissionException

org.sakaiproject.exception.InUseException

checkForActualPodcasts

public boolean checkForActualPodcasts()

Determines if folder contains actual files

Specified by:

checkForActualPodcasts in interface org.sakaiproject.api.app.podcasts.PodcastService

Returns:

boolean true if files are stored there, false otherwise

revisePodcast

public void revisePodcast(String resourceId,
                 String title,
                 Date date,
                 String description,
                 byte[] body,
                 String filename)
                   throws org.sakaiproject.exception.PermissionException,
                          org.sakaiproject.exception.InUseException,
                          org.sakaiproject.exception.OverQuotaException,
                          org.sakaiproject.exception.ServerOverloadException

Will apply changes made (if any) to podcast

Specified by:

revisePodcast in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

String - The resourceId

String - The title

Date - The display/publish date

String - The description

byte[] - The actual file contents

String - The filename

Throws:

org.sakaiproject.exception.PermissionException

org.sakaiproject.exception.InUseException

org.sakaiproject.exception.OverQuotaException

org.sakaiproject.exception.ServerOverloadException

checkDISPLAY_DATE

public List checkDISPLAY_DATE(List resourcesList)

Checks if podcast resources have a DISPLAY_DATE set. Occurs when files uploaded to podcast folder from Resources.

Specified by:

checkDISPLAY_DATE in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

List - The list of podcast resources

Returns:

List The list of podcast resource all with DISPLAY_DATE property

checkDISPLAY_DATE

public List checkDISPLAY_DATE(List resourcesList,
                     String siteId)

setDISPLAY_DATE

public org.sakaiproject.content.api.ContentResource setDISPLAY_DATE(String resourceId,
                                                           org.sakaiproject.time.api.Time releaseDate)

Sets the DISPLAY_DATE property to the creation date of the podcast. Needed if file added using Resources. Time stored is GMT so when pulled need to convert to local.

Parameters:

ResourceProperties - The ResourceProperties that need DISPLAY_DATE added

setDISPLAY_DATE

public org.sakaiproject.content.api.ContentResource setDISPLAY_DATE(String siteId,
                                                           String resourceId,
                                                           org.sakaiproject.time.api.Time releaseDate)

getDISPLAY_DATE

public org.sakaiproject.time.api.Time getDISPLAY_DATE(org.sakaiproject.entity.api.ResourceProperties rp)

If Release Date property not set, check if DISPLAY_DATE exists and if it does, return it so it can be set as the Release Date. If DISPLAY_DATE does not exist, default to last modified date.

Parameters:

ResourceProperties - The ResourceProperties to get DISPLAY_DATE from

getPodcastFileURL

public String getPodcastFileURL(String resourceId)
                         throws org.sakaiproject.exception.PermissionException,
                                org.sakaiproject.exception.IdUnusedException

Returns the file's URL

Specified by:

getPodcastFileURL in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

String - The resource Id

Returns:

String The URL for the resource

Throws:

org.sakaiproject.exception.PermissionException

org.sakaiproject.exception.IdUnusedException

init

public void init()

FUTURE: needed to implement Notification services

destroy

public void destroy()

reviseOptions

public void reviseOptions(boolean option)

Changes the podcast folder view status (either PUBLIC or SITE)

Specified by:

reviseOptions in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

boolean - True means PUBLIC view, FALSE means private

getOptions

public int getOptions()

Returns (from content hosting) whether the podcast folder is PUBLIC or SITE

Specified by:

getOptions in interface org.sakaiproject.api.app.podcasts.PodcastService

Returns:

int 0 = Display to non-members, 1 = Display to Site

commitContentCollection

public void commitContentCollection(org.sakaiproject.content.api.ContentCollectionEdit cce)

Commits changes to ContentHosting (releases the lock)

Specified by:

commitContentCollection in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

ContentCollectionEdit - The ContentCollection to be saved

cancelContentCollection

public void cancelContentCollection(org.sakaiproject.content.api.ContentCollectionEdit cce)

Cancels attempt at changing this collection (releases the lock)

Specified by:

cancelContentCollection in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

cce - The ContentCollectionEdit that is not to be changed

isPublic

public boolean isPublic(String podcastFolderId)

Returns boolean TRUE = Display to non-members FALSE - Display to Site

Specified by:

isPublic in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

podcastFolderId - The podcast folder id to check

Returns:

boolean TRUE - Display to non-members, FALSE - Display to Site

isPodcastFolderHidden

public boolean isPodcastFolderHidden(String siteId)
                              throws org.sakaiproject.exception.IdUnusedException,
                                     org.sakaiproject.exception.PermissionException

Returns TRUE if Podcasts folder has HIDDEN property set OR release date is in the future OR retract date is in the past 05/08 - enable security advisor since if folder is truly hidden and a student/access user attempts to access it will generate a Permissions error

Specified by:

isPodcastFolderHidden in interface org.sakaiproject.api.app.podcasts.PodcastService

Throws:

org.sakaiproject.exception.IdUnusedException

org.sakaiproject.exception.PermissionException

getGMTdate

public Date getGMTdate(long date)

Returns the date set in GMT time

Specified by:

getGMTdate in interface org.sakaiproject.api.app.podcasts.PodcastService

Parameters:

date - The date represented as a long value

Returns:

Date The Date object set in GMT time

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.PodcastService

Parameters:

id - The id for the podcast collection folder

Returns:

TRUE - has read access, FALSE - does not

enablePodcastSecurityAdvisor

protected void enablePodcastSecurityAdvisor()

Establish a security advisor to allow the "embedded" azg work to occur with no need for additional security permissions. Kept here since don't want to make public.

allowOptions

public boolean allowOptions(int option)

Specified by:

allowOptions in interface org.sakaiproject.api.app.podcasts.PodcastService