BaseMessage (Sakai base pom 20-SNAPSHOT API)

java.lang.Object
- org.sakaiproject.message.util.BaseMessage

All Implemented Interfaces:

EntityProducer, EntitySummary, MessageService, DoubleStorageUser, SingleStorageUser

Direct Known Subclasses:

BaseAnnouncementService, BaseMailArchiveService
```
public abstract class BaseMessage
extends Object
implements MessageService, DoubleStorageUser
```
BaseMessage is...

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`BaseMessage.BaseMessageChannelEdit<T extends MessageEdit>` MessageChannel implementation
`class`	`BaseMessage.BaseMessageEdit` MessageEdit implementation
`class`	`BaseMessage.BaseMessageHeaderEdit` MessageHeaderEdit implementation
`protected class`	`BaseMessage.MessagePermissionFilter` filter
`protected class`	`BaseMessage.MessageSelectionFilter`
`protected class`	`BaseMessage.NotifyThread` Class that starts a session to import XML data.
`protected class`	`BaseMessage.PublicFilter` A filter that will reject messages which are draft or not public
`protected static interface`	`BaseMessage.Storage` Storage implementation

Field Summary

Fields
Modifier and Type	Field and Description
`protected AuthzGroupService`	`m_authzGroupService` Dependency: AuthzGroupService.
`protected EntityManager`	`m_entityManager` Dependency: EntityManager.
`protected EventTrackingService`	`m_eventTrackingService` Dependency: EventTrackingService.
`protected IdManager`	`m_idManager` Dependency: IdManager.
`protected MemoryService`	`m_memoryService` Dependency: MemoryService.
`protected SecurityService`	`m_securityService` Dependency: SecurityService.
`protected ServerConfigurationService`	`m_serverConfigurationService` Dependency: ServerConfigurationService.
`protected SessionManager`	`m_sessionManager` Dependency: SessionManager.
`protected SiteService`	`m_siteService` Dependency: SiteService.
`protected BaseMessage.Storage`	`m_storage` A Storage object for persistent storage.
`protected ThreadLocalManager`	`m_threadLocalManager` Dependency: ThreadLocalManager.
`protected TimeService`	`m_timeService` Dependency: TimeService.
`protected UserDirectoryService`	`m_userDirectoryService` Dependency: UserDirectoryService.

Fields inherited from interface org.sakaiproject.message.api.MessageService
REF_TYPE_CHANNEL, REF_TYPE_MESSAGE, SECURE_ADD, SECURE_ALL_GROUPS, SECURE_CREATE, SECURE_READ, SECURE_READ_DRAFT, SECURE_REMOVE_ANY, SECURE_REMOVE_OWN, SECURE_UPDATE_ANY, SECURE_UPDATE_OWN

Constructor Summary

Constructors
Constructor and Description

BaseMessage()

