inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-31 17:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

RM Console Capabilities:

Browse Source 
* added web script to retrieve the capabilities of the current user, either based on a provided node or the file plan otherwise.
 * updated RM console to use new webscript, was using role webscript which doesn't accurately show what a user can do, nor include unassignable capabilites that can be used for convenience.
 * added unassignable, composite capability 'AuditAdmin'
 * protected audit console with new capability, this means users with only DeleteAudit (for example) can now see the management console.
 * related to RM-186



git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/modules/recordsmanagement/BRANCHES/V2.0@37057 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Roy Wetherall
2012-05-28 07:53:10 +00:00
parent 3425415e72
commit 35bbdb09b0
6 changed files with 207 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
rm-server/config/alfresco/module/org_alfresco_module_rm/capability/rm-capabilities-audit-context.xml Normal file
View File

@@ -0,0 +1,62 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>
<beans>
<!-- Assignable Capabilities -->
<bean id="rmAccessAuditCapability"
parent="declarativeCapability">
<property name="name" value="AccessAudit"/>
<property name="permission" value="AccessAudit"/>
</bean>
<bean id="rmDeclareAuditAsRecordCapability"
parent="declarativeCapability">
<property name="name" value="DeclareAuditAsRecord" />
<property name="permission" value="DeclareAuditAsRecord" />
</bean>
<bean id="rmDeleteAuditCapability"
parent="declarativeCapability">
<property name="name" value="DeleteAudit" />
<property name="permission" value="DeleteAudit" />
</bean>
<bean id="rmEnableDisableAuditByTypesCapability"
parent="declarativeCapability">
<property name="name" value="EnableDisableAuditByTypes" />
<property name="permission" value="EnableDisableAuditByTypes" />
</bean>
<bean id="rmExportAuditCapability"
parent="declarativeCapability">
<property name="name" value="ExportAudit" />
<property name="permission" value="ExportAudit" />
</bean>
<bean id="rmSelectAuditMetadataCapability"
parent="declarativeCapability">
<property name="name" value="SelectAuditMetadata" />
<property name="permission" value="SelectAuditMetadata" />
</bean>
<!-- Non-Assignable Capabilities -->
<bean id="rmAuditAdmin"
parent="compositeCapability">
<property name="name" value="AuditAdmin"/>
<property name="private" value="true"/>
<property name="capabilities">
<list>
<ref bean="rmAccessAuditCapability"/>
<ref bean="rmDeclareAuditAsRecordCapability"/>
<ref bean="rmDeleteAuditCapability"/>
<ref bean="rmEnableDisableAuditByTypesCapability"/>
<ref bean="rmExportAuditCapability"/>
<ref bean="rmSelectAuditMetadataCapability"/>
</list>
</property>
</bean>
</beans>

39
rm-server/config/alfresco/module/org_alfresco_module_rm/rm-capabilities-context.xml
View File

@@ -28,12 +28,6 @@
parent="rmBaseCapability" parent="rmBaseCapability"
class="org.alfresco.module.org_alfresco_module_rm.capability.declarative.CompositeCapability" /> class="org.alfresco.module.org_alfresco_module_rm.capability.declarative.CompositeCapability" />
<bean id="rmAccessAuditCapability"
parent="declarativeCapability">
<property name="name" value="AccessAudit"/>
<property name="permission" value="AccessAudit"/>
</bean>
<bean id="rmAddModifyEventDatesCapability" <bean id="rmAddModifyEventDatesCapability"
parent="declarativeCapability"> parent="declarativeCapability">
<property name="name" value="AddModifyEventDates"/> <property name="name" value="AddModifyEventDates"/>
@@ -148,18 +142,6 @@
</property> </property>
</bean> </bean>
<bean id="rmDeclareAuditAsRecordCapability"
parent="declarativeCapability">
<property name="name" value="DeclareAuditAsRecord" />
<property name="permission" value="DeclareAuditAsRecord" />
</bean>
<bean id="rmDeleteAuditCapability"
parent="declarativeCapability">
<property name="name" value="DeleteAudit" />
<property name="permission" value="DeleteAudit" />
</bean>
<bean id="rmDeleteLinksCapability" <bean id="rmDeleteLinksCapability"
parent="rmBaseCapability" parent="rmBaseCapability"
class="org.alfresco.module.org_alfresco_module_rm.capability.impl.DeleteLinksCapability"> class="org.alfresco.module.org_alfresco_module_rm.capability.impl.DeleteLinksCapability">
@@ -186,18 +168,6 @@
<property name="permission" value="EditSelectionLists" /> <property name="permission" value="EditSelectionLists" />
</bean> </bean>
<bean id="rmEnableDisableAuditByTypesCapability"
parent="declarativeCapability">
<property name="name" value="EnableDisableAuditByTypes" />
<property name="permission" value="EnableDisableAuditByTypes" />
</bean>
<bean id="rmExportAuditCapability"
parent="declarativeCapability">
<property name="name" value="ExportAudit" />
<property name="permission" value="ExportAudit" />
</bean>
<bean id="rmMakeOptionalPropertiesMandatoryCapability" <bean id="rmMakeOptionalPropertiesMandatoryCapability"
parent="declarativeCapability"> parent="declarativeCapability">
<property name="name" value="MakeOptionalParametersMandatory" /> <property name="name" value="MakeOptionalParametersMandatory" />
@@ -253,12 +223,6 @@
</property> </property>
</bean> </bean>
<bean id="rmSelectAuditMetadataCapability"
parent="declarativeCapability">
<property name="name" value="SelectAuditMetadata" />
<property name="permission" value="SelectAuditMetadata" />
</bean>
<bean id="rmTriggerAnEventCapability" <bean id="rmTriggerAnEventCapability"
parent="declarativeCapability"> parent="declarativeCapability">
<property name="name" value="TriggerAnEvent"/> <property name="name" value="TriggerAnEvent"/>
@@ -327,6 +291,9 @@
<!-- Disposition capabilities --> <!-- Disposition capabilities -->
<import resource="classpath:alfresco/module/org_alfresco_module_rm/capability/rm-capabilities-disposition-context.xml"/> <import resource="classpath:alfresco/module/org_alfresco_module_rm/capability/rm-capabilities-disposition-context.xml"/>
<!-- Audit capabilities -->
<import resource="classpath:alfresco/module/org_alfresco_module_rm/capability/rm-capabilities-audit-context.xml"/>
<!-- Group capabilities --> <!-- Group capabilities -->
<import resource="classpath:alfresco/module/org_alfresco_module_rm/capability/rm-capabilities-group-context.xml"/> <import resource="classpath:alfresco/module/org_alfresco_module_rm/capability/rm-capabilities-group-context.xml"/>

