org.alfresco.test.util

Class SiteService

java.lang.Object

org.alfresco.test.util.SiteService

public class SiteService
extends Object

Site utility helper that performs crud operation on Site.

• Creates an Alfresco site.
• Deletes an Alfresco site.
• Mark as favorite
• Remove favorite

Author:

Michael Suzuki, Bogdan Bocancea

Constructor Summary

Constructors

Constructor and Description
SiteService()

Method Summary

Modifier and Type	Method and Description
boolean	addDashlet(String userName, String password, String siteName, DashboardCustomization.SiteDashlet dashlet, DashboardCustomization.DashletLayout layout, int column, int position) Add dashlet to site dashboard
boolean	addPagesToSite(String userName, String password, String siteName, List<DashboardCustomization.Page> pages) Add pages to site dashboard
boolean	addPageToSite(String userName, String password, String siteName, DashboardCustomization.Page page, List<DashboardCustomization.Page> oldPages) Add a single page to site dashboard If there are pages added previously add them to 'oldPages' list in order to keep them on the site dashboard.
void	create(String username, String password, String domain, String siteId, String description, org.springframework.social.alfresco.api.entities.Site.Visibility visibility) Create site using Alfresco public API.
void	create(String username, String password, String domain, String siteId, String title, String description, org.springframework.social.alfresco.api.entities.Site.Visibility visibility) Create site using Alfresco public API.
void	delete(String username, String password, String domain, String siteId) Delete an alfresco site.
boolean	exists(String siteId, String username, String password) Checks if site exists
String	getSiteNodeRef(String userName, String password, String siteName) Get site node ref
List<String>	getSites(String username, String password) Gets all existing sites
boolean	isFavorite(String userName, String password, String siteName) Verify if a document or folder is marked as favorite
boolean	removeFavorite(String userName, String password, String siteName) Remove favorite site
boolean	setFavorite(String userName, String password, String siteName) Set site as favorite

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteService

public SiteService()

Method Detail

create

public void create(String username,
                   String password,
                   String domain,
                   String siteId,
                   String description,
                   org.springframework.social.alfresco.api.entities.Site.Visibility visibility)
            throws IOException

Create site using Alfresco public API.

Parameters:

username - identifier

password - user password

domain - the company or org id

siteId - site identifier

description - site description

visibility - site visibility type

Throws:

IOException - io error

create

public void create(String username,
                   String password,
                   String domain,
                   String siteId,
                   String title,
                   String description,
                   org.springframework.social.alfresco.api.entities.Site.Visibility visibility)
            throws IOException

Create site using Alfresco public API.

Parameters:

username - identifier

password - user password

domain - the company or org id

siteId - site identifier

title - SiteName

description - site description

visibility - site visibility

Throws:

IOException - io error

exists

public boolean exists(String siteId,
                      String username,
                      String password)
               throws Exception

Checks if site exists

Parameters:

siteId - site identifier

username - site user

password - user password

Returns:

true if exists

Throws:

Exception - if error

delete

public void delete(String username,
                   String password,
                   String domain,
                   String siteId)

Delete an alfresco site.

Parameters:

username - user details

password - user details

domain - user details

siteId - site identifier

getSites

public List<String> getSites(String username,
                             String password)
                      throws Exception

Gets all existing sites

Parameters:

username - site user

password - user password

Returns:

list of sites

Throws:

Exception - if error

getSiteNodeRef

public String getSiteNodeRef(String userName,
                             String password,
                             String siteName)
                      throws Exception

Get site node ref

Parameters:

userName - String identifier

password - String password

siteName - String site name

Returns:

String site node ref

Throws:

Exception - if error

setFavorite

public boolean setFavorite(String userName,
                           String password,
                           String siteName)
                    throws Exception

Set site as favorite

Parameters:

userName - String identifier

password - String password

siteName - String site name

Returns:

true if marked as favorite

Throws:

Exception - if error

isFavorite

public boolean isFavorite(String userName,
                          String password,
                          String siteName)
                   throws Exception

Verify if a document or folder is marked as favorite

Parameters:

userName - String identifier

password - String password

siteName - String site name

Returns:

true if marked as favorite

Throws:

Exception - if error

removeFavorite

public boolean removeFavorite(String userName,
                              String password,
                              String siteName)
                       throws Exception

Remove favorite site

Parameters:

userName - String identifier

password - String password

siteName - String site name

Returns:

true if favorite is removed

Throws:

Exception - if error

addPageToSite

public boolean addPageToSite(String userName,
                             String password,
                             String siteName,
                             DashboardCustomization.Page page,
                             List<DashboardCustomization.Page> oldPages)
                      throws Exception

Add a single page to site dashboard If there are pages added previously add them to 'oldPages' list in order to keep them on the site dashboard.

Parameters:

userName - String identifier

password - String password

siteName - String site name

page - to add

oldPages - - pages that were added previously

Returns:

true if the page is added

Throws:

Exception - if error

addPagesToSite

public boolean addPagesToSite(String userName,
                              String password,
                              String siteName,
                              List<DashboardCustomization.Page> pages)
                       throws Exception

Add pages to site dashboard

Parameters:

userName - String identifier

password - String password

siteName - String site name

pages - to add

Returns:

true if pages are added

Throws:

Exception - if error

addDashlet

public boolean addDashlet(String userName,
                          String password,
                          String siteName,
                          DashboardCustomization.SiteDashlet dashlet,
                          DashboardCustomization.DashletLayout layout,
                          int column,
                          int position)
                   throws Exception

Add dashlet to site dashboard

Parameters:

userName - String identifier

password - String password

siteName - String site name

dashlet - Site dashlet

layout - Dashlet layout

column - int index of columns

position - int position in column

Returns:

true if the dashlet is added

Throws:

Exception - if error