Constructors
Constructor and Description
`BaseMessage()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`MessageChannelEdit`	`addChannel(String ref)` Add a new channel.
`boolean`	`allowAddChannel(String ref)` check permissions for addChannel().
`boolean`	`allowEditChannel(String ref)` check permissions for editChannel()
`boolean`	`allowGetChannel(String ref)` check permissions for getChannel().
`protected boolean`	`allowGetMessage(String channelRef, String msgRef)` Check the message read permission for the message
`protected boolean`	`allowGetMessage(String channelRef, String msgRef, boolean isDraft)` Check the message read permission for the message
`boolean`	`allowRemoveChannel(String ref)` Check permissions for removeChannel().
`String`	`archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)` Archive the resources for the given site.
`void`	`archiveSynopticOptions(String siteId, Document doc, Element element)` try to add synoptic options for this tool to the archive, if they exist
`void`	`cancelChannel(MessageChannelEdit edit)` Cancel the changes made to a MessageChannelEdit object, and release the lock.
`void`	`cancelMessage(MessageEdit edit)` Cancel the changes made to a MessageEdit object, and release the lock.
`protected boolean`	`canSeeAllGroups(String userId, Site site)`
`String`	`channelReference(String context, String id)` Access the internal reference which can be used to access the channel from within the system.
`void`	`commitChannel(MessageChannelEdit edit)` Commit the changes made to a MessageChannelEdit object, and release the lock.
`void`	`destroy()` Destroy
`protected void`	`disableMessageChannel(String siteId)` Remove the main message channel for a site.
`MessageChannelEdit`	`editChannel(String ref)` Return a specific channel, as specified by channel id, locked for update.
`protected void`	`enableMessageChannel(String siteId)` Setup a main message channel for a site.
`protected abstract String`	`eventId(String secure)` Form a tracking event string based on a security function string.
`List<Message>`	`filterGroupAccess(List<Message> msgs, String context, String reference)` Filter messages based on group access
`protected MessageChannel`	`findChannel(String ref)` Find the channel, in cache or info store - cache it if newly found.
`protected String`	`getAccessPoint(boolean relative)` Access the partial URL that forms the root of resource URLs.
`MessageChannel`	`getChannel(String ref)` Return a specific channel.
`List<String>`	`getChannelIds(String context)` Access a list of channel ids that are defined related to the context.
`MessageChannel`	`getChannelPublic(String ref)` Return a specific channel Warning: No check is made on channel permissions -- caller should filter for public messages
`List<MessageChannel>`	`getChannels()` Deprecated. since 8 April 2014 (Sakai 10), this is not useful and would perform very badly
`Entity`	`getEntity(Reference ref)` Access the referenced Entity - the entity will belong to the service.
`Collection<String>`	`getEntityAuthzGroups(Reference ref, String userId)` Access a collection of authorization group ids for security on the for the referenced entity - the entity will belong to the service.
`String`	`getEntityDescription(Reference ref)` Create an entity description for the entity referenced - the entity will belong to the service.
`ResourceProperties`	`getEntityResourceProperties(Reference ref)` Access the resource properties for the referenced entity - the entity will belong to the service.
`String`	`getEntityUrl(Reference ref)` Access a URL for the referenced entity - the entity will belong to the service.
`protected Collection<Group>`	`getGroupsAllowFunction(String function, String m_context, String reference)` Get the groups of this channel's contex-site that the end user has permission to "function" in.
`HttpAccess`	`getHttpAccess()` Get the HttpAccess object that supports entity access via the access servlet for my entities.
`Message`	`getMessage(Reference ref)` Get a message, given a reference.
`List<Message>`	`getMessages(String channelRef, Time afterDate, int limitedToLatest, boolean ascending, boolean includeDrafts, boolean pubViewOnly)` Access a list of messages in the channel, that are after the date, limited to just the n latest messages, ordered as specified, including drafts if specified.
`protected abstract String`	`getReferenceRoot()` Return the reference rooot for use in resource references and urls.
`String`	`getSummarizableReference(String siteId, String toolIdentifier)` Get a summerizable reference for the siteId and toolIdentifier
`Map`	`getSummary(String channel, int items, int days)` getSummary implementation
`protected String`	`getSummaryFromHeader(Message item, MessageHeader header)`
`void`	`init()` Final initialization, once all dependencies are set.
`protected boolean`	`isIntersectionGroupRefsToGroups(Collection groupRefs, Collection groups)` See if the collection of group reference strings has at least one group that is in the collection of Group objects.
`String`	`merge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport)` Merge the resources from the archive into the given site.
`String`	`messageReference(String channelRef, String id)` Access the internal reference which can be used to access the message from within the system.
`String`	`messageReference(String context, String channelId, String id)` Access the internal reference which can be used to access the message from within the system.
`protected abstract MessageHeaderEdit`	`newMessageHeader(Message msg, Element el)` Construct a new message header from XML in a DOM element.
`protected abstract MessageHeaderEdit`	`newMessageHeader(Message msg, MessageHeader other)` Construct a new message header as a copy of another.
`protected abstract MessageHeaderEdit`	`newMessageHeader(Message msg, String id)` Construct a new message header from XML in a DOM element.
`protected abstract BaseMessage.Storage`	`newStorage()` Construct a Storage object.
`protected void`	`parseMergeChannelExtra(Element element3, String channelRef)` Handle the extra "categtories" stuff in the channel part of the merge xml.
`void`	`removeChannel(MessageChannelEdit channel)` Remove a channel.
`protected BaseMessage`	`service()` Access this service from the inner classes.
`protected abstract String`	`serviceName()` Report the Service API name being implemented.
`void`	`setAuthzGroupService(AuthzGroupService service)` Dependency: AuthzGroupService.
`void`	`setCaching(String value)` Deprecated. 7 April 2014 - this should be removed in sakai 11
`void`	`setEntityManager(EntityManager service)` Dependency: EntityManager.
`void`	`setEventTrackingService(EventTrackingService service)` Dependency: EventTrackingService.
`void`	`setIdManager(IdManager service)` Dependency: IdManager.
`void`	`setMemoryService(MemoryService service)` Dependency: MemoryService.
`void`	`setSecurityService(SecurityService service)` Dependency: SecurityService.
`void`	`setServerConfigurationService(ServerConfigurationService service)` Dependency: ServerConfigurationService.
`void`	`setSessionManager(SessionManager service)` Dependency: SessionManager.
`void`	`setSiteService(SiteService service)` Dependency: SiteService.
`void`	`setThreadLocalManager(ThreadLocalManager service)` Dependency: ThreadLocalManager.
`void`	`setTimeService(TimeService service)` Dependency: TimeService.
`void`	`setUserDirectoryService(UserDirectoryService service)` Dependency: UserDirectoryService.
`void`	`transferSynopticOptions(String fromContext, String toContext)` Import the synoptic tool options from another site
`protected void`	`unlock(String lock, String resource)` Check security permission.
`protected void`	`unlock2(String lock1, String lock2, String resource)` Check security permission.
`protected void`	`unlock3(String lock1, String lock2, String lock3, String resource)` Check security permission.
`protected boolean`	`unlockCheck(String lock, String resource)` Check security permission.
`protected boolean`	`unlockCheck2(String lock1, String lock2, String resource)` Check security permission, for either of two locks/
`protected boolean`	`unlockCheck3(String lock1, String lock2, String lock3, String resource)` Check security permission, for any of three locks/
`boolean`	`willArchiveMerge()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.sakaiproject.entity.api.EntityProducer
getLabel, parseEntityReference

