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

RM-2421 (Add PUT method to classify content REST API)

Browse Source 
+review RM

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/modules/recordsmanagement/HEAD@108911 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Tuna Aksoy
2015-07-23 21:15:31 +00:00
parent c6f5d7d718
commit 992a3be30e
6 changed files with 219 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -670,12 +670,20 @@
<property name="securityClearanceService" ref="SecurityClearanceService"/>
</bean>
<!-- Base bean for classify content web scripts -->
<bean id="rmClassifyContentBase" parent="rmBaseWebscript" abstract="true">
<property name="contentClassificationService" ref="ContentClassificationService" />
</bean>
<!-- REST impl for POST classify content -->
<bean id="webscript.org.alfresco.rma.classification.classifycontent.post"
class="org.alfresco.module.org_alfresco_module_rm.script.classification.ClassifyContentPost"
parent="rmBaseWebscript">
<property name="contentClassificationService" ref="contentClassificationService" />
</bean>
parent="rmClassifyContentBase"/>
<!-- REST impl for PUT classify content -->
<bean id="webscript.org.alfresco.rma.classification.classifycontent.put"
class="org.alfresco.module.org_alfresco_module_rm.script.classification.ClassifyContentPut"
parent="rmClassifyContentBase"/>
<!-- REST impl for GET user security clearance -->
<bean id="webscript.org.alfresco.rma.classification.usersecurityclearance.get"

27
rm-server/config/alfresco/templates/webscripts/org/alfresco/rma/classification/classifycontent.put.desc.xml Normal file
View File

@@ -0,0 +1,27 @@
<webscript>
<shortname>Edits a classified content</shortname>
<description><![CDATA[
Edits the classified content.<br/>
<br/>
The body of the pust should be in the form, e.g.<br/>
{<br/>
"classificationLevelId": "aLevelId",<br/>
"classifiedBy": "some person or entity",<br/>
"classificationAgency": "anAgency",<br/>
"classificationReasons": [<br/>
{<br/>
"id": "reason1Id"<br/>
},<br/>
{<br/>
"id": "reason2Id"<br/>
}<br/>
]<br/>
}<br/>
]]>
</description>
<url>/api/node/{store_type}/{store_id}/{id}/classify</url>
<format default="json">argument</format>
<authentication>user</authentication>
<transaction>required</transaction>
<lifecycle>internal</lifecycle>
</webscript>

5
rm-server/config/alfresco/templates/webscripts/org/alfresco/rma/classification/classifycontent.put.json.ftl Normal file
View File

@@ -0,0 +1,5 @@
<#escape x as jsonUtils.encodeJSONString(x)>
{
"success": ${success?string}
}
</#escape>

131
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/script/classification/ClassifyContentBase.java Normal file
View File

@@ -0,0 +1,131 @@
/*
* Copyright (C) 2005-2015 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.classification;
import static org.alfresco.util.WebScriptUtils.getJSONArrayFromJSONObject;
import static org.alfresco.util.WebScriptUtils.getJSONArrayValue;
import static org.alfresco.util.WebScriptUtils.getRequestContentAsJsonObject;
import static org.alfresco.util.WebScriptUtils.getStringValueFromJSONObject;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.alfresco.module.org_alfresco_module_rm.classification.ContentClassificationService;
import org.alfresco.module.org_alfresco_module_rm.script.AbstractRmWebScript;
import org.alfresco.service.cmr.repository.NodeRef;
import org.json.JSONArray;
import org.json.JSONObject;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptRequest;
/**
* Base class for classify content actions
*
* @author Tuna Aksoy
* @since 3.0
*/
public abstract class ClassifyContentBase extends AbstractRmWebScript
{
/** Constants */
public static final String CLASSIFICATION_LEVEL_ID = "classificationLevelId";
public static final String CLASSIFIED_BY = "classifiedBy";
public static final String CLASSIFICATION_AGENCY = "classificationAgency";
public static final String CLASSIFICATION_REASONS = "classificationReasons";
/** The service responsible for classifying content. */
private ContentClassificationService contentClassificationService;
/**
* Get the service responsible for classifying content.
*
* @return the contentClassificationService
*/
protected ContentClassificationService getContentClassificationService()
{
return this.contentClassificationService;
}
/**
* Set the service responsible for classifying content.
*
* @param contentClassificationService The service responsible for classifying content.
*/
public void setContentClassificationService(ContentClassificationService contentClassificationService)
{
this.contentClassificationService = contentClassificationService;
}
/**
* Abstract method which does the action of either
* classifying a content or editing a classified content
*
* @param classificationLevelId The security clearance needed to access the content.
* @param classifiedBy Free-form text identifying who edited the classified content.
* @param classificationAgency The name of the agency responsible for editing the classified content.
* @param classificationReasonIds A non-empty set of ids of reasons for editing the classified content in this way.
* @param document The classified content which will be edited.
*/
protected abstract void doClassifyAction(String classificationLevelId, String classifiedBy, String classificationAgency, Set<String> classificationReasonIds, NodeRef document);
/**
* @see org.springframework.extensions.webscripts.DeclarativeWebScript#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)
{
JSONObject jsonObject = getRequestContentAsJsonObject(req);
String classificationLevelId = getStringValueFromJSONObject(jsonObject, CLASSIFICATION_LEVEL_ID);
String classifiedBy = getStringValueFromJSONObject(jsonObject, CLASSIFIED_BY);
String classificationAgency = getStringValueFromJSONObject(jsonObject, CLASSIFICATION_AGENCY, false, false);
Set<String> classificationReasonIds = getClassificationReasonIds(jsonObject);
NodeRef document = parseRequestForNodeRef(req);
doClassifyAction(classificationLevelId, classifiedBy, classificationAgency, classificationReasonIds, document);
Map<String, Object> model = new HashMap<>(1);
model.put(SUCCESS, true);
return model;
}
/**
* Helper method to get the classification reason ids
*
* @param jsonObject The json object representing the request body
* @return {@link Set}<{@link String}> classification ids
*/
private Set<String> getClassificationReasonIds(JSONObject jsonObject)
{
Set<String> classificationReasonIds = new HashSet<>();
JSONArray classificationReasons = getJSONArrayFromJSONObject(jsonObject, CLASSIFICATION_REASONS);
for (int i = 0; i < classificationReasons.length(); i++)
{
JSONObject classificationReason = (JSONObject) getJSONArrayValue(classificationReasons, i);
classificationReasonIds.add(getStringValueFromJSONObject(classificationReason, ID));
}
return classificationReasonIds;
}
}

