| org.sakaiproject.authz.api.SecurityService
All known Subclasses: org.sakaiproject.authz.impl.NoSecurity, org.sakaiproject.authz.impl.SakaiSecurity,
| SecurityService | | public interface SecurityService (Code) | |
SecurityService is the interface for Sakai security services.
|
| Field Summary | |
| final static String | SERVICE_NAME
This string can be used to find the service in the service manager. |
| Method Summary | |
| void | clearAdvisors()
Remove any SecurityAdvisors from this thread. | | boolean | hasAdvisors()
Check if there are any security advisors stacked for this thread. | | boolean | isSuperUser()
| | boolean | isSuperUser(String userId)
Is this user a super special super (admin) user?
Parameters:
userId - The user to test. | | SecurityAdvisor | popAdvisor()
Remove one SecurityAdvisor from the stack for this thread, if any exist. | | void | pushAdvisor(SecurityAdvisor advisor)
Establish a new SecurityAdvisor for this thread, at the top of the stack (it gets first dibs on the answer). | | boolean | unlock(String lock, String reference)
Can the current session user unlock the lock for use with this resource?
Parameters:
lock - The lock id string.
Parameters:
reference - The resource reference string. | | boolean | unlock(User user, String lock, String reference)
Can the specificed user unlock the lock for use with this resource?
Parameters:
user - The user.
Parameters:
lock - The lock id string.
Parameters:
reference - The resource reference string. | | boolean | unlock(String userId, String lock, String reference)
Can the specificed user id unlock the lock for use with this resource?
Parameters:
userId - The user id.
Parameters:
lock - The lock id string.
Parameters:
reference - The resource reference string. | | boolean | unlock(String userId, String lock, String reference, Collection authzGroupIds)
Can the specificed user id unlock the lock for use with this resource (using these authzGroups for the check)?
Parameters:
userId - The user id.
Parameters:
lock - The lock id string.
Parameters:
reference - The resource reference string.
Parameters:
authzGroupIds - The set of authz group ids to use for the check (the reference is not consulted). | | List | unlockUsers(String lock, String reference)
Access the List of Users who can unlock the lock for use with this resource.
Parameters:
lock - The lock id string.
Parameters:
reference - The resource reference string. |
| SERVICE_NAME | | final static String SERVICE_NAME(Code) | | This string can be used to find the service in the service manager.
|
| clearAdvisors | | void clearAdvisors()(Code) | | Remove any SecurityAdvisors from this thread.
|
| hasAdvisors | | boolean hasAdvisors()(Code) | | Check if there are any security advisors stacked for this thread.
true if some advisors are defined, false if not. |
| isSuperUser | | boolean isSuperUser()(Code) | | Is this a super special super (admin) user?
true, if the user is a cut above the rest, false if a mere mortal. |
| isSuperUser | | boolean isSuperUser(String userId)(Code) | | Is this user a super special super (admin) user?
Parameters:
userId - The user to test. true, if this user is a cut above the rest, false if a mere mortal. |
| popAdvisor | | SecurityAdvisor popAdvisor()(Code) | | Remove one SecurityAdvisor from the stack for this thread, if any exist.
advisor The advisor popped of, or null if the stack is empty. |
| pushAdvisor | | void pushAdvisor(SecurityAdvisor advisor)(Code) | | Establish a new SecurityAdvisor for this thread, at the top of the stack (it gets first dibs on the answer).
Parameters:
advisor - The advisor to establish |
| unlock | | boolean unlock(String lock, String reference)(Code) | | Can the current session user unlock the lock for use with this resource?
Parameters:
lock - The lock id string.
Parameters:
reference - The resource reference string. true, if the user can unlock the lock, false otherwise. |
| unlock | | boolean unlock(User user, String lock, String reference)(Code) | | Can the specificed user unlock the lock for use with this resource?
Parameters:
user - The user.
Parameters:
lock - The lock id string.
Parameters:
reference - The resource reference string. true, if the user can unlock the lock, false otherwise. |
| unlock | | boolean unlock(String userId, String lock, String reference)(Code) | | Can the specificed user id unlock the lock for use with this resource?
Parameters:
userId - The user id.
Parameters:
lock - The lock id string.
Parameters:
reference - The resource reference string. true, if the user can unlock the lock, false otherwise. |
| unlock | | boolean unlock(String userId, String lock, String reference, Collection authzGroupIds)(Code) | | Can the specificed user id unlock the lock for use with this resource (using these authzGroups for the check)?
Parameters:
userId - The user id.
Parameters:
lock - The lock id string.
Parameters:
reference - The resource reference string.
Parameters:
authzGroupIds - The set of authz group ids to use for the check (the reference is not consulted). true, if the user can unlock the lock, false otherwise. |
| unlockUsers | | List unlockUsers(String lock, String reference)(Code) | | Access the List of Users who can unlock the lock for use with this resource.
Parameters:
lock - The lock id string.
Parameters:
reference - The resource reference string. A List (User) of the users can unlock the lock (may be empty). |
|
|