Methods inherited from interface org.sakaiproject.entity.api.EntitySummary
summarizableToolIds

Methods inherited from interface org.sakaiproject.util.DoubleStorageUser
getDate, getOwnerId, isDraft, newContainer, newContainer, newContainer, newContainerEdit, newContainerEdit, newContainerEdit

Methods inherited from interface org.sakaiproject.util.SingleStorageUser
newResource, newResource, newResource, newResourceEdit, newResourceEdit, newResourceEdit, storageFields

- Field Detail
  - m_storage
```
protected BaseMessage.Storage m_storage
```
    A Storage object for persistent storage.
  - m_memoryService
```
protected MemoryService m_memoryService
```
    Dependency: MemoryService.
  - m_serverConfigurationService
```
protected ServerConfigurationService m_serverConfigurationService
```
    Dependency: ServerConfigurationService.
  - m_sessionManager
```
protected SessionManager m_sessionManager
```
    Dependency: SessionManager.
  - m_authzGroupService
```
protected AuthzGroupService m_authzGroupService
```
    Dependency: AuthzGroupService.
  - m_securityService
```
protected SecurityService m_securityService
```
    Dependency: SecurityService.
  - m_timeService
```
protected TimeService m_timeService
```
    Dependency: TimeService.
  - m_eventTrackingService
```
protected EventTrackingService m_eventTrackingService
```
    Dependency: EventTrackingService.
  - m_idManager
```
protected IdManager m_idManager
```
    Dependency: IdManager.
  - m_siteService
```
protected SiteService m_siteService
```
    Dependency: SiteService.
  - m_userDirectoryService
```
protected UserDirectoryService m_userDirectoryService
```
    Dependency: UserDirectoryService.
  - m_threadLocalManager
```
protected ThreadLocalManager m_threadLocalManager
```
    Dependency: ThreadLocalManager.
  - m_entityManager
```
protected EntityManager m_entityManager
```
    Dependency: EntityManager.
- Constructor Detail
  - BaseMessage
```
public BaseMessage()
```
- Method Detail
  - service
```
protected BaseMessage service()
```
    Access this service from the inner classes.
  - setMemoryService
```
public void setMemoryService(MemoryService service)
```
    Dependency: MemoryService.
    
    Parameters:
    
    service - The MemoryService.
  - setServerConfigurationService
```
public void setServerConfigurationService(ServerConfigurationService service)
```
    Dependency: ServerConfigurationService.
    
    Parameters:
    
    service - The ServerConfigurationService.
  - setSessionManager
```
public void setSessionManager(SessionManager service)
```
    Dependency: SessionManager.
    
    Parameters:
    
    service - The SessionManager.
  - setAuthzGroupService
```
public void setAuthzGroupService(AuthzGroupService service)
```
    Dependency: AuthzGroupService.
    
    Parameters:
    
    service - The AuthzGroupService.
  - setSecurityService
```
public void setSecurityService(SecurityService service)
```
    Dependency: SecurityService.
    
    Parameters:
    
    service - The SecurityService.
  - setTimeService
```
public void setTimeService(TimeService service)
```
    Dependency: TimeService.
    
    Parameters:
    
    service - The TimeService.
  - setEventTrackingService
```
public void setEventTrackingService(EventTrackingService service)
```
    Dependency: EventTrackingService.
    
    Parameters:
    
    service - The EventTrackingService.
  - setIdManager
```
public void setIdManager(IdManager service)
```
    Dependency: IdManager.
    
    Parameters:
    
    service - The IdManager.
  - setSiteService
```
public void setSiteService(SiteService service)
```
    Dependency: SiteService.
    
    Parameters:
    
    service - The SiteService.
  - setUserDirectoryService
