org.alfresco.rest.api.sites

Class SiteEntityResource

java.lang.Object

org.alfresco.rest.api.sites.SiteEntityResource

All Implemented Interfaces:

EntityResourceAction.Create<Site>, EntityResourceAction.Delete, EntityResourceAction.Read<Site>, EntityResourceAction.ReadById<Site>, EntityResourceAction.Update<Site>, ResourceAction, org.springframework.beans.factory.InitializingBean

@EntityResource(name="sites",
                title="Sites")
public class SiteEntityResource
extends Object
implements EntityResourceAction.Read<Site>, EntityResourceAction.ReadById<Site>, EntityResourceAction.Delete, EntityResourceAction.Create<Site>, EntityResourceAction.Update<Site>, org.springframework.beans.factory.InitializingBean

An implementation of an Entity Resource for a Site

Author:

Gethin James, steveglover, janv

Constructor Summary

Constructors

Constructor and Description
SiteEntityResource()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected SiteUpdate	convert(Site site)
List<Site>	create(List<Site> entity, Parameters parameters) Create the given site.
void	delete(String siteId, Parameters parameters) Delete the given site.
CollectionWithPagingInfo<Site>	readAll(Parameters parameters) Returns a paged list of all sites in the current tenant.
Site	readById(String siteId, Parameters parameters) Returns information regarding the site 'siteId'.
void	setSites(Sites sites)
Site	update(String siteId, Site site, Parameters parameters) Update the given site.

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteEntityResource

public SiteEntityResource()

Method Detail

setSites

public void setSites(Sites sites)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

readAll

public CollectionWithPagingInfo<Site> readAll(Parameters parameters)

Returns a paged list of all sites in the current tenant.

Specified by:

readAll in interface EntityResourceAction.Read<Site>

Parameters:

parameters - - will never be null and will have the PAGING default values

readById

public Site readById(String siteId,
                     Parameters parameters)

Returns information regarding the site 'siteId'.

Specified by:

readById in interface EntityResourceAction.ReadById<Site>

delete

public void delete(String siteId,
                   Parameters parameters)

Delete the given site.

Specified by:

delete in interface EntityResourceAction.Delete

Parameters:

siteId - String id of site.

create

public List<Site> create(List<Site> entity,
                         Parameters parameters)

Create the given site.

Specified by:

create in interface EntityResourceAction.Create<Site>

Parameters:

entity -

parameters -

Returns:

update

public Site update(String siteId,
                   Site site,
                   Parameters parameters)

Update the given site. Not all fields are used, only those as defined in the Open API spec.

Specified by:

update in interface EntityResourceAction.Update<Site>

Parameters:

siteId - The site ID (aka short name)

site - Details to use for the update

parameters -

Returns:

Updated Site

convert

protected SiteUpdate convert(Site site)