| org.sakaiproject.entity.api.EntityProducer
All known Subclasses: org.sakaiproject.chat2.model.impl.ChatEntityProducer, org.sakaiproject.tool.gradebook.facades.sakai2impl.BaseEntityProducer, org.sakaiproject.tool.assessment.services.assessment.AssessmentEntityProducer, org.sakaiproject.metaobj.shared.mgt.EntityProducerBase, org.sakaiproject.sample.impl.SampleImplAccess,
| EntityProducer | | public interface EntityProducer (Code) | |
Services which implement EntityProducer declare themselves as producers of Sakai entities.
|
| Method Summary | |
| String | archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)
Archive the resources for the given site.
Parameters:
siteId - the id of the site.
Parameters:
doc - The document to contain the xml.
Parameters:
stack - The stack of elements, the top of which will be the containing element of the "service.name" element.
Parameters:
archivePath - The path to the folder where we are writing auxilary files.
Parameters:
attachments - A list of attachments - add to this if any attachments need to be included in the archive. | | Entity | getEntity(Reference ref)
Access the referenced Entity - the entity will belong to the service.
Parameters:
ref - The entity reference. | | Collection | 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.
Parameters:
ref - The entity reference.
Parameters:
userId - The userId for a user-specific set of groups, or null for the generic set. | | String | getEntityDescription(Reference ref)
Create an entity description for the entity referenced - the entity will belong to the service.
Parameters:
ref - The entity reference. | | ResourceProperties | getEntityResourceProperties(Reference ref)
Access the resource properties for the referenced entity - the entity will belong to the service.
Parameters:
ref - The entity reference. | | String | getEntityUrl(Reference ref)
Access a URL for the referenced entity - the entity will belong to the service.
Parameters:
ref - The entity reference. | | HttpAccess | getHttpAccess()
Get the HttpAccess object that supports entity access via the access servlet for my entities. | | String | getLabel()
| | 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.
Parameters:
siteId - The id of the site getting imported into.
Parameters:
root - The XML DOM tree of content to merge.
Parameters:
archviePath - The path to the folder where we are reading auxilary files.
Parameters:
fromSite - The site id from which these items were archived.
Parameters:
attachmentNames - A map of old attachment name (as found in the DOM) to new attachment name. | | boolean | parseEntityReference(String reference, Reference ref)
If the service recognizes the reference as its own, parse it and fill in the Reference
Parameters:
reference - The reference string to examine.
Parameters:
ref - The Reference object to set with the results of the parse from a recognized reference. | | boolean | willArchiveMerge()
|
| archive | | String archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)(Code) | | Archive the resources for the given site.
Parameters:
siteId - the id of the site.
Parameters:
doc - The document to contain the xml.
Parameters:
stack - The stack of elements, the top of which will be the containing element of the "service.name" element.
Parameters:
archivePath - The path to the folder where we are writing auxilary files.
Parameters:
attachments - A list of attachments - add to this if any attachments need to be included in the archive. A log of status messages from the archive. |
| getEntity | | Entity getEntity(Reference ref)(Code) | | Access the referenced Entity - the entity will belong to the service.
Parameters:
ref - The entity reference. The Entity, or null if not found. |
| getEntityAuthzGroups | | Collection getEntityAuthzGroups(Reference ref, String userId)(Code) | | Access a collection of authorization group ids for security on the for the referenced entity - the entity will belong to the service.
Parameters:
ref - The entity reference.
Parameters:
userId - The userId for a user-specific set of groups, or null for the generic set. The entity's collection of authorization group ids, or null if this cannot be done. |
| getEntityDescription | | String getEntityDescription(Reference ref)(Code) | | Create an entity description for the entity referenced - the entity will belong to the service.
Parameters:
ref - The entity reference. The entity description, or null if one cannot be made. |
| getEntityResourceProperties | | ResourceProperties getEntityResourceProperties(Reference ref)(Code) | | Access the resource properties for the referenced entity - the entity will belong to the service.
Parameters:
ref - The entity reference. The ResourceProperties object for the entity, or null if it has none. |
| getEntityUrl | | String getEntityUrl(Reference ref)(Code) | | Access a URL for the referenced entity - the entity will belong to the service.
Parameters:
ref - The entity reference. The entity's URL, or null if it does not have one. |
| getHttpAccess | | HttpAccess getHttpAccess()(Code) | | Get the HttpAccess object that supports entity access via the access servlet for my entities.
The HttpAccess object for my entities, or null if I do not support access. |
| getLabel | | String getLabel()(Code) | | a short string identifying the resources kept here, good for a file name or label. |
| merge | | String merge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport)(Code) | | Merge the resources from the archive into the given site.
Parameters:
siteId - The id of the site getting imported into.
Parameters:
root - The XML DOM tree of content to merge.
Parameters:
archviePath - The path to the folder where we are reading auxilary files.
Parameters:
fromSite - The site id from which these items were archived.
Parameters:
attachmentNames - A map of old attachment name (as found in the DOM) to new attachment name. A log of status messages from the merge. |
| parseEntityReference | | boolean parseEntityReference(String reference, Reference ref)(Code) | | If the service recognizes the reference as its own, parse it and fill in the Reference
Parameters:
reference - The reference string to examine.
Parameters:
ref - The Reference object to set with the results of the parse from a recognized reference. true if the reference belonged to the service, false if not. |
| willArchiveMerge | | boolean willArchiveMerge()(Code) | | true if the serice wants to be part of archive / merge, false if not. |
|
|