```
public void setUserDirectoryService(UserDirectoryService service)
```
    Dependency: UserDirectoryService.
    
    Parameters:
    
    service - The UserDirectoryService.
  - setThreadLocalManager
```
public void setThreadLocalManager(ThreadLocalManager service)
```
    Dependency: ThreadLocalManager.
    
    Parameters:
    
    service - The ThreadLocalManager.
  - setCaching
```
public void setCaching(String value)
```
    Deprecated. 7 April 2014 - this should be removed in sakai 11
    
    Configuration: set the locks-in-db
    
    Parameters:
    
    path - The storage path.
  - setEntityManager
```
public void setEntityManager(EntityManager service)
```
    Dependency: EntityManager.
    
    Parameters:
    
    service - The EntityManager.
  - init
```
public void init()
```
    Final initialization, once all dependencies are set.
  - destroy
```
public void destroy()
```
    Destroy
  - serviceName
```
protected abstract String serviceName()
```
    Report the Service API name being implemented.
  - newStorage
```
protected abstract BaseMessage.Storage newStorage()
```
    Construct a Storage object.
    
    Returns:
    
    The new storage object.
  - newMessageHeader
```
protected abstract MessageHeaderEdit newMessageHeader(Message msg,
                                                      String id)
```
    Construct a new message header from XML in a DOM element.
    
    Parameters:
    
    msg - The message to own this header.
    
    id - The message Id.
    
    Returns:
    
    The new message header.
  - newMessageHeader
```
protected abstract MessageHeaderEdit newMessageHeader(Message msg,
                                                      Element el)
```
    Construct a new message header from XML in a DOM element.
    
    Parameters:
    
    msg - The message to own this header.
    
    el - The XML DOM element that has the header information.
    
    Returns:
    
    The new message header.
  - newMessageHeader
```
protected abstract MessageHeaderEdit newMessageHeader(Message msg,
                                                      MessageHeader other)
```
    Construct a new message header as a copy of another.
    
    Parameters:
    
    msg - The message to own this header.
    
    other - The other header to copy.
    
    Returns:
    
    The new message header.
  - eventId
```
protected abstract String eventId(String secure)
```
    Form a tracking event string based on a security function string.
    
    Parameters:
    
    secure - The security function string.
    
    Returns:
    
    The event tracking string.
  - getReferenceRoot
```
protected abstract String getReferenceRoot()
```
    Return the reference rooot for use in resource references and urls.
    
    Returns:
    
    The reference rooot for use in resource references and urls.
  - getAccessPoint
```
protected String getAccessPoint(boolean relative)
```
    Access the partial URL that forms the root of resource URLs.
    
    Parameters:
    
    relative - if true, form within the access path only (i.e. starting with /msg)
    
    Returns:
    
    the partial URL that forms the root of resource URLs.
  - channelReference
```
public String channelReference(String context,
                               String id)
```
    Access the internal reference which can be used to access the channel from within the system.
    
    Specified by:
    
    channelReference in interface MessageService
    
    Parameters:
    
    context - The context.
    
    id - The channel id.
    
    Returns:
    
    The the internal reference which can be used to access the channel from within the system.
  - messageReference
```
public String messageReference(String context,
                               String channelId,
                               String id)
```
    Access the internal reference which can be used to access the message from within the system.
    
    Specified by:
    
    messageReference in interface MessageService
    
    Parameters:
    
    context - The context.
    
    channelId - The channel id.
    
    id - The message id.
    
    Returns:
    
    The the internal reference which can be used to access the message from within the system.
  - messageReference
```
public String messageReference(String channelRef,
                               String id)
```
    Access the internal reference which can be used to access the message from within the system.
    
    Specified by:
    
    messageReference in interface MessageService
    
    Parameters:
    
    channelRef - The channel reference.
    
    id - The message id.
    
    Returns:
    
    The the internal reference which can be used to access the message from within the system.
  - unlockCheck
```
protected boolean unlockCheck(String lock,
                              String resource)
```
    Check security permission.
    
    Parameters:
    
    lock - The lock id string.
    
    resource - The resource reference string, or null if no resource is involved.
    
    Returns:
    
    true if allowd, false if not
  - unlockCheck2
```
protected boolean unlockCheck2(String lock1,
                               String lock2,
                               String resource)
```
    Check security permission, for either of two locks/
    
    Parameters:
    
    lock1 - The lock id string.
    
    lock2 - The lock id string.
    
    resource - The resource reference string, or null if no resource is involved.
    
    Returns:
    
    true if either allowed, false if not
  - unlockCheck3
