| java.lang.Object
 org.sakaiproject.authz.impl.BaseAuthzGroupService
All known Subclasses: org.sakaiproject.authz.impl.DbAuthzGroupService,
| BaseAuthzGroupService | | abstract public class BaseAuthzGroupService implements AuthzGroupService,StorageUser(Code) | |
BaseAuthzGroupService is a Sakai azGroup service implementation.
To support the public view feature, an AuthzGroup named TEMPLATE_PUBVIEW must exist, with a role named ROLE_PUBVIEW - all the abilities in this role become the public view abilities for any resource.
|
| Inner Class :protected interface Storage | |
| Inner Class :public class ProviderMap implements Map | |
| Method Summary | |
| public AuthzGroup | addAuthzGroup(String id)
| | public AuthzGroup | addAuthzGroup(String id, AuthzGroup other, String userId)
| | protected void | addLiveProperties(BaseAuthzGroup azGroup)
Create the live properties for the azGroup. | | protected void | addLiveUpdateProperties(BaseAuthzGroup azGroup)
Update the live properties for an AuthzGroup for when modified. | | public boolean | allowAdd(String id)
| | public boolean | allowJoinGroup(String authzGroupId)
| | public boolean | allowRemove(String id)
| | public boolean | allowUnjoinGroup(String authzGroupId)
| | public boolean | allowUpdate(String id)
| | public String | archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)
| | protected String | authzGroupId(String ref)
Access the azGroup id extracted from an AuthzGroup reference.
Parameters:
ref - The azGroup reference string. | | public String | authzGroupReference(String id)
| | protected void | completeSave(AuthzGroup azGroup)
Complete the saving of the group, once id and security checks have been cleared. | | public int | countAuthzGroups(String criteria)
| | public void | destroy()
Returns to uninitialized state. | | abstract protected EntityManager | entityManager()
| | abstract protected EventTrackingService | eventTrackingService()
| | 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 Set | getAllowedFunctions(String role, Collection azGroups)
| | public AuthzGroup | getAuthzGroup(String id)
| | public Set | getAuthzGroupIds(String providerId)
| | public List | getAuthzGroups(String criteria, PagingPosition page)
| | public Set | getAuthzGroupsIsAllowed(String userId, String function, Collection azGroups)
| | public Time | getDate(Entity r)
Access the resource date.
Parameters:
r - The resource. | | 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)
Access the resource owner user id.
Parameters:
r - The resource. | | public Set | getProviderIds(String authzGroupId)
| | public String | getUserRole(String userId, String azGroupId)
| | public Set | getUsersIsAllowed(String function, Collection azGroups)
| | public Map | getUsersRole(Collection userIds, String azGroupId)
| | public void | init()
Final initialization, once all dependencies are set. | | public boolean | isAllowed(String user, String function, String azGroupId)
| | public boolean | isAllowed(String user, String function, Collection azGroups)
| | public boolean | isDraft(Entity r)
Check if this resource is in draft mode.
Parameters:
r - The resource. | | public void | joinGroup(String authzGroupId, String roleId)
| | public String | merge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport)
| | public AuthzGroup | newAuthzGroup(String id, AuthzGroup other, String userId)
| | public Entity | newContainer(String ref)
Construct a new continer given just an id.
Parameters:
id - The id for the new object. | | public Entity | newContainer(Element element)
Construct a new container resource, from an XML element.
Parameters:
element - The XML. | | public Entity | newContainer(Entity other)
Construct a new container resource, as a copy of another
Parameters:
other - The other contianer to copy. | | public Edit | newContainerEdit(String ref)
Construct a new continer given just an id.
Parameters:
id - The id for the new object. | | public Edit | newContainerEdit(Element element)
Construct a new container resource, from an XML element.
Parameters:
element - The XML. | | public Edit | newContainerEdit(Entity other)
Construct a new container resource, as a copy of another
Parameters:
other - The other contianer to copy. | | public Entity | newResource(Entity container, String id, Object[] others)
Construct a new rsource given just an id.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
id - The id for the new object.
Parameters:
others - (options) array of objects to load into the Resource's fields. | | public Entity | newResource(Entity container, Element element)
Construct a new resource, from an XML element.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
element - The XML. | | public Entity | newResource(Entity container, Entity other)
Construct a new resource from another resource of the same type.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
other - The other resource. | | public Edit | newResourceEdit(Entity container, String id, Object[] others)
Construct a new rsource given just an id.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
id - The id for the new object.
Parameters:
others - (options) array of objects to load into the Resource's fields. | | public Edit | newResourceEdit(Entity container, Element element)
Construct a new resource, from an XML element.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
element - The XML. | | public Edit | newResourceEdit(Entity container, Entity other)
Construct a new resource from another resource of the same type.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
other - The other resource. | | abstract protected Storage | newStorage()
Construct storage for this service. | | public boolean | parseEntityReference(String reference, Reference ref)
| | public void | refreshUser(String userId)
| | public void | removeAuthzGroup(AuthzGroup azGroup)
| | public void | removeAuthzGroup(String azGroupId)
| | protected void | removeSiteSecurity(AuthzGroup azGroup)
Update the site security when an AuthzGroup is deleted, if it is a site AuthzGroup. | | public void | save(AuthzGroup azGroup)
| | abstract protected SecurityService | securityService()
| | abstract protected ServerConfigurationService | serverConfigurationService()
| | abstract protected SessionManager | sessionManager()
| | public void | setProvider(GroupProvider provider)
Configuration: set the azGroup provider helper service. | | public Object[] | storageFields(Entity r)
Collect the fields that need to be stored outside the XML (for the resource). | | abstract protected TimeService | timeService()
| | public void | unjoinGroup(String authzGroupId)
| | 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. | | protected void | updateSiteSecurity(AuthzGroup azGroup)
Update the site security based on the values in the AuthzGroup, if it is a site AuthzGroup. | | abstract protected UserDirectoryService | userDirectoryService()
| | public boolean | willArchiveMerge()
|
| m_provider | | protected GroupProvider m_provider(Code) | | A provider of additional Abilities for a userId.
|
| 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.
|
| addLiveProperties | | protected void addLiveProperties(BaseAuthzGroup azGroup)(Code) | | Create the live properties for the azGroup.
|
| addLiveUpdateProperties | | protected void addLiveUpdateProperties(BaseAuthzGroup azGroup)(Code) | | Update the live properties for an AuthzGroup for when modified.
|
| allowJoinGroup | | public boolean allowJoinGroup(String authzGroupId)(Code) | | |
| allowUnjoinGroup | | public boolean allowUnjoinGroup(String authzGroupId)(Code) | | |
| authzGroupId | | protected String authzGroupId(String ref)(Code) | | Access the azGroup id extracted from an AuthzGroup reference.
Parameters:
ref - The azGroup reference string. The the azGroup id extracted from an AuthzGroup reference. |
| completeSave | | protected void completeSave(AuthzGroup azGroup)(Code) | | Complete the saving of the group, once id and security checks have been cleared.
Parameters:
azGroup - |
| countAuthzGroups | | public int countAuthzGroups(String criteria)(Code) | | |
| destroy | | public void destroy()(Code) | | Returns to uninitialized state.
|
| 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. |
| getDate | | public Time getDate(Entity r)(Code) | | Access the resource date.
Parameters:
r - The resource. The resource date. |
| getOwnerId | | public String getOwnerId(Entity r)(Code) | | Access the resource owner user id.
Parameters:
r - The resource. The resource owner user id. |
| init | | public void init()(Code) | | Final initialization, once all dependencies are set.
|
| isDraft | | public boolean isDraft(Entity r)(Code) | | Check if this resource is in draft mode.
Parameters:
r - The resource. true if the resource is in draft mode, false if not. |
| newContainer | | public Entity newContainer(String ref)(Code) | | Construct a new continer given just an id.
Parameters:
id - The id for the new object. The new containe Resource. |
| newContainer | | public Entity newContainer(Element element)(Code) | | Construct a new container resource, from an XML element.
Parameters:
element - The XML. The new container resource. |
| newContainer | | public Entity newContainer(Entity other)(Code) | | Construct a new container resource, as a copy of another
Parameters:
other - The other contianer to copy. The new container resource. |
| newContainerEdit | | public Edit newContainerEdit(String ref)(Code) | | Construct a new continer given just an id.
Parameters:
id - The id for the new object. The new containe Resource. |
| newContainerEdit | | public Edit newContainerEdit(Element element)(Code) | | Construct a new container resource, from an XML element.
Parameters:
element - The XML. The new container resource. |
| newContainerEdit | | public Edit newContainerEdit(Entity other)(Code) | | Construct a new container resource, as a copy of another
Parameters:
other - The other contianer to copy. The new container resource. |
| newResource | | public Entity newResource(Entity container, String id, Object[] others)(Code) | | Construct a new rsource given just an id.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
id - The id for the new object.
Parameters:
others - (options) array of objects to load into the Resource's fields. The new resource. |
| newResource | | public Entity newResource(Entity container, Element element)(Code) | | Construct a new resource, from an XML element.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
element - The XML. The new resource from the XML. |
| newResource | | public Entity newResource(Entity container, Entity other)(Code) | | Construct a new resource from another resource of the same type.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
other - The other resource. The new resource as a copy of the other. |
| newResourceEdit | | public Edit newResourceEdit(Entity container, String id, Object[] others)(Code) | | Construct a new rsource given just an id.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
id - The id for the new object.
Parameters:
others - (options) array of objects to load into the Resource's fields. The new resource. |
| newResourceEdit | | public Edit newResourceEdit(Entity container, Element element)(Code) | | Construct a new resource, from an XML element.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
element - The XML. The new resource from the XML. |
| newResourceEdit | | public Edit newResourceEdit(Entity container, Entity other)(Code) | | Construct a new resource from another resource of the same type.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
other - The other resource. The new resource as a copy of the other. |
| newStorage | | abstract protected Storage newStorage()(Code) | | Construct storage for this service.
|
| removeSiteSecurity | | protected void removeSiteSecurity(AuthzGroup azGroup)(Code) | | Update the site security when an AuthzGroup is deleted, if it is a site AuthzGroup.
Parameters:
azGroup - The AuthzGroup. |
| securityService | | abstract protected SecurityService securityService()(Code) | | the SecurityService collaborator. |
| sessionManager | | abstract protected SessionManager sessionManager()(Code) | | the SessionManager collaborator. |
| setProvider | | public void setProvider(GroupProvider provider)(Code) | | Configuration: set the azGroup provider helper service.
Parameters:
provider - the azGroup provider helper service. |
| storageFields | | public Object[] storageFields(Entity r)(Code) | | Collect the fields that need to be stored outside the XML (for the resource).
An array of field values to store in the record outside the XML (for the resource). |
| timeService | | abstract protected TimeService timeService()(Code) | | the TimeService collaborator. |
| unlock | | protected void unlock(String lock, String resource) throws AuthzPermissionException(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 azGroup 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 |
| updateSiteSecurity | | protected void updateSiteSecurity(AuthzGroup azGroup)(Code) | | Update the site security based on the values in the AuthzGroup, if it is a site AuthzGroup.
Parameters:
azGroup - The AuthzGroup. |
| userDirectoryService | | abstract protected UserDirectoryService userDirectoryService()(Code) | | the ServerConfigurationService collaborator. |
| willArchiveMerge | | public boolean willArchiveMerge()(Code) | | |
|
|