org.alfresco.bm.site

Class SiteDataServiceImpl

java.lang.Object

org.alfresco.bm.site.SiteDataServiceImpl

All Implemented Interfaces:

SiteDataService, org.springframework.beans.factory.InitializingBean

public class SiteDataServiceImpl
extends Object
implements SiteDataService, org.springframework.beans.factory.InitializingBean

Service providing access to SiteData and SiteMember storage. All SiteData and SiteMember returned from and persisted with this service will be testrun-specific. The testrun-identifier is set in the constructor.

Since:

1.3

Author:

steveglover

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SiteDataServiceImpl.SiteCallback
class	SiteDataServiceImpl.Sites A collection of sites.

Constructor Summary

Constructors

Constructor and Description
SiteDataServiceImpl(org.springframework.data.mongodb.core.MongoTemplate mongo, String sitesCollectionName, String siteMembersCollectionName)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSite(SiteData newSite) Add a site
void	addSiteMember(SiteMember siteMember) Add a site member, initially not created.
void	afterPropertiesSet()
void	checkIndexes() Ensure that the MongoDB collection has the required indexes associated with this user bean.
long	countSiteMembers() Count the total number of site members.
long	countSiteMembers(String siteId) Count the number of site members of the given site.
long	countSites() Count the number of sites
long	countSites(boolean created) Count the number of sites that have been created, or are yet to be created
long	countSites(String networkId) Count the number of sites in the given network.
SiteData	findSiteBySiteId(String siteId) Utility method to find a site by siteId
List<SiteMember>	getMembers(String siteId) Get members of site "siteId"
SiteMember	getSiteMember(String siteId, String userId) Get a specific site member
protected List<SiteMember>	getSiteMembersPendingCreation(boolean created, int startIndex, int count)
List<SiteMember>	getSiteMembersPendingCreation(int startIndex, int count) Get a list of site members pending creation, starting at index "startIndex" up to a maximum size of "count"
protected List<SiteData>	getSites(boolean created, int startIndex, int count)
SiteDataServiceImpl.Sites	getSites(int max) Get a list of sites up to a maximum size of "max"
List<SiteData>	getSitesPendingCreation(int startIndex, int count) Get sites pending creation, up to a maximum of "count"
boolean	isSiteMember(String siteId, String userId) Is userId a member of the site "siteId"?
void	markSiteMembersCreated(SiteData site) Mark all members of the given site as having been created.
SiteMember	randomMember(String siteId) Get a random site member in the site given by "siteId" Note that this is useful only for large numbers of sites.
SiteData	randomSite(String networkId) Get a random site in the network given by "networkId" Note that this is useful only for large numbers of sites.
boolean	setSiteCreated(String siteId, boolean created) Mark the site as created or not created
void	setSiteMemberCreated(String siteId, String userId, SiteRole role, boolean created) Mark the site member as created or not created
Iterator<SiteData>	sitesIterator(String networkId, boolean created) Iterate through sites in the network "networkId" that have been created/not created.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiteDataServiceImpl

public SiteDataServiceImpl(org.springframework.data.mongodb.core.MongoTemplate mongo,
                   String sitesCollectionName,
                   String siteMembersCollectionName)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

checkIndexes

public void checkIndexes()

Ensure that the MongoDB collection has the required indexes associated with this user bean.

findSiteBySiteId

public SiteData findSiteBySiteId(String siteId)

Utility method to find a site by siteId

Specified by:

findSiteBySiteId in interface SiteDataService

addSite

public void addSite(SiteData newSite)

Description copied from interface: SiteDataService

Add a site

Specified by:

addSite in interface SiteDataService

setSiteCreated

public boolean setSiteCreated(String siteId,
                     boolean created)

Description copied from interface: SiteDataService

Mark the site as created or not created

Specified by:

setSiteCreated in interface SiteDataService

addSiteMember

public void addSiteMember(SiteMember siteMember)

Description copied from interface: SiteDataService

Add a site member, initially not created.

Specified by:

addSiteMember in interface SiteDataService

getMembers

public List<SiteMember> getMembers(String siteId)

Description copied from interface: SiteDataService

Get members of site "siteId"