```
protected boolean unlockCheck3(String lock1,
                               String lock2,
                               String lock3,
                               String resource)
```
    Check security permission, for any of three locks/
    
    Parameters:
    
    lock1 - The lock id string.
    
    lock2 - The lock id string.
    
    resource - The resource reference string, or null if no resource is involved.
    
    Returns:
    
    true if either allowed, false if not
  - unlock
```
protected void unlock(String lock,
                      String resource)
               throws PermissionException
```
    Check security permission.
    
    Parameters:
    
    lock - The lock id string.
    
    resource - The resource reference string, or null if no resource is involved.
    
    Throws:
    
    PermissionException - Thrown if the user does not have access
  - unlock2
```
protected void unlock2(String lock1,
                       String lock2,
                       String resource)
                throws PermissionException
```
    Check security permission.
    
    Parameters:
    
    lock1 - The lock id string.
    
    lock2 - The lock id string.
    
    resource - The resource reference string, or null if no resource is involved.
    
    Throws:
    
    PermissionException - Thrown if the user does not have access to either.
  - unlock3
```
protected void unlock3(String lock1,
                       String lock2,
                       String lock3,
                       String resource)
                throws PermissionException
```
    Check security permission.
    
    Parameters:
    
    lock1 - The lock id string.
    
    lock2 - The lock id string.
    
    lock3 - The lock id string.
    
    resource - The resource reference string, or null if no resource is involved.
    
    Throws:
    
    PermissionException - Thrown if the user does not have access to either.
  - getChannels
```
public List<MessageChannel> getChannels()
```
    Deprecated. since 8 April 2014 (Sakai 10), this is not useful and would perform very badly
    
    Return a list of all the defined channels.
    
    Specified by:
    
    getChannels in interface MessageService
    
    Returns:
    
    a list of MessageChannel (or extension) objects (may be empty).
  - allowGetChannel
```
public boolean allowGetChannel(String ref)
```
    check permissions for getChannel().
    
    Specified by:
    
    allowGetChannel in interface MessageService
    
    Parameters:
    
    ref - The channel reference.
    
    Returns:
    
    true if the user is allowed to getChannel(channelId), false if not.
  - getChannel
```
public MessageChannel getChannel(String ref)
                          throws IdUnusedException,
                                 PermissionException
```
    Return a specific channel.
    
    Specified by:
    
    getChannel in interface MessageService
    
    Parameters:
    
    ref - The channel reference.
    
    Returns:
    
    the MessageChannel that has the specified name.
    
    Throws:
    
    IdUnusedException - If this name is not defined for any channel.
    
    PermissionException - If the user does not have any permissions to the channel.
  - getChannelPublic
```
public MessageChannel getChannelPublic(String ref)
```
    Return a specific channel Warning: No check is made on channel permissions -- caller should filter for public messages
    
    Specified by:
    
    getChannelPublic in interface MessageService
    
    Parameters:
    
    ref - The channel reference.
    
    Returns:
    
    The channel, if found.
  - findChannel
```
protected MessageChannel findChannel(String ref)
```
    Find the channel, in cache or info store - cache it if newly found.
    
    Parameters:
    
    ref - The channel reference.
    
    Returns:
    
    The channel, if found.
  - allowAddChannel
```
public boolean allowAddChannel(String ref)
```
    check permissions for addChannel().
    
    Specified by:
    
    allowAddChannel in interface MessageService
    
    Parameters:
    
    ref - The channel reference.
    
    Returns:
    
    true if the user is allowed to addChannel(channelId), false if not.
  - addChannel
```
public MessageChannelEdit addChannel(String ref)
                              throws IdUsedException,
                                     IdInvalidException,
                                     PermissionException
```
    Add a new channel. Must commitEdit() to make official, or cancelEdit() when done!
    
    Specified by:
    
    addChannel in interface MessageService
    
    Parameters:
    
    ref - The channel reference.
    
    Returns:
    
    The newly created channel, locked for update.
    
    Throws:
    
    IdUsedException - if the id is not unique.
    
    IdInvalidException - if the id is not made up of valid characters.
    
    PermissionException - if the user does not have permission to add a channel.
  - allowEditChannel
```
public boolean allowEditChannel(String ref)
```
    check permissions for editChannel()
    
    Specified by:
    
    allowEditChannel in interface MessageService
    
    Parameters:
    
    ref - The channel reference.
    
    Returns:
    
    true if the user is allowed to update the channel, false if not.
  - editChannel
```
public MessageChannelEdit editChannel(String ref)
                               throws IdUnusedException,
                                      PermissionException,
                                      InUseException
```
    Return a specific channel, as specified by channel id, locked for update. Must commitEdit() to make official, or cancelEdit() when done!
    
    Specified by:
    
    editChannel in interface MessageService
    
    Parameters:
    
    ref - The channel reference.
    
    Returns:
    
    the Channel that has the specified id.
    
    Throws:
    
    IdUnusedException - If this name is not a defined channel.
    
    PermissionException - If the user does not have any permissions to edit the channel.
    
    InUseException - if the channel is locked for edit by someone else.
  - commitChannel
