inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-14 17:58:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged HEAD-BUG-FIX (4.3/Cloud) to HEAD (4.3/Cloud)

Browse Source 
64443: Merged WAT1 (4.3/Cloud) to HEAD-BUG-FIX (4.3/Cloud)
      63040: ACE-493, ACE-538: created site admin Get sites API, which supports pagination.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@64589 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Alan Davis
2014-03-15 02:01:25 +00:00
parent cf882a2480
commit c3a054b969
6 changed files with 367 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
config/alfresco/templates/webscripts/org/alfresco/repository/generic-paged-results.lib.ftl
View File

@@ -48,3 +48,41 @@ Usage:
</#if> </#if>
</#escape> </#escape>
</#macro> </#macro>
<#--
Renders paged results information to conforms to the RESTful APIs standards.
The passed in data object should contain following attributes:
count: The actual number of elements returned
hasMoreItems: True if more items on next page
totalItems: The total result count
skipCount: The number of elements to skip before retrieving the page
maxItems: The number of elements requested to be returned
Usage:
<#import "generic-paged-results.lib.ftl" as gen/>
{
<@gen.standardRestfulPagedResults data=data ; item>
output of the individual item, for example by calling another macro:
<@yourLib.itemJSON item=item />
</@gen.standardRestfulPagedResults>
}
-->
<#macro standardRestfulPagedResults data>
"list" : {
"pagination" : {
"count" : ${data.count?c},
"hasMoreItems" : ${data.hasMoreItems?c},
"totalItems" : ${data.totalItems?c},
"skipCount" :${data.skipCount?c},
"maxItems" : ${data.maxItems?c}
},
"entries" : [{
<#list data.items as item>
"entry" : {
<#nested item>
}
}<#if item_has_next>, {</#if>
</#list>
]
}
</#macro>

8
config/alfresco/templates/webscripts/org/alfresco/repository/site/site-admin-sites.get.desc.xml Normal file
View File

@@ -0,0 +1,8 @@
<webscript>
<shortname>Get sites</shortname>
<description>Get a collection of the sites in the repository accessible to site administrators. The collection can be filtered by name.</description>
<url>/api/admin-sites?nf={namefilter?}&amp;maxItems={maxItems?}&amp;skipCount={skipCount?}&amp;roles={roles?}&amp;</url>
<format default="json">argument</format>
<authentication>user</authentication>
<transaction allow="readonly">required</transaction>
</webscript>

31
config/alfresco/templates/webscripts/org/alfresco/repository/site/site-admin-sites.get.json.ftl Normal file
View File

@@ -0,0 +1,31 @@
<#import "../generic-paged-results.lib.ftl" as gen/>
<#macro siteJSON item>
<#escape x as jsonUtils.encodeJSONString(x)>
"url" : "${url.serviceContext + "/api/sites/" + item.siteInfo.shortName}",
"sitePreset" : "${item.siteInfo.sitePreset}",
"shortName" : "${item.siteInfo.shortName}",
"title" : "${item.siteInfo.title}",
"description" : "${item.siteInfo.description}",
"createdDate" : "${xmldate(item.siteInfo.createdDate)}",
"lastModifiedDate" : "${xmldate(item.siteInfo.lastModifiedDate)}",
"visibility" : "${item.siteInfo.visibility}",
"siteManagers" : [{
<#list item.members as manager>
"entry" : {
"userName" : "${manager.userName}",
"firstName" : "${manager.firstName}",
"lastName" : "${manager.lastName}"
}
}<#if manager_has_next>, {</#if>
</#list>
]
</#escape>
</#macro>
{
<@gen.standardRestfulPagedResults data=data ; item>
<@siteJSON item=item />
</@gen.standardRestfulPagedResults>
}

7
config/alfresco/web-scripts-application-context.xml
View File

@@ -787,6 +787,13 @@
<property name="dictionaryService" ref="DictionaryService"/> <property name="dictionaryService" ref="DictionaryService"/>
</bean> </bean>
<!-- SiteAdmin only: Lists the sites (paged) -->
<bean id="webscript.org.alfresco.repository.site.site-admin-sites.get" class="org.alfresco.repo.web.scripts.site.SiteAdminSitesGet" parent="webscript">
<property name="siteService" ref="SiteService"/>
<property name="nodeService" ref="NodeService"/>
<property name="personService" ref="PersonService"/>
</bean>
<!-- --> <!-- -->
<!-- Node/Document Library REST APIs --> <!-- Node/Document Library REST APIs -->

173
source/java/org/alfresco/repo/web/scripts/site/SiteAdminSitesGet.java Normal file
View File

