Package org.alfresco.rest.requests

Class Site

java.lang.Object

org.alfresco.rest.requests.ModelRequest<Site>

org.alfresco.rest.requests.Site

public class Site
extends ModelRequest<Site>

Declares all Rest API under the /sites path

Field Summary

Fields inherited from class org.alfresco.rest.requests.ModelRequest

restWrapper

Constructor Summary

Constructors

Constructor	Description
Site(org.alfresco.utility.model.SiteModel site, RestWrapper restWrapper)

Method Summary

Modifier and Type	Method	Description
RestSiteMemberModel	addPerson(org.alfresco.utility.model.UserModel person)	Add new site member using POST call on "/sites/{siteId}/members"
RestResponse	approveSiteMembership(org.alfresco.utility.model.UserModel siteMember)	Approve a site membership request by using POST call on /sites/{siteId}/site-membership-requests/{inviteeId}/approve
RestSiteModel	createSite()	Create a collaboration site
void	deleteSiteMember(org.alfresco.utility.model.UserModel person)	Delete site member with DELETE call on "sites/{siteId}/members/{personId}"
RestSiteModel	getSite()	Retrieve one site using GET call on "sites/{siteId}"
RestSiteContainerModel	getSiteContainer(java.lang.String containerFolder)	Retrieve specific container of a site using GET call on "sites/{siteId}/containers/{containerId}"
RestSiteContainerModel	getSiteContainer(RestSiteContainerModel container)	Retrieve specific container of a site using GET call on "sites/{siteId}/containers/{containerId}"
RestSiteContainerModelsCollection	getSiteContainers()	Retrieve all containers of a site using GET call on "sites/{siteId}/containers"
RestSiteMemberModel	getSiteMember(org.alfresco.utility.model.UserModel user)	Retrieve specific member of a site using GET call on "sites/{siteId}/members/{personId}"
RestSiteMemberModelsCollection	getSiteMembers()	Retrieve all members of a site using GET call on "sites/{siteId}/members"
RestSitePersonMembershipRequestModelsCollection	getSiteMemberships()	Get site membership requests by using GET /site-membership-requests
RestSiteModelsCollection	getSites()	Retrieve 100 sites (this is the default size when maxItems is not specified) from Alfresco using GET call on TestGroup.SITES
java.util.List<java.util.List<java.lang.Object>>	getSitesWithRelations()	Retrieve sites using GET call on "sites/{siteId}" along with relations parameter
java.util.List<java.lang.Object>	getSiteWithRelations()	Retrieve one site using GET call on "sites/{siteId}" along with relations parameter
RestResponse	rejectSiteMembership(org.alfresco.utility.model.UserModel siteMember)	Reject a site membership request by using POST call /sites/{siteId}/site-membership-requests/{inviteeId}/reject
RestSiteMemberModel	updateSiteMember(org.alfresco.utility.model.UserModel siteMember)	Update site member role with PUT call on "sites/{siteId}/members/{personId}"

Methods inherited from class org.alfresco.rest.requests.ModelRequest

includePath, usingParams

Methods inherited from class java.lang.Object

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

Constructor Detail

Site

public Site(org.alfresco.utility.model.SiteModel site,
            RestWrapper restWrapper)

Method Detail

getSite

public RestSiteModel getSite()
                      throws java.lang.Exception

Retrieve one site using GET call on "sites/{siteId}"

Parameters:

siteId -

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

getSiteWithRelations

public java.util.List<java.lang.Object> getSiteWithRelations()
                                                      throws java.lang.Exception

Retrieve one site using GET call on "sites/{siteId}" along with relations parameter

Parameters:

siteId -

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

getSites

public RestSiteModelsCollection getSites()
                                  throws java.lang.Exception

Retrieve 100 sites (this is the default size when maxItems is not specified) from Alfresco using GET call on TestGroup.SITES

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

getSitesWithRelations

public java.util.List<java.util.List<java.lang.Object>> getSitesWithRelations()
                                                                       throws java.lang.Exception

Retrieve sites using GET call on "sites/{siteId}" along with relations parameter

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

addPerson

public RestSiteMemberModel addPerson(org.alfresco.utility.model.UserModel person)
                              throws java.lang.Exception

Add new site member using POST call on "/sites/{siteId}/members"

Parameters:

person - UserModel

Returns:

Throws:

java.lang.Exception

JsonToModelConversionException

getSiteMembers

public RestSiteMemberModelsCollection getSiteMembers()
                                              throws java.lang.Exception

Retrieve all members of a site using GET call on "sites/{siteId}/members"

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

getSiteMember

public RestSiteMemberModel getSiteMember(org.alfresco.utility.model.UserModel user)
                                  throws java.lang.Exception

Retrieve specific member of a site using GET call on "sites/{siteId}/members/{personId}"

Parameters:

siteId -

personid -

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

updateSiteMember

public RestSiteMemberModel updateSiteMember(org.alfresco.utility.model.UserModel siteMember)
                                     throws java.lang.Exception

Update site member role with PUT call on "sites/{siteId}/members/{personId}"

Parameters:

siteMember -

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

deleteSiteMember

public void deleteSiteMember(org.alfresco.utility.model.UserModel person)
                      throws java.lang.Exception

Delete site member with DELETE call on "sites/{siteId}/members/{personId}"

Parameters:

person -

Throws:

java.lang.Exception

getSiteContainers

public RestSiteContainerModelsCollection getSiteContainers()
                                                    throws java.lang.Exception

Retrieve all containers of a site using GET call on "sites/{siteId}/containers"

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

getSiteContainer

public RestSiteContainerModel getSiteContainer(RestSiteContainerModel container)
                                        throws java.lang.Exception

Retrieve specific container of a site using GET call on "sites/{siteId}/containers/{containerId}"

Parameters:

siteId -

folderId -

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

getSiteContainer

public RestSiteContainerModel getSiteContainer(java.lang.String containerFolder)
                                        throws java.lang.Exception

Retrieve specific container of a site using GET call on "sites/{siteId}/containers/{containerId}"

Parameters:

siteId -

folderId -

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

createSite

public RestSiteModel createSite()
                         throws java.lang.Exception

Create a collaboration site

Parameters:

site - information on the site to create

Returns:

the properties of the created site

Throws:

java.lang.Exception

getSiteMemberships

public RestSitePersonMembershipRequestModelsCollection getSiteMemberships()
                                                                   throws java.lang.Exception

Get site membership requests by using GET /site-membership-requests

Returns:

site memberships

Throws:

java.lang.Exception

approveSiteMembership

public RestResponse approveSiteMembership(org.alfresco.utility.model.UserModel siteMember)
                                   throws java.lang.Exception

Approve a site membership request by using POST call on /sites/{siteId}/site-membership-requests/{inviteeId}/approve

Parameters:

siteMember -

Throws:

java.lang.Exception

rejectSiteMembership

public RestResponse rejectSiteMembership(org.alfresco.utility.model.UserModel siteMember)
                                  throws java.lang.Exception

Reject a site membership request by using POST call /sites/{siteId}/site-membership-requests/{inviteeId}/reject

Parameters:

siteMember -

Throws:

java.lang.Exception