```
public void commitChannel(MessageChannelEdit edit)
```
    Commit the changes made to a MessageChannelEdit object, and release the lock. The MessageChannelEdit is disabled, and not to be used after this call.
    
    Specified by:
    
    commitChannel in interface MessageService
    
    Parameters:
    
    user - The MessageChannelEdit object to commit.
  - cancelChannel
```
public void cancelChannel(MessageChannelEdit edit)
```
    Cancel the changes made to a MessageChannelEdit object, and release the lock. The MessageChannelEdit is disabled, and not to be used after this call.
    
    Specified by:
    
    cancelChannel in interface MessageService
    
    Parameters:
    
    user - The MessageChannelEdit object to commit.
  - allowRemoveChannel
```
public boolean allowRemoveChannel(String ref)
```
    Check permissions for removeChannel().
    
    Specified by:
    
    allowRemoveChannel in interface MessageService
    
    Parameters:
    
    ref - The channel reference.
    
    Returns:
    
    true if the user is allowed to removeChannel(), false if not.
  - removeChannel
```
public void removeChannel(MessageChannelEdit channel)
                   throws PermissionException
```
    Remove a channel. Remove a channel - it must be locked from editChannel().
    
    Specified by:
    
    removeChannel in interface MessageService
    
    Parameters:
    
    channel - The channel to remove.
    
    Throws:
    
    PermissionException - if the user does not have permission to remove a channel.
  - getMessage
```
public Message getMessage(Reference ref)
                   throws IdUnusedException,
                          PermissionException
```
    Get a message, given a reference. This call avoids the need to have channel security, as long as the user has permissions to the message.
    
    Specified by:
    
    getMessage in interface MessageService
    
    Parameters:
    
    ref - The message reference
    
    Returns:
    
    The message.
    
    Throws:
    
    IdUnusedException - If this reference does not identify a message.
    
    PermissionException - If the user does not have any permissions to the message.
  - allowGetMessage
```
protected boolean allowGetMessage(String channelRef,
                                  String msgRef)
```
    Check the message read permission for the message
    
    Parameters:
    
    ref - The Reference (assumed to be to a message).
    
    Returns:
    
    True if the end user has permission to read the message, or permission to all messages in the channel, false if not.
  - allowGetMessage
```
protected boolean allowGetMessage(String channelRef,
                                  String msgRef,
                                  boolean isDraft)
```
    Check the message read permission for the message
    
    Parameters:
    
    ref - The Reference (assumed to be to a message). isDraft Whether or not the message is in draft
    
    Returns:
    
    True if the end user has permission to read the message, or permission to all messages in the channel, false if not.
  - cancelMessage
```
public void cancelMessage(MessageEdit edit)
```
    Cancel the changes made to a MessageEdit object, and release the lock. The MessageChannelEdit is disabled, and not to be used after this call.
    
    Specified by:
    
    cancelMessage in interface MessageService
    
    Parameters:
    
    user - The MessageEdit object to cancel.
  - getMessages
```
public List<Message> getMessages(String channelRef,
                                 Time afterDate,
                                 int limitedToLatest,
                                 boolean ascending,
                                 boolean includeDrafts,
                                 boolean pubViewOnly)
                          throws PermissionException
```
    Access a list of messages in the channel, that are after the date, limited to just the n latest messages, ordered as specified, including drafts if specified. Channel read permission is required, unless pubViewOnly is selected - draft read on the channel is required to see drafts.
    
    Specified by:
    
    getMessages in interface MessageService
    
    afterDate - if null, no date limit, else limited to only messages after this date.
    
    limitedToLatest - if 0, no count limit, else limited to only the latest this number of messages.
    
    ascending - if true, sort oldest first, else sort latest first.
    
    includeDrafts - if true, include drafts (if the user has draft permission), else leave them out.
    
    pubViewOnly - if true, include only messages marked pubview, else include any.
    
    Returns:
    
    A list of Message objects that meet the criteria; may be empty
    
    Throws:
    
    PermissionException - If the current user does not have channel read permission.
  - filterGroupAccess
```
public List<Message> filterGroupAccess(List<Message> msgs,
                                       String context,
                                       String reference)
```
    Filter messages based on group access
    
    Parameters:
    
    msgs - Messages to filter
    
    context - The context for this channel
    
    reference - The internal reference for this channel
    
    Returns:
    
    Filtered list of Messages
  - isIntersectionGroupRefsToGroups
