| java.lang.Object
 org.sakaiproject.user.impl.BaseUserDirectoryService
All known Subclasses: org.sakaiproject.user.impl.DbUserService,
| BaseUserDirectoryService | | abstract public class BaseUserDirectoryService implements UserDirectoryService,StorageUser,UserFactory(Code) | |
BaseUserDirectoryService is a Sakai user directory services implementation.
User records can be kept locally, in Sakai, externally, by a UserDirectoryProvider, or a mixture of both.
Each User that ever goes through Sakai is allocated a Sakai unique UUID. Even if we don't keep the User record in Sakai, we keep a map of this id to the external eid.
|
| Inner Class :protected interface Storage | |
| Method Summary | |
| protected void | addLiveProperties(BaseUserEdit edit)
Create the live properties for the user. | | protected void | addLiveUpdateProperties(BaseUserEdit edit)
Update the live properties for a user for when modified. | | public UserEdit | addUser(String id, String eid)
| | public User | addUser(String id, String eid, String firstName, String lastName, String email, String pw, String type, ResourceProperties properties)
| | public boolean | allowAddUser()
| | public boolean | allowRemoveUser(String id)
| | public boolean | allowUpdateUser(String id)
| | public boolean | allowUpdateUserEmail(String id)
| | public boolean | allowUpdateUserName(String id)
| | public boolean | allowUpdateUserPassword(String id)
| | public boolean | allowUpdateUserType(String id)
| | public String | archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)
| | protected String | assureUuid(String id, String eid)
Make sure we have a good uuid for a user record. | | public User | authenticate(String eid, String password)
| | abstract protected AuthzGroupService | authzGroupService()
| | public void | cancelEdit(UserEdit user)
| | protected String | cleanEid(String eid)
Adjust the eid - trim it to null, and lower case IF we are case insensitive.
Parameters:
eid - The eid to clean up. | | protected String | cleanId(String id)
Adjust the id - trim it to null. | | public void | commitEdit(UserEdit user)
| | public int | countSearchUsers(String criteria)
| | public int | countUsers()
| | public void | destroy()
Returns to uninitialized state. | | public void | destroyAuthentication()
| | public UserEdit | editUser(String id)
| | abstract protected EntityManager | entityManager()
| | abstract protected EventTrackingService | eventTrackingService()
| | public Collection | findUsersByEmail(String email)
| | 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 User | getAnonymousUser()
| | public User | getCurrentUser()
| | 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 User | getUser(String id)
| | public User | getUserByEid(String eid)
| | public String | getUserEid(String id)
| | public String | getUserId(String eid)
| | public List | getUsers(Collection ids)
| | public List | getUsers()
| | public List | getUsers(int first, int last)
| | abstract protected IdManager | idManager()
| | 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 UserEdit | mergeUser(Element el)
| | 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 UserEdit | newUser()
| | public boolean | parseEntityReference(String reference, Reference ref)
| | public void | removeUser(UserEdit user)
| | public List | searchUsers(String criteria, int first, int last)
| | abstract protected SecurityService | securityService()
| | abstract protected ServerConfigurationService | serverConfigurationService()
| | abstract protected SessionManager | sessionManager()
| | public void | setCacheCleanerMinutes(String time)
Set the # minutes between cache cleanings.
Parameters:
time - The # minutes between cache cleanings. | | public void | setCacheMinutes(String time)
Set the # minutes to cache a get. | | public void | setCaseSensitiveId(String value)
| | public void | setProvider(UserDirectoryProvider provider)
Configuration: set the user directory provider helper service. | | public void | setSeparateIdEid(String value)
Configuration: to use a separate value for id and eid for each user record, or not. | | public Object[] | storageFields(Entity r)
| | abstract protected ThreadLocalManager | threadLocalManager()
| | abstract protected TimeService | timeService()
| | protected String | unlock(String lock, String resource)
Check security permission. | | protected List | unlock(List locks, String resource)
Check security permission.
Parameters:
locks - The list of lock strings.
Parameters:
resource - The resource reference string, or null if no resource is involved.
exception:
UserPermissionException - Thrown if the user does not have access to either. | | protected void | unlock2(String lock1, String lock2, 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. | | protected boolean | unlockCheck(List locks, String resource)
Check security permission.
Parameters:
lock - A list of lock strings to consider.
Parameters:
resource - The resource reference string, or null if no resource is involved. | | protected boolean | unlockCheck2(String lock1, String lock2, String resource)
Check security permission.
Parameters:
lock1 - The lock id string.
Parameters:
lock2 - The lock id string.
Parameters:
resource - The resource reference string, or null if no resource is involved. | | protected String | userId(String ref)
Access the user id extracted from a user reference.
Parameters:
ref - The user reference string. | | public String | userReference(String id)
Access the internal reference which can be used to access the resource from within the system.
Parameters:
id - The user id string. | | public boolean | willArchiveMerge()
|
| M_curUserKey | | final protected String M_curUserKey(Code) | | Key for current service caching of current user
|
| m_cacheCleanerSeconds | | protected int m_cacheCleanerSeconds(Code) | | The # seconds to cache gets. 0 disables the cache.
|
| m_cacheSeconds | | protected int m_cacheSeconds(Code) | | The # seconds to cache gets. 0 disables the cache.
|
| m_callCache | | protected Cache m_callCache(Code) | | A cache of calls to the service and the results.
|
| m_caseSensitiveEid | | protected boolean m_caseSensitiveEid(Code) | | Configuration: case sensitive user eid.
|
| m_relativeAccessPoint | | protected String m_relativeAccessPoint(Code) | | The initial portion of a relative access point URL.
|
| m_separateIdEid | | protected boolean m_separateIdEid(Code) | | Configuration: use a different id and eid for each record (otherwise make them the same value).
|
| m_storage | | protected Storage m_storage(Code) | | Storage manager for this service.
|
| addLiveProperties | | protected void addLiveProperties(BaseUserEdit edit)(Code) | | Create the live properties for the user.
|
| addLiveUpdateProperties | | protected void addLiveUpdateProperties(BaseUserEdit edit)(Code) | | Update the live properties for a user for when modified.
|
| allowAddUser | | public boolean allowAddUser()(Code) | | |
| allowRemoveUser | | public boolean allowRemoveUser(String id)(Code) | | |
| allowUpdateUser | | public boolean allowUpdateUser(String id)(Code) | | |
| allowUpdateUserEmail | | public boolean allowUpdateUserEmail(String id)(Code) | | |
| allowUpdateUserName | | public boolean allowUpdateUserName(String id)(Code) | | |
| allowUpdateUserPassword | | public boolean allowUpdateUserPassword(String id)(Code) | | |
| allowUpdateUserType | | public boolean allowUpdateUserType(String id)(Code) | | |
| assureUuid | | protected String assureUuid(String id, String eid)(Code) | | Make sure we have a good uuid for a user record. If id is specified, use that. Otherwise get one from the provider or allocate a uuid.
Parameters:
id - The proposed id.
Parameters:
eid - The proposed eid. The id to use as the User's uuid. |
| authzGroupService | | abstract protected AuthzGroupService authzGroupService()(Code) | | the AuthzGroupService collaborator. |
| cleanEid | | protected String cleanEid(String eid)(Code) | | Adjust the eid - trim it to null, and lower case IF we are case insensitive.
Parameters:
eid - The eid to clean up. A cleaned up eid. |
| cleanId | | protected String cleanId(String id)(Code) | | Adjust the id - trim it to null. Note: eid case insensitive option does NOT apply to id.
Parameters:
id - The id to clean up. A cleaned up id. |
| countSearchUsers | | public int countSearchUsers(String criteria)(Code) | | |
| countUsers | | public int countUsers()(Code) | | |
| destroy | | public void destroy()(Code) | | Returns to uninitialized state. You can use this method to release resources thet your Service allocated when Turbine shuts down.
|
| destroyAuthentication | | public void destroyAuthentication()(Code) | | |
| entityManager | | abstract protected EntityManager entityManager()(Code) | | the EntityManager collaborator. |
| 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. |
| getAnonymousUser | | public User getAnonymousUser()(Code) | | |
| getUsers | | public List getUsers(int first, int last)(Code) | | |
| idManager | | abstract protected IdManager idManager()(Code) | | the IdManager collaborator. |
| 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.
|
| securityService | | abstract protected SecurityService securityService()(Code) | | the SecurityService collaborator. |
| sessionManager | | abstract protected SessionManager sessionManager()(Code) | | the SessionManager collaborator. |
| setCacheCleanerMinutes | | public void setCacheCleanerMinutes(String time)(Code) | | Set the # minutes between cache cleanings.
Parameters:
time - The # minutes between cache cleanings. (as an integer string). |
| setCacheMinutes | | public void setCacheMinutes(String time)(Code) | | Set the # minutes to cache a get.
Parameters:
time - The # minutes to cache a get (as an integer string). |
| setCaseSensitiveId | | public void setCaseSensitiveId(String value)(Code) | | Configuration: case sensitive user eid
Parameters:
value - The case sensitive user eid. |
| setProvider | | public void setProvider(UserDirectoryProvider provider)(Code) | | Configuration: set the user directory provider helper service.
Parameters:
provider - the user directory provider helper service. |
| setSeparateIdEid | | public void setSeparateIdEid(String value)(Code) | | Configuration: to use a separate value for id and eid for each user record, or not.
Parameters:
value - The separateIdEid setting. |
| timeService | | abstract protected TimeService timeService()(Code) | | the TimeService collaborator. |
| unlock | | protected String unlock(String lock, String resource) throws UserPermissionException(Code) | | Check security permission.
Parameters:
lock - The lock id string.
Parameters:
resource - The resource reference string, or null if no resource is involved.
exception:
UserPermissionException - Thrown if the user does not have access The lock id string that succeeded |
| unlock | | protected List unlock(List locks, String resource) throws UserPermissionException(Code) | | Check security permission.
Parameters:
locks - The list of lock strings.
Parameters:
resource - The resource reference string, or null if no resource is involved.
exception:
UserPermissionException - Thrown if the user does not have access to either. A list of the lock strings that the user has access to. |
| unlock2 | | protected void unlock2(String lock1, String lock2, String resource) throws UserPermissionException(Code) | | Check security permission.
Parameters:
lock1 - The lock id string.
Parameters:
lock2 - The lock id string.
Parameters:
resource - The resource reference string, or null if no resource is involved.
exception:
UserPermissionException - Thrown if the user does not have access to either. |
| 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 |
| unlockCheck | | protected boolean unlockCheck(List locks, String resource)(Code) | | Check security permission.
Parameters:
lock - A list of lock strings to consider.
Parameters:
resource - The resource reference string, or null if no resource is involved. true if any of these locks are allowed, false if not |
| unlockCheck2 | | protected boolean unlockCheck2(String lock1, String lock2, String resource)(Code) | | Check security permission.
Parameters:
lock1 - The lock id string.
Parameters:
lock2 - The lock id string.
Parameters:
resource - The resource reference string, or null if no resource is involved. true if either allowed, false if not |
| userId | | protected String userId(String ref)(Code) | | Access the user id extracted from a user reference.
Parameters:
ref - The user reference string. The the user id extracted from a user reference. |
| userReference | | public String userReference(String id)(Code) | | Access the internal reference which can be used to access the resource from within the system.
Parameters:
id - The user id string. The the internal reference which can be used to access the resource from within the system. |
| willArchiveMerge | | public boolean willArchiveMerge()(Code) | | |
|
|