Specified by:

getMembers in interface SiteDataService

Returns:

a list of members of the site

countSites

public long countSites(String networkId)

Description copied from interface: SiteDataService

Count the number of sites in the given network.

Specified by:

countSites in interface SiteDataService

Returns:

the number of sites in the given network

countSiteMembers

public long countSiteMembers(String siteId)

Description copied from interface: SiteDataService

Count the number of site members of the given site.

Specified by:

countSiteMembers in interface SiteDataService

Returns:

the number of site members of the given site

countSiteMembers

public long countSiteMembers()

Description copied from interface: SiteDataService

Count the total number of site members.

Specified by:

countSiteMembers in interface SiteDataService

Returns:

the total number of site members

countSites

public long countSites()

Description copied from interface: SiteDataService

Count the number of sites

Specified by:

countSites in interface SiteDataService

Returns:

the total number of sites

countSites

public long countSites(boolean created)

Description copied from interface: SiteDataService

Count the number of sites that have been created, or are yet to be created

Specified by:

countSites in interface SiteDataService

Returns:

the number of sites matching the "created" criterion

getSites

public SiteDataServiceImpl.Sites getSites(int max)

Description copied from interface: SiteDataService

Get a list of sites up to a maximum size of "max"

Specified by:

getSites in interface SiteDataService

Returns:

a collection of max sites

markSiteMembersCreated

public void markSiteMembersCreated(SiteData site)

Description copied from interface: SiteDataService

Mark all members of the given site as having been created.

Specified by:

markSiteMembersCreated in interface SiteDataService

randomSite

public SiteData randomSite(String networkId)

Description copied from interface: SiteDataService

Get a random site in the network given by "networkId" Note that this is useful only for large numbers of sites.

Specified by:

randomSite in interface SiteDataService

Returns:

the siteId of a random site in the given network

randomMember

public SiteMember randomMember(String siteId)

Description copied from interface: SiteDataService

Get a random site member in the site given by "siteId" Note that this is useful only for large numbers of sites.

Specified by:

randomMember in interface SiteDataService

Returns:

a random member of the given site

getSitesPendingCreation

public List<SiteData> getSitesPendingCreation(int startIndex,
                                     int count)

Description copied from interface: SiteDataService

Get sites pending creation, up to a maximum of "count"

Specified by:

getSitesPendingCreation in interface SiteDataService

Returns:

a list of sites pending creation

sitesIterator

public Iterator<SiteData> sitesIterator(String networkId,
                               boolean created)

Description copied from interface: SiteDataService

Iterate through sites in the network "networkId" that have been created/not created.

Specified by:

sitesIterator in interface SiteDataService

Returns:

an iterator over sites in the given network that match the created flag

isSiteMember

public boolean isSiteMember(String siteId,
                   String userId)

Description copied from interface: SiteDataService

Is userId a member of the site "siteId"?

Specified by:

isSiteMember in interface SiteDataService

Parameters:

siteId - site id

userId - site member id

Returns:

true if the user is a member of the site, false otherwise

getSiteMember

public SiteMember getSiteMember(String siteId,
                       String userId)

Description copied from interface: SiteDataService

Get a specific site member

Specified by:

getSiteMember in interface SiteDataService

Returns:

get a specific site member

setSiteMemberCreated

public void setSiteMemberCreated(String siteId,
                        String userId,
                        SiteRole role,
                        boolean created)

Description copied from interface: SiteDataService

Mark the site member as created or not created

Specified by:

setSiteMemberCreated in interface SiteDataService

getSiteMembersPendingCreation

public List<SiteMember> getSiteMembersPendingCreation(int startIndex,
                                             int count)

Description copied from interface: SiteDataService

Get a list of site members pending creation, starting at index "startIndex" up to a maximum size of "count"

Specified by:

getSiteMembersPendingCreation in interface SiteDataService

Returns:

a list of site members pending creation

getSites

protected List<SiteData> getSites(boolean created,
                      int startIndex,
                      int count)

getSiteMembersPendingCreation

protected List<SiteMember> getSiteMembersPendingCreation(boolean created,
                                             int startIndex,
                                             int count)