/*
* #%L
* Alfresco Remote API
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see .
* #L%
*/
package org.alfresco.rest.api.sites;
import org.alfresco.query.PagingResults;
import org.alfresco.rest.api.Sites;
import org.alfresco.rest.api.model.SiteContainer;
import org.alfresco.rest.framework.WebApiDescription;
import org.alfresco.rest.framework.resource.RelationshipResource;
import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction;
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
import org.alfresco.rest.framework.resource.parameters.Parameters;
import org.alfresco.util.ParameterCheck;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.InitializingBean;
@RelationshipResource(name = "containers", entityResource = SiteEntityResource.class, title = "Site Containers")
public class SiteContainersRelation implements RelationshipResourceAction.Read, RelationshipResourceAction.ReadById, InitializingBean
{
private static final Log logger = LogFactory.getLog(SiteContainersRelation.class);
private Sites sites;
public void setSites(Sites sites)
{
this.sites = sites;
}
@Override
public void afterPropertiesSet()
{
ParameterCheck.mandatory("sites", this.sites);
}
/**
* Returns information regarding the top level container 'containerId' for site 'siteId'.
*
*/
@Override
@WebApiDescription(title = "Site container information for container 'containerId' in site 'siteId'.")
public SiteContainer readById(String siteId, String containerId, Parameters parameters)
{
return sites.getSiteContainer(siteId, containerId);
}
/**
* Returns information regarding the top level containers for site 'siteId'.
*
*/
@Override
@WebApiDescription(title = "A paged list of site containers.")
public CollectionWithPagingInfo readAll(String siteId, Parameters parameters)
{
PagingResults siteContainers = sites.getSiteContainers(siteId, parameters.getPaging());
return CollectionWithPagingInfo.asPaged(parameters.getPaging(), siteContainers.getPage(), siteContainers.hasMoreItems(), siteContainers.getTotalResultCount().getFirst());
}
}