| java.lang.Object
 org.sakaiproject.alias.impl.BaseAliasService
All known Subclasses: org.sakaiproject.alias.impl.DbAliasService,
| Inner Class :protected interface Storage | |
| Method Summary | |
| public AliasEdit | add(String id)
Add a new alias. | | protected void | addLiveProperties(ResourcePropertiesEdit props)
Create the live properties for the user. | | protected void | addLiveUpdateProperties(ResourcePropertiesEdit props)
Update the live properties for a user for when modified. | | protected String | aliasId(String ref)
Access the alias id extracted from a alias reference.
Parameters:
ref - The alias reference string. | | public String | aliasReference(String id)
Access the internal reference which can be used to access the resource from within the system.
Parameters:
id - The alias id string. | | public boolean | allowAdd()
Check to see if the current user can add an alias. | | public boolean | allowEdit(String id)
Check to see if the current user can edit this alias.
Parameters:
id - The alias id string. | | public boolean | allowRemoveAlias(String alias)
Check to see if the current user can remove this alias.
Parameters:
alias - The alias. | | public boolean | allowRemoveTargetAliases(String target)
Check to see if the current user can remove these aliasese for this target resource reference.
Parameters:
target - The target resource reference string. | | public boolean | allowSetAlias(String alias, String target)
Check if the current user has permission to set this alias.
Parameters:
alias - The alias.
Parameters:
target - The resource reference string alias target. | | public String | archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)
| | public void | cancel(AliasEdit edit)
Cancel the changes made to a AliasEdit object, and release the lock. | | public void | commit(AliasEdit edit)
Commit the changes made to a AliasEdit object, and release the lock. | | public int | countAliases()
| | public int | countSearchAliases(String criteria)
| | public void | destroy()
Returns to uninitialized state. | | public AliasEdit | edit(String id)
Get a locked alias object for editing. | | 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 List | getAliases(String target)
Find all the aliases defined for this target.
Parameters:
target - The target resource reference string. | | public List | getAliases(String target, int first, int last)
Find all the aliases defined for this target, within the record range given (sorted by id).
Parameters:
target - The target resource reference string.
Parameters:
first - The first record position to return.
Parameters:
last - The last record position to return. | | public List | getAliases(int first, int last)
Find all the aliases within the record range given (sorted by id).
Parameters:
first - The first record position to return.
Parameters:
last - The last record position to return. | | 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 String | getTarget(String alias)
Find the target resource reference string associated with this alias.
Parameters:
alias - The alias. | | public void | init()
Final initialization, once all dependencies are set. | | public boolean | isDraft(Entity r)
Check if this resource is in draft mode.
Parameters:
r - The resource. | | 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)
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 resource 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 resource 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 | remove(AliasEdit edit)
Remove this alias information - it must be a user with a lock from edit(). | | public void | removeAlias(String alias)
Remove an alias. | | public void | removeTargetAliases(String target)
Remove all aliases for this target resource reference, if any. | | public List | searchAliases(String criteria, int first, int last)
| | abstract protected SecurityService | securityService()
| | abstract protected ServerConfigurationService | serverConfigurationService()
| | abstract protected SessionManager | sessionManager()
| | public void | setAlias(String alias, String target)
| | 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. | | abstract protected SiteService | siteService()
| | public Object[] | storageFields(Entity r)
Collect the fields that need to be stored outside the XML (for the resource). | | abstract protected TimeService | timeService()
| | 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 boolean | unlockTargetCheck(String target)
Check security permission, target modify based.
Parameters:
target - The target resource reference string. | | abstract protected UserDirectoryService | userDirectoryService()
| | public boolean | willArchiveMerge()
|
| 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_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.
|
| addLiveUpdateProperties | | protected void addLiveUpdateProperties(ResourcePropertiesEdit props)(Code) | | Update the live properties for a user for when modified.
|
| aliasId | | protected String aliasId(String ref)(Code) | | Access the alias id extracted from a alias reference.
Parameters:
ref - The alias reference string. The the alias id extracted from a alias reference. |
| aliasReference | | public String aliasReference(String id)(Code) | | Access the internal reference which can be used to access the resource from within the system.
Parameters:
id - The alias id string. The the internal reference which can be used to access the resource from within the system. |
| allowAdd | | public boolean allowAdd()(Code) | | Check to see if the current user can add an alias.
true if the current user can add an alias, false if not. |
| allowEdit | | public boolean allowEdit(String id)(Code) | | Check to see if the current user can edit this alias.
Parameters:
id - The alias id string. true if the current user can edit this alias, false if not. |
| allowRemoveAlias | | public boolean allowRemoveAlias(String alias)(Code) | | Check to see if the current user can remove this alias.
Parameters:
alias - The alias. true if the current user can remove this alias, false if not. |
| allowRemoveTargetAliases | | public boolean allowRemoveTargetAliases(String target)(Code) | | Check to see if the current user can remove these aliasese for this target resource reference.
Parameters:
target - The target resource reference string. true if the current user can remove these aliasese for this target resource reference, false if not. |
| allowSetAlias | | public boolean allowSetAlias(String alias, String target)(Code) | | Check if the current user has permission to set this alias.
Parameters:
alias - The alias.
Parameters:
target - The resource reference string alias target. true if the current user has permission to set this alias, false if not. |
| cancel | | public void cancel(AliasEdit edit)(Code) | | Cancel the changes made to a AliasEdit object, and release the lock. The AliasEdit is disabled, and not to be used after this call.
Parameters:
user - The AliasEdit object to commit. |
| commit | | public void commit(AliasEdit edit)(Code) | | Commit the changes made to a AliasEdit object, and release the lock. The AliasEdit is disabled, and not to be used after this call.
Parameters:
user - The AliasEdit object to commit. |
| countAliases | | public int countAliases()(Code) | | |
| countSearchAliases | | public int countSearchAliases(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. |
| getAliases | | public List getAliases(String target)(Code) | | Find all the aliases defined for this target.
Parameters:
target - The target resource reference string. A list (Alias) of all the aliases defined for this target. |
| getAliases | | public List getAliases(String target, int first, int last)(Code) | | Find all the aliases defined for this target, within the record range given (sorted by id).
Parameters:
target - The target resource reference string.
Parameters:
first - The first record position to return.
Parameters:
last - The last record position to return. A list (Alias) of all the aliases defined for this target, within the record range given (sorted by id). |
| getAliases | | public List getAliases(int first, int last)(Code) | | Find all the aliases within the record range given (sorted by id).
Parameters:
first - The first record position to return.
Parameters:
last - The last record position to return. A list (Alias) of all the aliases within the record range given (sorted by id). |
| 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. |
| getTarget | | public String getTarget(String alias) throws IdUnusedException(Code) | | Find the target resource reference string associated with this alias.
Parameters:
alias - The alias. The target resource reference string associated with this alias.
throws:
IdUnusedException - if the alias is not defined. |
| 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. |
| memoryService | | abstract protected MemoryService memoryService()(Code) | | the MemoryService collaborator. |
| 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 resource 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 resource 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.
|
| remove | | public void remove(AliasEdit edit) throws PermissionException(Code) | | Remove this alias information - it must be a user with a lock from edit(). The AliasEdit is disabled, and not to be used after this call.
Parameters:
edit - The locked AliasEdit object to remove.
exception:
PermissionException - if the current user does not have permission to remove this alias. |
| removeTargetAliases | | public void removeTargetAliases(String target) throws PermissionException(Code) | | Remove all aliases for this target resource reference, if any.
Parameters:
target - The target resource reference string.
throws:
PermissionException - if the current user does not have permission to remove these aliases. |
| searchAliases | | public List searchAliases(String criteria, int first, int last)(Code) | | |
| 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). |
| siteService | | abstract protected SiteService siteService()(Code) | | the SiteService collaborator. |
| 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 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 allowed, false if not |
| unlockTargetCheck | | protected boolean unlockTargetCheck(String target)(Code) | | Check security permission, target modify based.
Parameters:
target - The target resource reference string. true if allowed, false if not |
| willArchiveMerge | | public boolean willArchiveMerge()(Code) | | |
|
|