org.sakaiproject.announcement.entityprovider

Class AnnouncementEntityProviderImpl

java.lang.Object

org.sakaiproject.entitybroker.util.AbstractEntityProvider

org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl

All Implemented Interfaces:

org.sakaiproject.entitybroker.collector.AutoRegister, org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable, org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable, org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable, org.sakaiproject.entitybroker.entityprovider.EntityProvider, org.sakaiproject.entitybroker.entityprovider.extension.Formats, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public class AnnouncementEntityProviderImpl
extends org.sakaiproject.entitybroker.util.AbstractEntityProvider
implements org.sakaiproject.entitybroker.entityprovider.EntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable, org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable, org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable

Allows some basic functions on announcements. Due to limitations of EntityBroker the internal URLs of the announcements service can't be exposed directly, so we have to map them, with assumptions about characters used in IDs. Basically we pack together the {siteId}:{channelId}:{announcementId} into the ID.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AnnouncementEntityProviderImpl.DecoratedAnnouncement Class to hold only the fields that we want to return
class	AnnouncementEntityProviderImpl.DecoratedAttachment Model class for an attachment

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DAYS_IN_PAST
static int	DEFAULT_NUM_ANNOUNCEMENTS
static String	ENTITY_PREFIX

Fields inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

developerHelperService

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable

ACTION_METHOD_SUFFIX

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.extension.Formats

ALL_KNOWN_FORMATS, ATOM, ATOM_EXTENSIONS, ATOM_MIME_TYPE, FORM, FORM_EXTENSIONS, FORM_MIME_TYPE, HTML, HTML_EXTENSIONS, HTML_MIME_TYPE, JSON, JSON_EXTENSIONS, JSON_MIME_TYPE, JSONP, JSONP_EXTENSIONS, JSONP_MIME_TYPE, RSS, RSS_EXTENSIONS, RSS_MIME_TYPE, TXT, TXT_EXTENSIONS, TXT_MIME_TYPE, UTF_8, XML, XML_EXTENSIONS, XML_MIME_TYPE

Constructor Summary

Constructors

Constructor and Description
AnnouncementEntityProviderImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAnnouncementByID(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params) message/siteId/EntityID
List<?>	getAnnouncementsForSite(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params) site/siteId
List<?>	getAnnouncementsForUser(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params) user
Object	getEntity(org.sakaiproject.entitybroker.EntityReference ref)
String	getEntityPrefix() Prefix for this provider
String[]	getHandledOutputFormats()
List<?>	getMessagesOfTheDay(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params) motd
Object	getSampleEntity()
AnnouncementEntityProviderImpl.DecoratedAnnouncement	showAnnouncement(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params) This handles announcements, URLs should be like, /announcement/msg/{context}/{channelId}/{announcementId} an example would be /announcement/msg/21b1984d-af58-43da-8583-f4adee769aa2/main/5641323b-761a-4a4d-8761-688f4928141b .

Methods inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

afterPropertiesSet, destroy, setDeveloperHelperService, setEntityProviderManager

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_PREFIX

public static final String ENTITY_PREFIX

See Also:

Constant Field Values

DEFAULT_NUM_ANNOUNCEMENTS

public static int DEFAULT_NUM_ANNOUNCEMENTS

DEFAULT_DAYS_IN_PAST

public static int DEFAULT_DAYS_IN_PAST

Constructor Detail

AnnouncementEntityProviderImpl

public AnnouncementEntityProviderImpl()

Method Detail

getEntityPrefix

public String getEntityPrefix()

Prefix for this provider

Specified by:

getEntityPrefix in interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

getAnnouncementsForSite

public List<?> getAnnouncementsForSite(org.sakaiproject.entitybroker.EntityView view,
                              Map<String,Object> params)

site/siteId

getAnnouncementsForUser

public List<?> getAnnouncementsForUser(org.sakaiproject.entitybroker.EntityView view,
                              Map<String,Object> params)

user

getMessagesOfTheDay

public List<?> getMessagesOfTheDay(org.sakaiproject.entitybroker.EntityView view,
                          Map<String,Object> params)

motd

showAnnouncement

public AnnouncementEntityProviderImpl.DecoratedAnnouncement showAnnouncement(org.sakaiproject.entitybroker.EntityView view,
                                                                    Map<String,Object> params)
                                                                      throws org.sakaiproject.entity.api.EntityPermissionException

This handles announcements, URLs should be like, /announcement/msg/{context}/{channelId}/{announcementId} an example would be /announcement/msg/21b1984d-af58-43da-8583-f4adee769aa2/main/5641323b-761a-4a4d-8761-688f4928141b . Context is normally the site ID and the channelId is normally "main" unless there are multiple channels in a site. This is an alternative to using the packed IDs.

Throws:

org.sakaiproject.entity.api.EntityPermissionException

getAnnouncementByID

public Object getAnnouncementByID(org.sakaiproject.entitybroker.EntityView view,
                         Map<String,Object> params)

message/siteId/EntityID

getSampleEntity

public Object getSampleEntity()

Specified by:

getSampleEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

getHandledOutputFormats

public String[] getHandledOutputFormats()

Specified by:

getHandledOutputFormats in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable

getEntity

public Object getEntity(org.sakaiproject.entitybroker.EntityReference ref)

Specified by:

getEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable