org.sakaiproject.site.impl

Interface BaseSiteService.Storage

All Known Implementing Classes:

DbSiteService.DbStorage

Enclosing class:

BaseSiteService

protected static interface BaseSiteService.Storage

Storage

Method Summary

Modifier and Type	Method and Description
boolean	check(String id) Does the site with this id exist?
void	close() Close.
int	count() Count all the sites.
int	countSites(SiteService.SelectionType type, Object ofType, String criteria, Map propertyCriteria) Count the Site objets that meet specified criteria.
String	findGroupSiteId(String id) Access the Site id for the group with this id.
SitePage	findPage(String id) Access the Page that has this id, if one is defined, else return null.
String	findPageSiteId(String id) Access the Site id for the page with this id.
ToolConfiguration	findTool(String id) Access the ToolConfiguration that has this id, if one is defined, else return null.
String	findToolSiteId(String id) Access the Site id for the tool with this id.
Site	get(String id) Get the site with this id, or null if not found.
List	getAll() Get all sites.
List<String>	getSiteIds(SiteService.SelectionType type, Object ofType, String criteria, Map<String,String> propertyCriteria, Map<String,String> propertyRestrictions, List<String> excludedSites, SiteService.SortType sort, PagingPosition page, String userId) Get the Site IDs for all sites matching criteria.
List<String>	getSiteIds(SiteService.SelectionType type, Object ofType, String criteria, Map<String,String> propertyCriteria, SiteService.SortType sort, PagingPosition page) Get the Site IDs for all sites matching criteria.
List<Site>	getSites(SiteService.SelectionType type, Object ofType, String criteria, Map propertyCriteria, List excludedSites, SiteService.SortType sort, PagingPosition page, boolean requireDescription) Access a list of Site objects that meet specified criteria, with control over description retrieval.
List<Site>	getSites(SiteService.SelectionType type, Object ofType, String criteria, Map propertyCriteria, List excludedSites, SiteService.SortType sort, PagingPosition page, boolean requireDescription, String userId) Access a list of Site objects that meet specified criteria, with control over description retrieval.
List	getSites(SiteService.SelectionType type, Object ofType, String criteria, Map propertyCriteria, SiteService.SortType sort, PagingPosition page) Access a list of Site objects that meet specified criteria.
List<Site>	getSites(SiteService.SelectionType type, Object ofType, String criteria, Map propertyCriteria, SiteService.SortType sort, PagingPosition page, boolean requireDescription) Access a list of Site objects that meet specified criteria, with control over description retrieval.
List<Site>	getSites(SiteService.SelectionType type, Object ofType, String criteria, Map propertyCriteria, SiteService.SortType sort, PagingPosition page, boolean requireDescription, String userId) Access a list of Site objects that meet specified criteria, with control over description retrieval.
String	getSiteSkin(String siteId) Return the skin for this site
List	getSiteTypes() Access a unique list of String site types for any site type defined for any site, sorted by type.
List<Site>	getSoftlyDeletedSites() Get all sites that have been softly deleted
void	open() Open and be ready to read / write.
Site	put(String id) Add a new site with this id.
void	readAllSiteProperties(Site site) Read site properties and all page and tool properties for the site from storage.
void	readGroupProperties(Group groupId, Properties props) Read group properties from storage into the group's properties.
void	readPageProperties(SitePage page, ResourcePropertiesEdit props) Read page properties from storage into the page's properties.
void	readPageTools(SitePage page, ResourceVector tools) Read site page tools from storage into the page's tools.
void	readSiteGroups(Site site, Collection groups) Read site groups from storage into the site's groups.
void	readSitePageProperties(Site site) Read properties for all pages in the site
void	readSitePages(Site site, ResourceVector pages) Read site pages from storage into the site's pages.
void	readSiteProperties(Site site, ResourcePropertiesEdit props) Read site properties from storage into the site's properties.
void	readSiteTools(Site site) Read tools for all pages from storage into the site's page's tools.
void	readToolProperties(ToolConfiguration tool, Properties props) Read tool configuration from storage into the tool's configuration properties.
void	remove(Site site) Remove this site.
void	save(Site site) Save the changes.
void	saveInfo(String siteId, String description, String infoUrl) Save the changes to the two info fields (description and infoUrl) only.
void	saveToolConfig(ToolConfiguration tool) Write an updated tool configuration to the database.
void	setSiteSecurity(String siteId, Set updateUsers, Set visitUnpUsers, Set visitUsers) Establish the internal security for this site.
void	setUserSecurity(String userId, Set updateSites, Set visitUnpSites, Set visitSites) Establish the internal security for user for all sites.
void	unpublish(List<String> siteIds, String modifiedBy, Time modifiedOn) Unpublish the sites by simply unsetting the PUBLISHED flag
void	writeProperties(Entity r, ResourceProperties props) Writes site properties
void	writeProperty(String propertyName, String propertyValue, String... siteId) Saves a site property for the sites with the specified IDs using the specified name-value pair in a single transaction.

Method Detail

open

void open()

Open and be ready to read / write.

close

void close()

Close.

check

boolean check(String id)

Does the site with this id exist?

Parameters:

id - The site id.

Returns:

true if the site with this id exists, false if not.

get

Site get(String id)

Get the site with this id, or null if not found.

Parameters:

id - The site id.

Returns:

The site with this id, or null if not found.

getAll

List getAll()

Get all sites.

Returns:

The list of all sites.

put

Site put(String id)

Add a new site with this id.

Parameters:

id - The site id.

Returns:

The site with this id, or null if in use.

save

void save(Site site)

Save the changes.

Parameters:

site - The site to commit.

saveInfo

void saveInfo(String siteId,
              String description,
              String infoUrl)

Save the changes to the two info fields (description and infoUrl) only.

Parameters:

siteId - The site to commit.

description - The new site description.

infoUrl - The new site infoUrl.

unpublish

void unpublish(List<String> siteIds,
               String modifiedBy,
               Time modifiedOn)

Unpublish the sites by simply unsetting the PUBLISHED flag

Parameters:

siteIds - The site to unpublish

modifedBy - User who is unpublishing the site (as a userID)

modifiedOn - Time that the site is unpublished

writeProperties

void writeProperties(Entity r,
                     ResourceProperties props)

Writes site properties

writeProperty

void writeProperty(String propertyName,
                   String propertyValue,
                   String... siteId)

Saves a site property for the sites with the specified IDs using the specified name-value pair in a single transaction. NB: inserts only; doesn't do any duplicate checking. Vulnerable to unique constraint violations Use this only when making very minimal changes in performance critical tasks.

remove

void remove(Site site)

Remove this site.

Parameters:

user - The site to remove.

count

int count()

Count all the sites.

Returns:

The count of all sites.

getSiteTypes

List getSiteTypes()

Access a unique list of String site types for any site type defined for any site, sorted by type.

Returns:

A list (String) of all used site types.

getSites

List getSites(SiteService.SelectionType type,
              Object ofType,
              String criteria,
              Map propertyCriteria,
              SiteService.SortType sort,
              PagingPosition page)

Access a list of Site objects that meet specified criteria.

Parameters:

type - The SelectionType specifying what sort of selection is intended.

ofType - Site type criteria: null for any type; a String to match a single type; A String[], List or Set to match any type in the collection.

criteria - Additional selection criteria: sits returned will match this string somewhere in their id, title, description, or skin.

propertyCriteria - Additional selection criteria: sites returned will have a property named to match each key in the map, whose values match (somewhere in their value) the value in the map (may be null or empty).

sort - A SortType indicating the desired sort. For no sort, set to SortType.NONE.

page - The PagePosition subset of items to return.

Returns:

The List (Site) of Site objects that meet specified criteria.

getSites

List<Site> getSites(SiteService.SelectionType type,
                    Object ofType,
                    String criteria,
                    Map propertyCriteria,
                    SiteService.SortType sort,
                    PagingPosition page,
                    boolean requireDescription)

Access a list of Site objects that meet specified criteria, with control over description retrieval. Note that this signature is primarily provided to help with performance when retrieving lists of sites not for full display, specifically for the list of a user's sites for navigation. Note that any sites that have their descriptions, pages, or tools cached will be returned completely, so some or all full descriptions may be present even when requireDescription is passed as false. If a fully populated Site is desired from a potentially partially populated Site, call getSite or Site.loadAll(). Either method will load and cache whatever additional data is not yet cached.

Parameters:

type - The SelectionType specifying what sort of selection is intended.