@@ -0,0 +1,173 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* 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 <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.web.scripts.site;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletResponse;
import org.alfresco.model.ContentModel;
import org.alfresco.query.PagingResults;
import org.alfresco.repo.node.getchildren.FilterProp;
import org.alfresco.repo.node.getchildren.FilterPropString;
import org.alfresco.repo.node.getchildren.FilterPropString.FilterTypeString;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.repo.site.SiteModel;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.security.PersonService;
import org.alfresco.service.cmr.site.SiteInfo;
import org.alfresco.service.cmr.site.SiteService;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.Pair;
import org.alfresco.util.ScriptPagingDetails;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.DeclarativeWebScript;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
import org.springframework.extensions.webscripts.WebScriptRequest;
/**
* This class is the controller for the <i>site-admin-sites.get</i> web script.
*
* @author Jamal Kaabi-Mofrad
*/
public class SiteAdminSitesGet extends DeclarativeWebScript
{
private static final String NAME_FILTER = "nf";
private static final String MAX_ITEMS = "maxItems";
private static final String SKIP_COUNT = "skipCount";
private static final int DEFAULT_MAX_ITEMS_PER_PAGE = 50;
private SiteService siteService;
private NodeService nodeService;
private PersonService personService;
public void setSiteService(SiteService siteService)
{
this.siteService = siteService;
}
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
public void setPersonService(PersonService personService)
{
this.personService = personService;
}
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)
{
// check the current user access rights
if (!siteService.isSiteAdmin(AuthenticationUtil.getFullyAuthenticatedUser()))
{
// Note: security, no message to indicate why
throw new WebScriptException(HttpServletResponse.SC_NOT_FOUND, "Resource no found.");
}
// Create paging
final ScriptPagingDetails paging = new ScriptPagingDetails(getIntParameter(req, MAX_ITEMS,
DEFAULT_MAX_ITEMS_PER_PAGE), getIntParameter(req, SKIP_COUNT, 0));
// request a total count of found items
paging.setRequestTotalCountMax(Integer.MAX_VALUE);
final List<FilterProp> filterProp = getFilterProperties(req.getParameter(NAME_FILTER));
final List<Pair<QName, Boolean>> sortProps = new ArrayList<Pair<QName, Boolean>>();
sortProps.add(new Pair<QName, Boolean>(ContentModel.PROP_NAME, true));
PagingResults<SiteInfo> pagingResults = AuthenticationUtil.runAs(
new AuthenticationUtil.RunAsWork<PagingResults<SiteInfo>>()
{
public PagingResults<SiteInfo> doWork() throws Exception
{
return siteService.listSites(filterProp, sortProps, paging);
}
}, AuthenticationUtil.getAdminUserName());
List<SiteInfo> result = pagingResults.getPage();
List<SiteState> sites = new ArrayList<SiteState>(result.size());
for (SiteInfo info : result)
{
sites.add(SiteState.create(info,
siteService.listMembers(info.getShortName(), null, SiteModel.SITE_MANAGER, 0), nodeService,
personService));
}
Map<String, Object> sitesData = new HashMap<String, Object>(6);
// Site data
sitesData.put("items", sites);
// Paging data
sitesData.put("count", result.size());
sitesData.put("hasMoreItems", pagingResults.hasMoreItems());
sitesData.put("totalItems", (pagingResults.getTotalResultCount() == null ? -1 : pagingResults.getTotalResultCount().getFirst()));
sitesData.put("skipCount", paging.getSkipCount());
sitesData.put("maxItems", paging.getMaxItems());
// Create the model from the site and pagination data
Map<String, Object> model = new HashMap<String, Object>(1);
model.put("data", sitesData);
return model;
}
private int getIntParameter(WebScriptRequest req, String paramName, int defaultValue)
{
String paramString = req.getParameter(paramName);
if (paramString != null)
{
try
{
int param = Integer.valueOf(paramString);
if (param >= 0)
{
return param;
}
}
catch (NumberFormatException e)
{
throw new WebScriptException(HttpServletResponse.SC_BAD_REQUEST, e.getMessage());
}
}
return defaultValue;
}
private List<FilterProp> getFilterProperties(String filter)
{
if (filter == null || filter.isEmpty() || filter.equals("*"))
{
return null;
}
List<FilterProp> filterProps = new ArrayList<FilterProp>();
filterProps.add(new FilterPropString(ContentModel.PROP_NAME, filter, FilterTypeString.STARTSWITH_IGNORECASE));
filterProps.add(new FilterPropString(ContentModel.PROP_TITLE, filter, FilterTypeString.STARTSWITH_IGNORECASE));
return filterProps;
}
}

110
source/java/org/alfresco/repo/web/scripts/site/SiteState.java Normal file
View File

@@ -0,0 +1,110 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* 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 <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.web.scripts.site;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.alfresco.model.ContentModel;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.security.PersonService;
import org.alfresco.service.cmr.site.SiteInfo;
/**
* A simple POJO class for the state of a site. For easier passing to the FTL model.
*
* @author jkaabimofrad
*/
public class SiteState
{
private SiteInfo siteInfo;
private List<MemberState> members;
private SiteState()
{
}
public static SiteState create(SiteInfo siteInfo, Map<String, String> members, NodeService nodeService,
PersonService personService)
{
SiteState result = new SiteState();
result.members = new ArrayList<MemberState>(members.size());
result.siteInfo = siteInfo;
Set<String> siteMembers = members.keySet();
for (String userName : siteMembers)
{
NodeRef person = personService.getPersonOrNull(userName);
if (person != null)
{
String firstName = (String) nodeService.getProperty(person, ContentModel.PROP_FIRSTNAME);
String lastName = (String) nodeService.getProperty(person, ContentModel.PROP_LASTNAME);
result.members.add(new MemberState(userName, firstName, lastName));
}
}
return result;
}
public SiteInfo getSiteInfo()
{
return this.siteInfo;
}
public List<MemberState> getMembers()
{
return this.members;
}
public static class MemberState
{
private String userName;
private String firstName;
private String lastName;
public MemberState(String userName, String firstName, String lastName)
{
this.userName = userName;
this.firstName = firstName;
this.lastName = lastName;
}
public String getUserName()
{
return this.userName;
}
public String getFirstName()
{
return this.firstName;
}
public String getLastName()
{
return this.lastName;
}
}
}