```
protected boolean isIntersectionGroupRefsToGroups(Collection groupRefs,
                                                  Collection groups)
```
    See if the collection of group reference strings has at least one group that is in the collection of Group objects.
    
    Parameters:
    
    groupRefs - The collection (String) of group references.
    
    groups - The collection (Group) of group objects.
    
    Returns:
    
    true if there is interesection, false if not.
  - getGroupsAllowFunction
```
protected Collection<Group> getGroupsAllowFunction(String function,
                                                   String m_context,
                                                   String reference)
```
    Get the groups of this channel's contex-site that the end user has permission to "function" in.
    
    Parameters:
    
    function - The function to check
    
    Returns:
    
    The Collection (Group) of groups defined for the context of this channel that the end user has specified permissions in, empty if none.
  - canSeeAllGroups
```
protected boolean canSeeAllGroups(String userId,
                                  Site site)
```
  - getChannelIds
```
public List<String> getChannelIds(String context)
```
    Access a list of channel ids that are defined related to the context.
    
    Specified by:
    
    getChannelIds in interface MessageService
    
    Parameters:
    
    context - The context in which to search
    
    Returns:
    
    A List (String) of channel id for channels withing the context.
  - willArchiveMerge
```
public boolean willArchiveMerge()
```
    Specified by:
    
    willArchiveMerge in interface EntityProducer
    
    Returns:
    
    true if the service wants to be part of archive / merge, false if not.
  - getHttpAccess
```
public HttpAccess getHttpAccess()
```
    Get the HttpAccess object that supports entity access via the access servlet for my entities.
    
    Specified by:
    
    getHttpAccess in interface EntityProducer
    
    Returns:
    
    The HttpAccess object for my entities, or null if I do not support access.
  - getEntityDescription
```
public String getEntityDescription(Reference ref)
```
    Create an entity description for the entity referenced - the entity will belong to the service.
    
    Specified by:
    
    getEntityDescription in interface EntityProducer
    
    Parameters:
    
    ref - The entity reference.
    
    Returns:
    
    The entity description, or null if one cannot be made.
  - getEntityResourceProperties
```
public ResourceProperties getEntityResourceProperties(Reference ref)
```
    Access the resource properties for the referenced entity - the entity will belong to the service.
    
    Specified by:
    
    getEntityResourceProperties in interface EntityProducer
    
    Parameters:
    
    ref - The entity reference.
    
    Returns:
    
    The ResourceProperties object for the entity, or null if it has none.
  - getEntity
```
public Entity getEntity(Reference ref)
```
    Access the referenced Entity - the entity will belong to the service.
    
    Specified by:
    
    getEntity in interface EntityProducer
    
    Parameters:
    
    ref - The entity reference.
    
    Returns:
    
    The Entity, or null if not found.
  - getEntityAuthzGroups
```
public Collection<String> getEntityAuthzGroups(Reference ref,
                                               String userId)
```
    Access a collection of authorization group ids for security on the for the referenced entity - the entity will belong to the service.
    
    Specified by:
    
    getEntityAuthzGroups in interface EntityProducer
    
    Parameters:
    
    ref - The entity reference.
    
    userId - The userId for a user-specific set of groups, or null for the generic set.
    
    Returns:
    
    The entity's collection of authorization group ids, or null if this cannot be done.
  - getEntityUrl
```
public String getEntityUrl(Reference ref)
```
    Access a URL for the referenced entity - the entity will belong to the service.
    
    Specified by:
    
    getEntityUrl in interface EntityProducer
    
    Parameters:
    
    ref - The entity reference.
    
    Returns:
    
    The entity's URL, or null if it does not have one.
  - archive
```
public String archive(String siteId,
                      Document doc,
                      Stack stack,
                      String archivePath,
                      List attachments)
```
    Archive the resources for the given site.
    
    Specified by:
    
    archive in interface EntityProducer
    
    Parameters:
    
    siteId - the id of the site.
    
    doc - The document to contain the xml.
    
    stack - The stack of elements, the top of which will be the containing element of the "service.name" element.
    
    archivePath - The path to the folder where we are writing auxilary files.
    
    attachments - This should be an empty List into which the implementation will put any attachments that are needed to support the archived content. Implementation will may use List.contains(Object) so choice of implementation should reflect this.
    
    Returns:
    
    A log of status messages from the archive.
  - archiveSynopticOptions
```
public void archiveSynopticOptions(String siteId,
                                   Document doc,
                                   Element element)
```
    try to add synoptic options for this tool to the archive, if they exist
    
    Parameters:
    
    siteId -
    
    doc -
    
    element -
  - merge