77
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/script/classification/ClassifyContentPost.java
View File

@@ -18,24 +18,9 @@
*/
package org.alfresco.module.org_alfresco_module_rm.script.classification;
import static org.alfresco.util.WebScriptUtils.getJSONArrayFromJSONObject;
import static org.alfresco.util.WebScriptUtils.getJSONArrayValue;
import static org.alfresco.util.WebScriptUtils.getRequestContentAsJsonObject;
import static org.alfresco.util.WebScriptUtils.getStringValueFromJSONObject;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.alfresco.module.org_alfresco_module_rm.classification.ContentClassificationService;
import org.alfresco.module.org_alfresco_module_rm.script.AbstractRmWebScript;
import org.alfresco.service.cmr.repository.NodeRef;
import org.json.JSONArray;
import org.json.JSONObject;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptRequest;
/**
* Implementation for Java backed webscript to classify a content.
@@ -43,68 +28,14 @@ import org.springframework.extensions.webscripts.WebScriptRequest;
* @author Tuna Aksoy
* @since 3.0
*/
public class ClassifyContentPost extends AbstractRmWebScript
public class ClassifyContentPost extends ClassifyContentBase
{
/** Constants */
public static final String CLASSIFICATION_LEVEL_ID = "classificationLevelId";
public static final String CLASSIFIED_BY = "classifiedBy";
public static final String CLASSIFICATION_AGENCY = "classificationAgency";
public static final String CLASSIFICATION_REASONS = "classificationReasons";
/** The service responsible for classifying content. */
private ContentClassificationService contentClassificationService;
/**
* Set the service responsible for classifying content.
*
* @param contentClassificationService The service responsible for classifying content.
*/
public void setContentClassificationService(ContentClassificationService contentClassificationService)
{
this.contentClassificationService = contentClassificationService;
}
/**
* @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest,
* org.springframework.extensions.webscripts.Status,
* org.springframework.extensions.webscripts.Cache)
* @see org.alfresco.module.org_alfresco_module_rm.script.classification.ClassifyContentBase#doClassifyAction(java.lang.String, java.lang.String, java.lang.String, java.util.Set, org.alfresco.service.cmr.repository.NodeRef)
*/
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)
protected void doClassifyAction(String classificationLevelId, String classifiedBy, String classificationAgency, Set<String> classificationReasonIds, NodeRef document)
{
JSONObject jsonObject = getRequestContentAsJsonObject(req);
String classificationLevelId = getStringValueFromJSONObject(jsonObject, CLASSIFICATION_LEVEL_ID);
String classifiedBy = getStringValueFromJSONObject(jsonObject, CLASSIFIED_BY);
String classificationAgency = getStringValueFromJSONObject(jsonObject, CLASSIFICATION_AGENCY, false, false);
Set<String> classificationReasonIds = getClassificationReasonIds(jsonObject);
NodeRef document = parseRequestForNodeRef(req);
contentClassificationService.classifyContent(classificationLevelId, classifiedBy, classificationAgency,
classificationReasonIds, document);
Map<String, Object> model = new HashMap<>(1);
model.put(SUCCESS, true);
return model;
}
/**
* Helper method to get the classification reason ids
*
* @param jsonObject The json object representing the request body
* @return {@link Set}<{@link String}> classification ids
*/
private Set<String> getClassificationReasonIds(JSONObject jsonObject)
{
Set<String> classificationReasonIds = new HashSet<>();
JSONArray classificationReasons = getJSONArrayFromJSONObject(jsonObject, CLASSIFICATION_REASONS);
for (int i = 0; i < classificationReasons.length(); i++)
{
JSONObject classificationReason = (JSONObject) getJSONArrayValue(classificationReasons, i);
classificationReasonIds.add(getStringValueFromJSONObject(classificationReason, ID));
}
return classificationReasonIds;
getContentClassificationService().classifyContent(classificationLevelId, classifiedBy, classificationAgency, classificationReasonIds, document);
}
}

41
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/script/classification/ClassifyContentPut.java Normal file
View File

@@ -0,0 +1,41 @@
/*
* 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.module.org_alfresco_module_rm.script.classification;
import java.util.Set;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* Implementation for Java backed webscript to edit a classified content.
*
* @author Tuna Aksoy
* @since 3.0
*/
public class ClassifyContentPut extends ClassifyContentBase
{
/**
* @see org.alfresco.module.org_alfresco_module_rm.script.classification.ClassifyContentBase#doClassifyAction(java.lang.String, java.lang.String, java.lang.String, java.util.Set, org.alfresco.service.cmr.repository.NodeRef)
*/
@Override
protected void doClassifyAction(String classificationLevelId, String classifiedBy, String classificationAgency, Set<String> classificationReasonIds, NodeRef document)
{
getContentClassificationService().editClassifiedContent(classificationLevelId, classifiedBy, classificationAgency, classificationReasonIds, document);
}
}