Package 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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
protected SiteUpdate
create
(List<Site> entity, Parameters parameters) Create the given site.void
delete
(String siteId, Parameters parameters) Delete the given site.readAll
(Parameters parameters) Returns a paged list of all sites in the current tenant.readById
(String siteId, Parameters parameters) Returns information regarding the site 'siteId'.void
update
(String siteId, Site site, Parameters parameters) Update the given site.
-
Constructor Details
-
SiteEntityResource
public SiteEntityResource()
-
-
Method Details
-
setSites
-
afterPropertiesSet
public void afterPropertiesSet()- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
-
readAll
Returns a paged list of all sites in the current tenant.- Specified by:
readAll
in interfaceEntityResourceAction.Read<Site>
- Parameters:
parameters
- - will never be null and will have the PAGING default values
-
readById
Returns information regarding the site 'siteId'.- Specified by:
readById
in interfaceEntityResourceAction.ReadById<Site>
-
delete
Delete the given site.- Specified by:
delete
in interfaceEntityResourceAction.Delete
- Parameters:
siteId
- String id of site.
-
create
Create the given site.- Specified by:
create
in interfaceEntityResourceAction.Create<Site>
- Parameters:
entity
-parameters
-- Returns:
-
update
Update the given site. Not all fields are used, only those as defined in the Open API spec.- Specified by:
update
in interfaceEntityResourceAction.Update<Site>
- Parameters:
siteId
- The site ID (aka short name)site
- Details to use for the updateparameters
-- Returns:
- Updated Site
-
convert
-