Alias Service
Definition
The Alias service supports the mapping of alias strings to a target. This is useful when things like sites have a long, cryptic name (such as a GUID).
Mutable vs. Immutable
The Alias model follows the Entity model by providing Alias and AliasEdit classes.
Common Data Elements
The followin data elements are included in Alias:
Element | Description |
|---|---|
Id | The identifier of this alias. The alias name. |
Created by | Returns a Sakai user. |
Modified by | Returns a Sakai user. |
Created time | Returns a Sakai time stamp. |
Modified time | Returns a Skai time stamp. |
Target | Alias target |
Description | Alias description |
Properties
All Sakai entities may have an arbitrary number of properties associated with them. While all of these properties are optional, certain properties are commonly used such as who created or modified, creation or modified time-date, etc.
The Alias Service
Provides methods to get the target of an alias, create new ones, edit them, commit them, etc.
Objects
The following objects are included in the Sakai entity interface:
Alias
AliasEdit
AliasService
Exceptions moved or added for 2.2:
(none)
Common and Best Practices
John Leasia
A Sakai alias can be used instead of the site id when emailing to the site -
test@sakai.edu rather than 6ade75f9-aeef-4338-80ae-62e391045975@sakai.edu for example.
It can also be used in place of the site id for access urls
/access/content/group/test instead of /access/content/group/6ade75f9-aeef-4338-80ae-62e391045975