```
public String merge(String siteId,
                    Element root,
                    String archivePath,
                    String fromSiteId,
                    Map attachmentNames,
                    Map userIdTrans,
                    Set userListAllowImport)
```
    Merge the resources from the archive into the given site.
    
    Specified by:
    
    merge in interface EntityProducer
    
    Parameters:
    
    siteId - The id of the site getting imported into.
    
    root - The XML DOM tree of content to merge.
    
    archivePath - The path to the folder where we are reading auxilary files.
    
    fromSiteId - The site id from which these items were archived.
    
    attachmentNames - An empty map should be supplied and during the merge and any attachments that are renamed will be put into this map the key is the old attachment name (as found in the DOM) and the value is the new attachment name.
    
    userIdTrans - A map supplied by the called containing keys of old user IDs and values of new user IDs that the content should be attributed to.
    
    userListAllowImport - A list of user IDs for which the content should be imported. An importer should ignore content if the user ID of the creator isn't in this set.
    
    Returns:
    
    A log of status messages from the merge.
  - transferSynopticOptions
```
public void transferSynopticOptions(String fromContext,
                                    String toContext)
```
    Import the synoptic tool options from another site
    
    Parameters:
    
    fromContext -
    
    toContext -
  - parseMergeChannelExtra
```
protected void parseMergeChannelExtra(Element element3,
                                      String channelRef)
```
    Handle the extra "categtories" stuff in the channel part of the merge xml.
    
    Parameters:
    
    element - The "channel" node child.
    
    channelRef - The message channel ref.
  - enableMessageChannel
```
protected void enableMessageChannel(String siteId)
```
    Setup a main message channel for a site.
    
    Parameters:
    
    siteId - The site id.
  - disableMessageChannel
```
protected void disableMessageChannel(String siteId)
```
    Remove the main message channel for a site.
    
    Parameters:
    
    site - The site.
  - getSummaryFromHeader
```
protected String getSummaryFromHeader(Message item,
                                      MessageHeader header)
```
  - getSummary
```
public Map getSummary(String channel,
                      int items,
                      int days)
               throws IdUsedException,
                      IdInvalidException,
                      PermissionException
```
    getSummary implementation
    
    Specified by:
    
    getSummary in interface EntitySummary
    
    Specified by:
    
    getSummary in interface MessageService
    
    Parameters:
    
    channel - The channel reference.
    
    items - Maximum number of items to return
    
    days - Maximum number of days to peer back
    
    Returns:
    
    The Map containing the Summary
    
    Throws:
    
    IdUsedException - if the id is not unique.
    
    IdInvalidException - if the id is not made up of valid characters.
    
    PermissionException - if the user does not have permission to add a channel.
  - getSummarizableReference
```
public String getSummarizableReference(String siteId,
                                       String toolIdentifier)
```
    Description copied from interface: EntitySummary
    
    Get a summerizable reference for the siteId and toolIdentifier
    
    Specified by:
    
    getSummarizableReference in interface EntitySummary
    
    Parameters:
    
    siteId - The site ID to get the summary for.
    
    toolIdentifier - The tool ID, eg "sakai.announcement".
    
    Returns:
    
    A String that can be passed to EntitySummary.getSummary(String, int, int).

Class BaseMessage

Nested Class Summary

Field Summary

Fields inherited from interface org.sakaiproject.message.api.MessageService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.sakaiproject.entity.api.EntityProducer

Methods inherited from interface org.sakaiproject.entity.api.EntitySummary

Methods inherited from interface org.sakaiproject.util.DoubleStorageUser

Methods inherited from interface org.sakaiproject.util.SingleStorageUser

Field Detail

m_storage

m_memoryService

m_serverConfigurationService

m_sessionManager

m_authzGroupService

m_securityService

m_timeService

m_eventTrackingService

m_idManager

m_siteService

m_userDirectoryService

m_threadLocalManager

m_entityManager

Constructor Detail

BaseMessage

Method Detail

service

setMemoryService

setServerConfigurationService

setSessionManager

setAuthzGroupService

setSecurityService

setTimeService

setEventTrackingService

setIdManager

setSiteService

setUserDirectoryService

setThreadLocalManager

setCaching

setEntityManager

init

destroy

serviceName

newStorage

newMessageHeader

newMessageHeader

newMessageHeader

eventId

getReferenceRoot

getAccessPoint

channelReference

messageReference

messageReference

unlockCheck

unlockCheck2

unlockCheck3

unlock

unlock2

unlock3

getChannels

allowGetChannel

getChannel

getChannelPublic

findChannel

allowAddChannel

addChannel

allowEditChannel

editChannel

commitChannel

cancelChannel

allowRemoveChannel

removeChannel

getMessage

allowGetMessage

allowGetMessage

cancelMessage

getMessages

filterGroupAccess