9
rm-server/config/alfresco/module/org_alfresco_module_rm/rm-webscript-context.xml
View File

@@ -225,6 +225,15 @@
<property name="recordsManagementSecurityService" ref="RecordsManagementSecurityService"/> <property name="recordsManagementSecurityService" ref="RecordsManagementSecurityService"/>
</bean> </bean>
<!-- Capability API -->
<bean id="webscript.org.alfresco.rma.capability.capabilities.get"
class="org.alfresco.module.org_alfresco_module_rm.script.capability.CapabilitiesGet"
parent="webscript">
<property name="recordsManagementService" ref="RecordsManagementService"/>
<property name="capabilityService" ref="CapabilityService" />
</bean>
<!-- RM Event API--> <!-- RM Event API-->
<bean id="webscript.org.alfresco.rma.admin.rmevent.rmeventtypes.get" class="org.alfresco.module.org_alfresco_module_rm.script.admin.RmEventTypesGet" parent="webscript"> <bean id="webscript.org.alfresco.rma.admin.rmevent.rmeventtypes.get" class="org.alfresco.module.org_alfresco_module_rm.script.admin.RmEventTypesGet" parent="webscript">

10
rm-server/config/alfresco/templates/webscripts/org/alfresco/rma/capability/capabilities.get.desc.xml Normal file
View File

@@ -0,0 +1,10 @@
<webscript>
<shortname>Records Management Capabilities</shortname>
<description>Get the list of capabilities available to the current user on the given node.</description>
<url>/api/node/{store_type}/{store_id}/{id}/capabilities?includeAll={includeAll?}</url>
<url>/api/capabilities?includeAll={includeAll?}</url>
<format default="json">argument</format>
<authentication>user</authentication>
<transaction allow="readonly">required</transaction>
<lifecycle>internal</lifecycle>
</webscript>

11
rm-server/config/alfresco/templates/webscripts/org/alfresco/rma/capability/capabilities.get.json.ftl Normal file
View File

@@ -0,0 +1,11 @@
{
"data" :
{
"capabilities" :
[
<#list capabilities as capability>
"${capability}"<#if capability_has_next>,</#if>
</#list>
]
}
}

111
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/script/capability/CapabilitiesGet.java Normal file
View File

@@ -0,0 +1,111 @@
/*
* Copyright (C) 2005-2011 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.module.org_alfresco_module_rm.script.capability;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletResponse;
import org.alfresco.module.org_alfresco_module_rm.RecordsManagementService;
import org.alfresco.module.org_alfresco_module_rm.capability.Capability;
import org.alfresco.module.org_alfresco_module_rm.capability.CapabilityService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.security.AccessStatus;
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;
public class CapabilitiesGet extends DeclarativeWebScript
{
private RecordsManagementService recordsManagementService;
private CapabilityService capabilityService;
public void setRecordsManagementService(RecordsManagementService recordsManagementService)
{
this.recordsManagementService = recordsManagementService;
}
public void setCapabilityService(CapabilityService capabilityService)
{
this.capabilityService = capabilityService;
}
/**
* @see org.alfresco.repo.web.scripts.content.StreamContent#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, org.springframework.extensions.webscripts.Status, org.springframework.extensions.webscripts.Cache)
*/
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)
{
Map<String, String> templateVars = req.getServiceMatch().getTemplateVars();
String storeType = templateVars.get("store_type");
String storeId = templateVars.get("store_id");
String nodeId = templateVars.get("id");
boolean includePrivate = false;
String includePrivateString = req.getParameter("includeAll");
if (includePrivateString != null)
{
includePrivate = Boolean.parseBoolean(includePrivateString);
}
NodeRef nodeRef = null;
if (storeType != null && storeId != null && nodeId != null)
{
nodeRef = new NodeRef(new StoreRef(storeType, storeId), nodeId);
}
else
{
// we are talking about the file plan node
// TODO we are making the assumption there is only one file plan here!
List<NodeRef> filePlans = recordsManagementService.getFilePlans();
if (filePlans.isEmpty() == true)
{
throw new WebScriptException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "No file plan node has been found.");
}
else if (filePlans.size() != 1)
{
throw new WebScriptException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "More than one file plan has been found.");
}
nodeRef = filePlans.get(0);
}
Map<Capability, AccessStatus> map = capabilityService.getCapabilitiesAccessState(nodeRef, includePrivate);
List<String> list = new ArrayList<String>(map.size());
for (Map.Entry<Capability, AccessStatus> entry : map.entrySet())
{
AccessStatus accessStatus = entry.getValue();
if (AccessStatus.DENIED.equals(accessStatus) == false)
{
Capability capability = entry.getKey();
list.add(capability.getName());
}
}
Map<String, Object> model = new HashMap<String, Object>(1);
model.put("capabilities", list);
return model;
}
}