ofType - Site type criteria: null for any type; a String to match a single type; A String[], List or Set to match any type in the collection.

criteria - Additional selection criteria: sits returned will match this string somewhere in their id, title, description, or skin.

propertyCriteria - Additional selection criteria: sites returned will have a property named to match each key in the map, whose values match (somewhere in their value) the value in the map (may be null or empty).

sort - A SortType indicating the desired sort. For no sort, set to SortType.NONE.

page - The PagePosition subset of items to return.

requireDescription - When true, force a full retrieval of each description; when false, return any uncached descriptions as the empty string

Returns:

The List of Site objects that meet specified criteria.

getSites

List<Site> getSites(SiteService.SelectionType type,
                    Object ofType,
                    String criteria,
                    Map propertyCriteria,
                    List excludedSites,
                    SiteService.SortType sort,
                    PagingPosition page,
                    boolean requireDescription)

Access a list of Site objects that meet specified criteria, with control over description retrieval. Note that this signature is primarily provided to help with performance when retrieving lists of sites not for full display, specifically for the list of a user's sites for navigation. Note that any sites that have their descriptions, pages, or tools cached will be returned completely, so some or all full descriptions may be present even when requireDescription is passed as false. If a fully populated Site is desired from a potentially partially populated Site, call getSite or Site.loadAll(). Either method will load and cache whatever additional data is not yet cached.

Parameters:

type - The SelectionType specifying what sort of selection is intended.

ofType - Site type criteria: null for any type; a String to match a single type; A String[], List or Set to match any type in the collection.

criteria - Additional selection criteria: sits returned will match this string somewhere in their id, title, description, or skin.

propertyCriteria - Additional selection criteria: sites returned will have a property named to match each key in the map, whose values match (somewhere in their value) the value in the map (may be null or empty).

excludedSites - List with siteIDs to be excluded from being loaded. If no exclusions are required, set to NULL or empty list.

sort - A SortType indicating the desired sort. For no sort, set to SortType.NONE.

page - The PagePosition subset of items to return.

requireDescription - When true, force a full retrieval of each description; when false, return any uncached descriptions as the empty string

Returns:

The List of Site objects that meet specified criteria.

getSites

List<Site> getSites(SiteService.SelectionType type,
                    Object ofType,
                    String criteria,
                    Map propertyCriteria,
                    SiteService.SortType sort,
                    PagingPosition page,
                    boolean requireDescription,
                    String userId)

Access a list of Site objects that meet specified criteria, with control over description retrieval. Note that this signature is primarily provided to help with performance when retrieving lists of sites not for full display, specifically for the list of a user's sites for navigation. Note that any sites that have their descriptions, pages, or tools cached will be returned completely, so some or all full descriptions may be present even when requireDescription is passed as false. If a fully populated Site is desired from a potentially partially populated Site, call getSite or Site.loadAll(). Either method will load and cache whatever additional data is not yet cached.

Parameters:

type - The SelectionType specifying what sort of selection is intended.

ofType - Site type criteria: null for any type; a String to match a single type; A String[], List or Set to match any type in the collection.

criteria - Additional selection criteria: sits returned will match this string somewhere in their id, title, description, or skin.

propertyCriteria - Additional selection criteria: sites returned will have a property named to match each key in the map, whose values match (somewhere in their value) the value in the map (may be null or empty).

sort - A SortType indicating the desired sort. For no sort, set to SortType.NONE.

page - The PagePosition subset of items to return.

requireDescription - When true, force a full retrieval of each description; when false, return any uncached descriptions as the empty string

userId - The returned sites will be those which can be accessed by the user with this internal ID

Returns:

The List of Site objects that meet specified criteria.

getSites

List<Site> getSites(SiteService.SelectionType type,
                    Object ofType,
                    String criteria,
                    Map propertyCriteria,
                    List excludedSites,
                    SiteService.SortType sort,
                    PagingPosition page,
                    boolean requireDescription,
                    String userId)

Access a list of Site objects that meet specified criteria, with control over description retrieval. Note that this signature is primarily provided to help with performance when retrieving lists of sites not for full display, specifically for the list of a user's sites for navigation. Note that any sites that have their descriptions, pages, or tools cached will be returned completely, so some or all full descriptions may be present even when requireDescription is passed as false. If a fully populated Site is desired from a potentially partially populated Site, call getSite or Site.loadAll(). Either method will load and cache whatever additional data is not yet cached.

Parameters:

type - The SelectionType specifying what sort of selection is intended.

ofType - Site type criteria: null for any type; a String to match a single type; A String[], List or Set to match any type in the collection.

criteria - Additional selection criteria: sits returned will match this string somewhere in their id, title, description, or skin.

propertyCriteria - Additional selection criteria: sites returned will have a property named to match each key in the map, whose values match (somewhere in their value) the value in the map (may be null or empty).

excludedSites - List with siteIDs to be excluded from being loaded. If no exclusions are required, set to NULL or empty list.

sort - A SortType indicating the desired sort. For no sort, set to SortType.NONE.

page - The PagePosition subset of items to return.

requireDescription - When true, force a full retrieval of each description; when false, return any uncached descriptions as the empty string

userId - The returned sites will be those which can be accessed by the user with this internal ID

Returns:

The List of Site objects that meet specified criteria.

getSiteIds

List<String> getSiteIds(SiteService.SelectionType type,
                        Object ofType,
                        String criteria,
                        Map<String,String> propertyCriteria,
                        SiteService.SortType sort,
                        PagingPosition page)

Get the Site IDs for all sites matching criteria. This is useful when you only need the listing of site ids (for other operations) and do not need the actual Site objects. All parameters are the same as getSites(org.sakaiproject.site.api.SiteService.SelectionType, Object, String, Map, org.sakaiproject.site.api.SiteService.SortType, PagingPosition)

Parameters:

type - The SelectionType specifying what sort of selection is intended.

ofType - Site type criteria: null for any type; a String to match a single type; A String[], List or Set to match any type in the collection.

criteria - Additional selection criteria: sites returned will match this string somewhere in their id, title, description, or skin.

propertyCriteria - Additional selection criteria: sites returned will have a property named to match each key in the map, whose values match (somewhere in their value) the value in the map (may be null or empty).

sort - A SortType indicating the desired sort. For no sort, set to SortType.NONE.

page - The PagePosition subset of items to return.

Returns:

a List of the Site IDs for the sites matching the criteria.

getSiteIds

List<String> getSiteIds(SiteService.SelectionType type,
                        Object ofType,
                        String criteria,
                        Map<String,String> propertyCriteria,
                        Map<String,String> propertyRestrictions,
                        List<String> excludedSites,
                        SiteService.SortType sort,
                        PagingPosition page,
                        String userId)

Get the Site IDs for all sites matching criteria. This is useful when you only need the listing of site ids (for other operations) and do not need the actual Site objects. All parameters are the same as getSites(org.sakaiproject.site.api.SiteService.SelectionType, Object, String, Map, org.sakaiproject.site.api.SiteService.SortType, PagingPosition)

Parameters:

type - The SelectionType specifying what sort of selection is intended.

ofType - Site type criteria: null for any type; a String to match a single type; A String[], List or Set to match any type in the collection.

criteria - Additional selection criteria: sites returned will match this string somewhere in their id, title, description, or skin.

propertyCriteria - Additional selection criteria: sites returned will have a property named to match each key in the map, whose values match (somewhere in their value) the value in the map (may be null or empty).

propertyRestrictions - Similar to propertyCriteria, except matches will be excluded

excludedSites - siteIds to be excluded from the results

sort - A SortType indicating the desired sort. For no sort, set to SortType.NONE.

page - The PagePosition subset of items to return.

userId - The returned sites will be those which can be accessed by the user with this internal ID

Returns:

a List of the Site IDs for the sites matching the criteria.

countSites

int countSites(SiteService.SelectionType type,
               Object ofType,
               String criteria,
               Map propertyCriteria)

Count the Site objets that meet specified criteria.

Parameters:

type - The SelectionType specifying what sort of selection is intended.

ofType - Site type criteria: null for any type; a String to match a single type; A String[], List or Set to match any type in the collection.

criteria - Additional selection criteria: sits returned will match this string somewhere in their id, title, description, or skin.

propertyCriteria - Additional selection criteria: sites returned will have a property named to match each key in the map, whose values match (somewhere in their value) the value in the map (may be null or empty).

Returns:

The count of Site objets that meet specified criteria.

findTool

ToolConfiguration findTool(String id)

Access the ToolConfiguration that has this id, if one is defined, else return null. The tool may be on any SitePage in any site.

Parameters:

id - The id of the tool.

Returns:

The ToolConfiguration that has this id, if one is defined, else return null.

findToolSiteId

String findToolSiteId(String id)

Access the Site id for the tool with this id.

Parameters:

id - The id of the tool.

Returns:

The Site id for the tool with this id, if the tool is found, else null.

findPage

SitePage findPage(String id)

Access the Page that has this id, if one is defined, else return null. The page may be on any Site.

Parameters:

id - The id of the page.

Returns:

The SitePage that has this id, if one is defined, else return null.

findPageSiteId

String findPageSiteId(String id)

Access the Site id for the page with this id.

Parameters:

id - The id of the page.

Returns:

The Site id for the page with this id, if the page is found, else null.

readSiteProperties

void readSiteProperties(Site site,
                        ResourcePropertiesEdit props)

Read site properties from storage into the site's properties.

Parameters:

site - The site for which properties are desired.

readSitePageProperties

void readSitePageProperties(Site site)

Read properties for all pages in the site

Parameters:

site - The site to read properties for.

readAllSiteProperties

void readAllSiteProperties(Site site)

Read site properties and all page and tool properties for the site from storage.

Parameters:

site - The site for which properties are desired.

readPageProperties

void readPageProperties(SitePage page,
                        ResourcePropertiesEdit props)

Read page properties from storage into the page's properties.

Parameters:

page - The page for which properties are desired.

readToolProperties

void readToolProperties(ToolConfiguration tool,
                        Properties props)

Read tool configuration from storage into the tool's configuration properties.

Parameters:

tool - The tool for which properties are desired.

readGroupProperties

void readGroupProperties(Group groupId,
                         Properties props)

Read group properties from storage into the group's properties.

Parameters:

groupId - The groupId for which properties are desired.

readSitePages

void readSitePages(Site site,
                   ResourceVector pages)

Read site pages from storage into the site's pages.

Parameters:

site - The site for which pages are desired.

readPageTools

void readPageTools(SitePage page,
                   ResourceVector tools)

Read site page tools from storage into the page's tools.

Parameters:

page - The page for which tools are desired.

readSiteTools

void readSiteTools(Site site)

Read tools for all pages from storage into the site's page's tools.

Parameters:

site - The site for which tools are desired.

getSiteSkin

String getSiteSkin(String siteId)

Return the skin for this site

Parameters:

siteId - The site id.

Returns:

the skin for this site.

setSiteSecurity

void setSiteSecurity(String siteId,
                     Set updateUsers,
                     Set visitUnpUsers,
                     Set visitUsers)

Establish the internal security for this site. Previous security settings are replaced for this site. Assigning a user with update implies the two reads; assigning a user with unp read implies the other read.

Parameters:

siteId - The id of the site.

updateUsers - The set of String User Ids who have update access.

visitUnpUsers - The set of String User Ids who have visit unpublished access.

visitUsers - The set of String User Ids who have visit access.

setUserSecurity

void setUserSecurity(String userId,
                     Set updateSites,
                     Set visitUnpSites,
                     Set visitSites)

Establish the internal security for user for all sites. Previous security settings are replaced for this user. Assigning a user with update implies the two reads; assigning a user with unp read implies the other read.

Parameters:

userId - The id of the user.

updateSites - The set of String site ids where the user has update access.

visitUnpSites - The set of String site ids where the user has visit unpublished access.

visitSites - The set of String site ids where the user has visit access.

saveToolConfig

void saveToolConfig(ToolConfiguration tool)

Write an updated tool configuration to the database.

Parameters:

tool - TooConfiguration to commit.

findGroupSiteId

String findGroupSiteId(String id)

Access the Site id for the group with this id.

Parameters:

id - The id of the group.

Returns:

The Site id for the group with this id, if the group is found, else null.

readSiteGroups

void readSiteGroups(Site site,
                    Collection groups)

Read site groups from storage into the site's groups.

Parameters:

site - The site for which groups are desired.

groups - The Collection to fill in.

getSoftlyDeletedSites

List<Site> getSoftlyDeletedSites()

Get all sites that have been softly deleted

Returns:

List of Sites or empty list if none.