| java.lang.Object
 org.sakaiproject.user.impl.BasePreferencesService
All known Subclasses: org.sakaiproject.user.impl.DbPreferencesService,
| BasePreferencesService | | abstract public class BasePreferencesService implements PreferencesService,StorageUser(Code) | |
BasePreferencesService is a Sakai Preferences implementation.
|
| Inner Class :protected interface Storage | |
| Method Summary | |
| public PreferencesEdit | add(String id)
| | public boolean | allowUpdate(String id)
| | public String | archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)
| | public void | cancel(PreferencesEdit edit)
| | public void | commit(PreferencesEdit edit)
| | public void | destroy()
Returns to uninitialized state. | | public PreferencesEdit | edit(String id)
| | abstract protected EntityManager | entityManager()
| | abstract protected EventTrackingService | eventTrackingService()
| | protected BasePreferences | findPreferences(String id)
Find the preferences object, in cache or storage.
Parameters:
id - The preferences id. | | abstract protected FunctionManager | functionManager()
| | 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. | | public Time | getDate(Entity r)
| | public Entity | getEntity(Reference ref)
| | public Collection | getEntityAuthzGroups(Reference ref, String userId)
| | public String | getEntityDescription(Reference ref)
| | public ResourceProperties | getEntityResourceProperties(Reference ref)
| | public String | getEntityUrl(Reference ref)
| | public HttpAccess | getHttpAccess()
| | public String | getLabel()
| | public String | getOwnerId(Entity r)
| | public Preferences | getPreferences(String id)
| | public void | init()
Final initialization, once all dependencies are set. | | public boolean | isDraft(Entity r)
| | abstract protected MemoryService | memoryService()
| | public String | merge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport)
| | public Entity | newContainer(String ref)
| | public Entity | newContainer(Element element)
| | public Entity | newContainer(Entity other)
| | public Edit | newContainerEdit(String ref)
| | public Edit | newContainerEdit(Element element)
| | public Edit | newContainerEdit(Entity other)
| | public Entity | newResource(Entity container, String id, Object[] others)
| | public Entity | newResource(Entity container, Element element)
| | public Entity | newResource(Entity container, Entity other)
| | public Edit | newResourceEdit(Entity container, String id, Object[] others)
| | public Edit | newResourceEdit(Entity container, Element element)
| | public Edit | newResourceEdit(Entity container, Entity other)
| | abstract protected Storage | newStorage()
Construct storage for this service. | | public boolean | parseEntityReference(String reference, Reference ref)
| | protected String | preferencesId(String ref)
Access the preferences id extracted from a preferences reference.
Parameters:
ref - The preferences reference string. | | public String | preferencesReference(String id)
| | public void | remove(PreferencesEdit edit)
| | abstract protected SecurityService | securityService()
| | abstract protected ServerConfigurationService | serverConfigurationService()
| | abstract protected SessionManager | sessionManager()
| | public Object[] | storageFields(Entity r)
| | protected void | unlock(String lock, String resource)
Check security permission. | | protected boolean | unlockCheck(String lock, String resource)
Check security permission.
Parameters:
lock - The lock id string.
Parameters:
resource - The resource reference string, or null if no resource is involved. | | abstract protected UserDirectoryService | userDirectoryService()
| | public boolean | willArchiveMerge()
|
| ATTR_PREFERENCE | | protected String ATTR_PREFERENCE(Code) | | The session cache variable for current user's preferences
|
| ATTR_PREFERENCE_IS_NULL | | protected String ATTR_PREFERENCE_IS_NULL(Code) | | The session cache variable for indicating whether the current user's preference was null when last looked
|
| m_relativeAccessPoint | | protected String m_relativeAccessPoint(Code) | | The initial portion of a relative access point URL.
|
| m_storage | | protected Storage m_storage(Code) | | Storage manager for this service.
|
| destroy | | public void destroy()(Code) | | Returns to uninitialized state.
|
| entityManager | | abstract protected EntityManager entityManager()(Code) | | the EntityManager collaborator. |
| findPreferences | | protected BasePreferences findPreferences(String id)(Code) | | Find the preferences object, in cache or storage.
Parameters:
id - The preferences id. The preferences object found in cache or storage, or null if not found. |
| functionManager | | abstract protected FunctionManager functionManager()(Code) | | the FunctionManager collaborator. |
| getAccessPoint | | protected String getAccessPoint(boolean relative)(Code) | | 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 /content) the partial URL that forms the root of resource URLs. |
| init | | public void init()(Code) | | Final initialization, once all dependencies are set.
|
| memoryService | | abstract protected MemoryService memoryService()(Code) | | the MemoryService collaborator. |
| newStorage | | abstract protected Storage newStorage()(Code) | | Construct storage for this service.
|
| preferencesId | | protected String preferencesId(String ref)(Code) | | Access the preferences id extracted from a preferences reference.
Parameters:
ref - The preferences reference string. The the preferences id extracted from a preferences reference. |
| securityService | | abstract protected SecurityService securityService()(Code) | | the SecurityService collaborator. |
| sessionManager | | abstract protected SessionManager sessionManager()(Code) | | the SessionManager collaborator. |
| unlock | | protected void unlock(String lock, String resource) throws PermissionException(Code) | | Check security permission.
Parameters:
lock - The lock id string.
Parameters:
resource - The resource reference string, or null if no resource is involved.
exception:
PermissionException - Thrown if the user does not have access |
| unlockCheck | | protected boolean unlockCheck(String lock, String resource)(Code) | | Check security permission.
Parameters:
lock - The lock id string.
Parameters:
resource - The resource reference string, or null if no resource is involved. true if allowd, false if not |
| willArchiveMerge | | public boolean willArchiveMerge()(Code) | | |
|
|