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 SiteMemberData storage. All SiteData and SiteMemberData returned from and persisted with this service will be testrun-specific. The testrun-identifier is set in the constructor.

Since:

2.0

Author:

steveglover, Michael Suzuki

Constructor Summary

Constructors

Constructor and Description
SiteDataServiceImpl(com.mongodb.DB db, String sites, String siteMembers)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSite(SiteData newSite) Add a site
void	addSiteMember(SiteMemberData 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.
static com.mongodb.DBObject	convertSiteData(SiteData siteData) Converts SiteData to DBObject.
static SiteData	convertSiteDataDBObject(com.mongodb.DBObject result) Converts DBObject to SiteData.
static com.mongodb.DBObject	convertSiteMember(SiteMemberData siteMember) Converts SiteMemberData to DBObject.
static SiteMemberData	convertSiteMemberDBObject(com.mongodb.DBObject result) Converts DBObject to SiteMemberData.
long	countSiteMembers(String siteId, org.alfresco.bm.data.DataCreationState state) Count the site members for the given criteria
long	countSites(String domain, org.alfresco.bm.data.DataCreationState state) Count the number of sites in the given domain.
SiteData	getSite(String siteId) Utility method to find a site by siteId
SiteMemberData	getSiteMember(String siteId, String userId) Get a specific site member
List<SiteMemberData>	getSiteMembers(String siteId, org.alfresco.bm.data.DataCreationState state, String role, int skip, int count) Get a paged list of site members for the given parameters
List<SiteData>	getSites(String domain, org.alfresco.bm.data.DataCreationState state, int skip, int count) Get a paged list of sites
boolean	isSiteMember(String siteId, String userId) Is userId a member of the site "siteId"?
SiteData	randomSite(String domain, org.alfresco.bm.data.DataCreationState state) Get a random site for the given parameters
SiteMemberData	randomSiteMember(String siteId, org.alfresco.bm.data.DataCreationState state, String username, String... roles) Get a random site member in the site given by "siteId" and state
void	setSiteCreationState(String siteId, String guid, org.alfresco.bm.data.DataCreationState state) Mark the site as created or not created
void	setSiteMemberCreationState(String siteId, String userId, org.alfresco.bm.data.DataCreationState state) Mark the site member as created or 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(com.mongodb.DB db,
                   String sites,
                   String siteMembers)

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.

convertSiteDataDBObject

public static SiteData convertSiteDataDBObject(com.mongodb.DBObject result)

Converts DBObject to SiteData.

convertSiteData

public static com.mongodb.DBObject convertSiteData(SiteData siteData)

Converts SiteData to DBObject.

convertSiteMemberDBObject

public static SiteMemberData convertSiteMemberDBObject(com.mongodb.DBObject result)

Converts DBObject to SiteMemberData.

convertSiteMember

public static com.mongodb.DBObject convertSiteMember(SiteMemberData siteMember)

Converts SiteMemberData to DBObject.

countSites

public long countSites(String domain,
              org.alfresco.bm.data.DataCreationState state)

Description copied from interface: SiteDataService

Count the number of sites in the given domain.

Specified by:

countSites in interface SiteDataService

Returns:

the number of sites in the given domain

getSite

public SiteData getSite(String siteId)

Description copied from interface: SiteDataService

Utility method to find a site by siteId

Specified by:

getSite in interface SiteDataService

addSite

public void addSite(SiteData newSite)

Description copied from interface: SiteDataService

Add a site

Specified by:

addSite in interface SiteDataService

setSiteCreationState

public void setSiteCreationState(String siteId,
                        String guid,
                        org.alfresco.bm.data.DataCreationState state)

Description copied from interface: SiteDataService

Mark the site as created or not created

Specified by:

setSiteCreationState in interface SiteDataService

getSites

public List<SiteData> getSites(String domain,
                      org.alfresco.bm.data.DataCreationState state,
                      int skip,
                      int count)

Description copied from interface: SiteDataService

Get a paged list of sites

Specified by:

getSites in interface SiteDataService

Parameters:

domain - filter on the domain or null to ignore

state - filter on the creation state or null to ignore

Returns:

a paged collection of sites

randomSite

public SiteData randomSite(String domain,
                  org.alfresco.bm.data.DataCreationState state)

Description copied from interface: SiteDataService

Get a random site for the given parameters

Specified by:

randomSite in interface SiteDataService

Parameters:

domain - the user domain (optional)

state - the membership creation state (optional)

Returns:

a random site

countSiteMembers

public long countSiteMembers(String siteId,
                    org.alfresco.bm.data.DataCreationState state)

Description copied from interface: SiteDataService

Count the site members for the given criteria

Specified by:

countSiteMembers in interface SiteDataService

Parameters:

siteId - the id of the site (optional)

state - the membership creation state (optional)

Returns:

the site membership could

addSiteMember

public void addSiteMember(SiteMemberData siteMember)

Description copied from interface: SiteDataService

Add a site member, initially not created.

Specified by:

addSiteMember in interface SiteDataService

getSiteMembers

public List<SiteMemberData> getSiteMembers(String siteId,
                                  org.alfresco.bm.data.DataCreationState state,
                                  String role,
                                  int skip,
                                  int count)

Description copied from interface: SiteDataService

Get a paged list of site members for the given parameters

Specified by:

getSiteMembers in interface SiteDataService

Parameters:

siteId - the name of the site (optional)

state - the creation state (optional)

role - the member's or members' role (optional)

Returns:

a list of site members matching the criteria

randomSiteMember

public SiteMemberData randomSiteMember(String siteId,
                              org.alfresco.bm.data.DataCreationState state,
                              String username,
                              String... roles)

Description copied from interface: SiteDataService

Get a random site member in the site given by "siteId" and state

Specified by:

randomSiteMember in interface SiteDataService

Parameters:

siteId - the ID of the site (optional)

state - the data creation state of the site (optional)

username - a specific user that must be a member (optional)

roles - specific site roles to find (optional)

Returns:

a random member of the given site

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 SiteMemberData getSiteMember(String siteId,
                           String userId)

Description copied from interface: SiteDataService

Get a specific site member

Specified by:

getSiteMember in interface SiteDataService

setSiteMemberCreationState

public void setSiteMemberCreationState(String siteId,
                              String userId,
                              org.alfresco.bm.data.DataCreationState state)

Description copied from interface: SiteDataService

Mark the site member as created or not created

Specified by:

setSiteMemberCreationState in interface SiteDataService