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 DEV/FORMS-REFACTOR branch to HEAD

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@14000 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Gavin Cornwell
2009-04-18 22:42:15 +00:00
parent 695f606034
commit c379051889
14 changed files with 1044 additions and 879 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
config/alfresco/templates/webscripts/org/alfresco/repository/forms/form.lib.ftl → config/alfresco/templates/webscripts/org/alfresco/repository/forms/definition.lib.ftl
View File

@@ -1,4 +1,4 @@
<#macro formJSON form> <#macro formDefJSON form>
<#escape x as jsonUtils.encodeJSONString(x)> <#escape x as jsonUtils.encodeJSONString(x)>
{ {
"data" : "data" :

9
config/alfresco/templates/webscripts/org/alfresco/repository/forms/definition.post.desc.xml Normal file
View File

@@ -0,0 +1,9 @@
<webscript>
<shortname>Form Definition</shortname>
<description>Returns a form definition for the requested item</description>
<url>/api/form/definition/{item_kind}/{item_id}</url>
<format default="json"/>
<authentication>user</authentication>
<transaction>required</transaction>
<lifecycle>internal</lifecycle>
</webscript>

2
config/alfresco/templates/webscripts/org/alfresco/repository/forms/definition.post.json.ftl Normal file
View File

@@ -0,0 +1,2 @@
<#import "definition.lib.ftl" as formDefLib/>
<@formDefLib.formDefJSON form=form/>

149
config/alfresco/templates/webscripts/org/alfresco/repository/forms/definition.post.json.js Normal file
View File

@@ -0,0 +1,149 @@
function main()
{
// Extract template args
var itemKind = url.templateArgs['item_kind'];
var itemId = url.templateArgs['item_id'];
if (logger.isLoggingEnabled())
{
logger.log("itemKind = " + itemKind);
logger.log("itemId = " + itemId);
}
// TODO: Return error if item kind and/or id is missing?
// extract optional data from request body (if present)
var count = 0;
var fields = null;
if (json.has("fields"))
{
// convert the JSONArray object into a native JavaScript array
fields = [];
var jsonFields = json.get("fields");
var numFields = jsonFields.length();
for (count = 0; count < numFields; count++)
{
fields.push(jsonFields.get(count));
}
if (logger.isLoggingEnabled())
logger.log("fields = " + fields);
}
var forcedFields = null;
if (json.has("force"))
{
// convert the JSONArray object into a native JavaScript array
forcedFields = [];
var jsonForcedFields = json.get("force");
var numForcedFields = jsonForcedFields.length();
for (count = 0; count < numForcedFields; count++)
{
forcedFields.push(jsonForcedFields.get(count));
}
if (logger.isLoggingEnabled())
logger.log("forcedFields = " + forcedFields);
}
var formScriptObj = null;
try
{
// attempt to get the form for the item
formScriptObj = formService.getForm(itemKind, itemId, fields, forcedFields);
}
catch (error)
{
var msg = error.message;
if (logger.isLoggingEnabled())
logger.log(msg);
// determine if the exception was a FormNotFoundException, if so return
// 404 status code otherwise return 500
if (msg.indexOf("FormNotFoundException") != -1)
{
status.setCode(404, msg);
if (logger.isLoggingEnabled())
logger.log("Returning 404 status code");
}
else
{
status.setCode(500, msg);
if (logger.isLoggingEnabled())
logger.log("Returning 500 status code");
}
return;
}
var formModel = {};
formModel.data = {};
// TODO: retrieve the item URL from the response?
formModel.data.item = '/api/form/definition/' + itemKind + '/' + itemId;
// TODO: look for overridden submission url
formModel.data.submissionUrl = '/api/form/' + itemKind + '/' + itemId;
formModel.data.type = formScriptObj.type;
formModel.data.definition = {};
formModel.data.definition.fields = [];
// We're explicitly listing the object fields of FieldDefinition.java and its subclasses here.
// I don't see a way to get these dynamically at runtime.
var supportedBaseFieldNames = ['name', 'label', 'description', 'binding',
'defaultValue', 'group', 'protectedField'];
var supportedPropertyFieldNames = ['dataType', 'mandatory',
'repeats', 'constraints'];
var supportedAssociationFieldNames = ['endpointType', 'endpointDirection',
'endpointMandatory', 'endpointMany'];
var allSupportedFieldNames = supportedBaseFieldNames
.concat(supportedPropertyFieldNames)
.concat(supportedAssociationFieldNames);
var fieldDefs = formScriptObj.fieldDefinitions;
for (var x = 0; x < fieldDefs.length; x++)
{
var fieldDef = fieldDefs[x];
var field = {};
for (var i = 0; i < allSupportedFieldNames.length; i++)
{
var nextSupportedName = allSupportedFieldNames[i];
var nextValue = fieldDef[nextSupportedName];
if (nextValue != null)
{
field[nextSupportedName] = nextValue;
}
}
field.type = (fieldDef.dataType != null) ? "property" : "association";
formModel.data.definition.fields.push(field);
}
formModel.data.formData = {};
for (var k in formScriptObj.formData.data)
{
var value = formScriptObj.formData.data[k].value;
if (value instanceof java.util.Date)
{
formModel.data.formData[k.replace(/:/g, "_")] = utils.toISO8601(value);
}
// There is no need to handle java.util.List instances here as they are
// returned from ScriptFormData.java as Strings
else
{
formModel.data.formData[k.replace(/:/g, "_")] = value;
}
}
model.form = formModel;
}
main();

10
config/alfresco/templates/webscripts/org/alfresco/repository/forms/form.get.desc.xml
View File

@@ -1,10 +0,0 @@
<webscript>
<shortname>Form</shortname>
<description>Get a form to view or edit the metadata of a given node.</description>
<url>/api/forms/node/{store_type}/{store_id}/{id}</url>
<url>/api/forms/node/{path}</url>
<format default="json"/>
<authentication>user</authentication>
<transaction>required</transaction>
<lifecycle>internal</lifecycle>
</webscript>

111
config/alfresco/templates/webscripts/org/alfresco/repository/forms/form.get.js
View File

@@ -1,111 +0,0 @@
function main()
{
// Extract template args
var ta_storeType = url.templateArgs['store_type'];
var ta_storeId = url.templateArgs['store_id'];
var ta_id = url.templateArgs['id'];
var ta_path = url.templateArgs['path'];
if (logger.isLoggingEnabled())
{
logger.log("ta_storeType = " + ta_storeType);
logger.log("ta_storeId = " + ta_storeId);
logger.log("ta_id = " + ta_id);
logger.log("ta_path = " + ta_path);
}
var formUrl = '';
// The template argument 'path' only appears in the second URI template.
if (ta_path != null)
{
//TODO Need to test this path.
formUrl = ta_path;
}
else
{
formUrl = ta_storeType + '://' + ta_storeId + '/' + ta_id;
}
if (logger.isLoggingEnabled())
{
logger.log("formUrl = " + formUrl);
}
var formScriptObj = formService.getForm(formUrl);
if (formScriptObj == null)
{
var message = "The form for item \"" + formUrl + "\" could not be found.";
if (logger.isWarnLoggingEnabled())
{
logger.warn(message);
}
status.setCode(404, message);
return;
}
var formModel = {};
formModel.data = {};
formModel.data.item = '/api/node/' + ta_storeType + '/' + ta_storeId + '/' + ta_id;
formModel.data.submissionUrl = '/api/forms/node/' + ta_storeType + '/' + ta_storeId + '/' + ta_id;
formModel.data.type = formScriptObj.type;
formModel.data.definition = {};
formModel.data.definition.fields = [];
// We're explicitly listing the object fields of FieldDefinition.java and its subclasses here.
// I don't see a way to get these dynamically at runtime.
var supportedBaseFieldNames = ['name', 'label', 'description', 'binding',
'defaultValue', 'group', 'protectedField'];
var supportedPropertyFieldNames = ['dataType', 'mandatory',
'repeats', 'constraints'];
var supportedAssociationFieldNames = ['endpointType', 'endpointDirection',
'endpointMandatory', 'endpointMany'];
var allSupportedFieldNames = supportedBaseFieldNames
.concat(supportedPropertyFieldNames)
.concat(supportedAssociationFieldNames);
var fieldDefs = formScriptObj.fieldDefinitions;
for (var x = 0; x < fieldDefs.length; x++)
{
var fieldDef = fieldDefs[x];
var field = {};
for (var i = 0; i < allSupportedFieldNames.length; i++)
{
var nextSupportedName = allSupportedFieldNames[i];
var nextValue = fieldDef[nextSupportedName];
if (nextValue != null)
{
field[nextSupportedName] = nextValue;
}
}
field.type = (fieldDef.dataType != null) ? "property" : "association";
formModel.data.definition.fields.push(field);
}
formModel.data.formData = {};
for (var k in formScriptObj.formData.data)
{
var value = formScriptObj.formData.data[k].value;
if (value instanceof java.util.Date)
{
formModel.data.formData[k.replace(/:/g, "_")] = utils.toISO8601(value);
}
// There is no need to handle java.util.List instances here as they are
// returned from ScriptFormData.java as Strings
else
{
formModel.data.formData[k.replace(/:/g, "_")] = value;
}
}
model.form = formModel;
}
main();

2
config/alfresco/templates/webscripts/org/alfresco/repository/forms/form.get.json.ftl
View File

@@ -1,2 +0,0 @@
<#import "form.lib.ftl" as formLib/>
<@formLib.formJSON form=form/>

3
config/alfresco/templates/webscripts/org/alfresco/repository/forms/form.post.desc.xml
View File

@@ -1,8 +1,7 @@
<webscript> <webscript>
<shortname>Form</shortname> <shortname>Form</shortname>
<description>Handles the submission of a form</description> <description>Handles the submission of a form</description>
<url>/api/forms/node/{store_type}/{store_id}/{id}</url> <url>/api/form/{item_kind}/{item_id}</url>
<url>/api/forms/node/{path}</url>
<authentication>user</authentication> <authentication>user</authentication>
<transaction>required</transaction> <transaction>required</transaction>
<lifecycle>internal</lifecycle> <lifecycle>internal</lifecycle>

66
config/alfresco/templates/webscripts/org/alfresco/repository/forms/form.post.js
View File

@@ -1,35 +1,19 @@
function main() function main()
{ {
var ta_storeType = url.templateArgs['store_type']; // Extract template args
var ta_storeId = url.templateArgs['store_id']; var itemKind = url.templateArgs['item_kind'];
var ta_id = url.templateArgs['id']; var itemId = url.templateArgs['item_id'];
var ta_mode = url.templateArgs['mode'];
var ta_path = url.templateArgs['path'];
var nodeRef = '';
// The template argument 'path' only appears in the second URI template.
if (ta_path != null)
{
nodeRef = ta_path;
}
else
{
nodeRef = ta_storeType + '://' + ta_storeId + '/' + ta_id;
}
if (logger.isLoggingEnabled()) if (logger.isLoggingEnabled())
{ {
logger.log("POST request received for nodeRef: " + nodeRef); logger.log("itemKind = " + itemKind);
logger.log("itemId = " + itemId);
} }
// TODO: Return error if item kind and/or id is missing?
try
{
// TODO: check the given nodeRef is real
// persist the submitted data using the most appropriate data set // persist the submitted data using the most appropriate data set
if (typeof formdata !== "undefined") if (typeof formdata !== "undefined")
{ {
@@ -52,7 +36,7 @@ function main()
repoFormData.addData(alteredName, formdata.fields[i].value); repoFormData.addData(alteredName, formdata.fields[i].value);
} }
formService.saveForm(nodeRef, repoFormData); formService.saveForm(itemKind, itemId, repoFormData);
} }
else else
{ {
@@ -60,10 +44,38 @@ function main()
{ {
logger.log("Saving form with args = " + args); logger.log("Saving form with args = " + args);
} }
formService.saveForm(nodeRef, args);
formService.saveForm(itemKind, itemId, args);
}
}
catch (error)
{
var msg = error.message;
if (logger.isLoggingEnabled())
logger.log(msg);
// determine if the exception was a FormNotFoundException, if so return
// 404 status code otherwise return 500
if (msg.indexOf("FormNotFoundException") != -1)
{
status.setCode(404, msg);
if (logger.isLoggingEnabled())
logger.log("Returning 404 status code");
}
else
{
status.setCode(500, msg);
if (logger.isLoggingEnabled())
logger.log("Returning 500 status code");
} }
model.message = "Successfully updated node " + nodeRef; return;
}
model.message = "Successfully updated item [" + itemKind + "]" + itemId;
} }
main(); main();

59
config/alfresco/templates/webscripts/org/alfresco/repository/forms/form.post.json.js
View File

@@ -1,29 +1,16 @@
function main() function main()
{ {
var ta_storeType = url.templateArgs['store_type']; // Extract template args
var ta_storeId = url.templateArgs['store_id']; var itemKind = url.templateArgs['item_kind'];
var ta_id = url.templateArgs['id']; var itemId = url.templateArgs['item_id'];
var ta_mode = url.templateArgs['mode'];
var ta_path = url.templateArgs['path'];
var nodeRef = '';
// The template argument 'path' only appears in the second URI template.
if (ta_path != null)
{
nodeRef = ta_path;
}
else
{
nodeRef = ta_storeType + '://' + ta_storeId + '/' + ta_id;
}
if (logger.isLoggingEnabled()) if (logger.isLoggingEnabled())
{ {
logger.log("JSON POST request received for nodeRef: " + nodeRef); logger.log("itemKind = " + itemKind);
logger.log("itemId = " + itemId);
} }
//TODO Add check whether nodeRef exists. // TODO: Return error if item kind and/or id is missing?
if (typeof json !== "undefined") if (typeof json !== "undefined")
{ {
@@ -37,6 +24,7 @@ function main()
{ {
logger.warn("json object was undefined."); logger.warn("json object was undefined.");
} }
status.setCode(501, message); status.setCode(501, message);
return; return;
} }
@@ -51,9 +39,38 @@ function main()
repoFormData.addData(alteredKey, json.get(nextKey)); repoFormData.addData(alteredKey, json.get(nextKey));
} }
formService.saveForm(nodeRef, repoFormData); try
{
formService.saveForm(itemKind, itemId, repoFormData);
}
catch (error)
{
var msg = error.message;
model.message = "Successfully updated node " + nodeRef; if (logger.isLoggingEnabled())
logger.log(msg);
// determine if the exception was a FormNotFoundException, if so return
// 404 status code otherwise return 500
if (msg.indexOf("FormNotFoundException") != -1)
{
status.setCode(404, msg);
if (logger.isLoggingEnabled())
logger.log("Returning 404 status code");
}
else
{
status.setCode(500, msg);
if (logger.isLoggingEnabled())
logger.log("Returning 500 status code");
}
return;
}
model.message = "Successfully updated item [" + itemKind + "]" + itemId;
} }
main(); main();

4
config/alfresco/templates/webscripts/org/alfresco/repository/forms/form.post.xwwwformurlencoded.js
View File

@@ -3,12 +3,12 @@ function main()
// FIXME URL-encoded post of forms data is not yet working. // FIXME URL-encoded post of forms data is not yet working.
if (logger.isLoggingEnabled()) if (logger.isLoggingEnabled())
{ {
logger.log("x-www-form-urlencoded request received for nodeRef"); logger.log("x-www-form-urlencoded request received");
logger.log("decodedparams: " + decodedparams); logger.log("decodedparams: " + decodedparams);
} }
model.message = "Successfully updated node " + "nodeRef"; model.message = "Successfully updated item";
} }
main(); main();

28
source/java/org/alfresco/repo/web/scripts/forms/AbstractTestFormRestApi.java
View File

@@ -49,9 +49,13 @@ import org.alfresco.web.scripts.TestWebScriptServer.Response;
public abstract class AbstractTestFormRestApi extends BaseWebScriptTest public abstract class AbstractTestFormRestApi extends BaseWebScriptTest
{ {
protected static final String APPLICATION_JSON = "application/json";
protected static final String TEST_FORM_DESCRIPTION = "Test form description"; protected static final String TEST_FORM_DESCRIPTION = "Test form description";
protected static final String TEST_FORM_TITLE = "Test form title"; protected static final String TEST_FORM_TITLE = "Test form title";
protected String referencingNodeUrl; protected String referencingNodeDefUrl;
protected String referencingNodeUpdateUrl;
protected String containingNodeDefUrl;
protected String containingNodeUpdateUrl;
protected String containingNodeUrl; protected String containingNodeUrl;
protected NodeRef referencingDocNodeRef; protected NodeRef referencingDocNodeRef;
protected Map<QName, Serializable> refNodePropertiesAfterCreation; protected Map<QName, Serializable> refNodePropertiesAfterCreation;
@@ -148,17 +152,27 @@ public abstract class AbstractTestFormRestApi extends BaseWebScriptTest
// The other childDoc nodes will be added as children over the REST API as part // The other childDoc nodes will be added as children over the REST API as part
// of later test code. // of later test code.
// Create and store the url to the referencingNode // Create and store the urls to the referencingNode
StringBuilder builder = new StringBuilder(); StringBuilder builder = new StringBuilder();
builder.append("/api/forms/node/workspace/").append(referencingDocNodeRef.getStoreRef().getIdentifier()) builder.append("/api/form/definition/node/workspace/").append(referencingDocNodeRef.getStoreRef().getIdentifier())
.append("/").append(referencingDocNodeRef.getId()); .append("/").append(referencingDocNodeRef.getId());
this.referencingNodeUrl = builder.toString(); this.referencingNodeDefUrl = builder.toString();
// Create and store the url to the containing node
builder = new StringBuilder(); builder = new StringBuilder();
builder.append("/api/forms/node/workspace/").append(containerNodeRef.getStoreRef().getIdentifier()) builder.append("/api/form/node/workspace/").append(referencingDocNodeRef.getStoreRef().getIdentifier())
.append("/").append(referencingDocNodeRef.getId());
this.referencingNodeUpdateUrl = builder.toString();
// Create and store the urls to the containing node
builder = new StringBuilder();
builder.append("/api/form/definition/node/workspace/").append(containerNodeRef.getStoreRef().getIdentifier())
.append("/").append(containerNodeRef.getId()); .append("/").append(containerNodeRef.getId());
this.containingNodeUrl = builder.toString(); this.containingNodeDefUrl = builder.toString();
builder = new StringBuilder();
builder.append("/api/form/node/workspace/").append(containerNodeRef.getStoreRef().getIdentifier())
.append("/").append(containerNodeRef.getId());
this.containingNodeUpdateUrl = builder.toString();
// Store the original properties of this node // Store the original properties of this node
this.refNodePropertiesAfterCreation = nodeService.getProperties(referencingDocNodeRef); this.refNodePropertiesAfterCreation = nodeService.getProperties(referencingDocNodeRef);

103
source/java/org/alfresco/repo/web/scripts/forms/FormRestApiGet_Test.java
View File

@@ -28,30 +28,41 @@ import java.util.ArrayList;
import java.util.Iterator; import java.util.Iterator;
import java.util.List; import java.util.List;
import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.web.scripts.TestWebScriptServer.PostRequest;
import org.alfresco.web.scripts.TestWebScriptServer.Response; import org.alfresco.web.scripts.TestWebScriptServer.Response;
import org.alfresco.web.scripts.json.JSONUtils; import org.alfresco.web.scripts.json.JSONUtils;
import org.json.JSONArray; import org.json.JSONArray;
import org.json.JSONObject; import org.json.JSONObject;
import org.json.JSONTokener; import org.json.JSONTokener;
public class FormRestApiGet_Test extends AbstractTestFormRestApi { public class FormRestApiGet_Test extends AbstractTestFormRestApi
{
public void testResponseContentType() throws Exception public void testResponseContentType() throws Exception
{ {
Response rsp = sendGetReq(referencingNodeUrl, 200); JSONObject jsonPostData = new JSONObject();
String jsonPostString = jsonPostData.toString();
Response rsp = sendRequest(new PostRequest(referencingNodeDefUrl,
jsonPostString, APPLICATION_JSON), 200);
assertEquals("application/json;charset=UTF-8", rsp.getContentType()); assertEquals("application/json;charset=UTF-8", rsp.getContentType());
} }
public void testGetFormForNonExistentNode() throws Exception public void testGetFormForNonExistentNode() throws Exception
{ {
// Replace all digits with an 'x' char - this should make for a non-existent node. // Replace all digits with an 'x' char - this should make for a non-existent node.
Response rsp = sendGetReq(referencingNodeUrl.replaceAll("\\d", "x"), 404); JSONObject jsonPostData = new JSONObject();
String jsonPostString = jsonPostData.toString();
Response rsp = sendRequest(new PostRequest(referencingNodeDefUrl.replaceAll("\\d", "x"),
jsonPostString, APPLICATION_JSON), 404);
assertEquals("application/json;charset=UTF-8", rsp.getContentType()); assertEquals("application/json;charset=UTF-8", rsp.getContentType());
} }
public void testJsonContentParsesCorrectly() throws Exception public void testJsonContentParsesCorrectly() throws Exception
{ {
Response rsp = sendGetReq(referencingNodeUrl, 200); JSONObject jsonPostData = new JSONObject();
String jsonPostString = jsonPostData.toString();
Response rsp = sendRequest(new PostRequest(referencingNodeDefUrl,
jsonPostString, APPLICATION_JSON), 200);
String jsonResponseString = rsp.getContentAsString(); String jsonResponseString = rsp.getContentAsString();
Object jsonObject = new JSONUtils().toObject(jsonResponseString); Object jsonObject = new JSONUtils().toObject(jsonResponseString);
@@ -60,7 +71,10 @@ public class FormRestApiGet_Test extends AbstractTestFormRestApi {
public void testJsonUpperStructure() throws Exception public void testJsonUpperStructure() throws Exception
{ {
Response rsp = sendGetReq(referencingNodeUrl, 200); JSONObject jsonPostData = new JSONObject();
String jsonPostString = jsonPostData.toString();
Response rsp = sendRequest(new PostRequest(referencingNodeDefUrl,
jsonPostString, APPLICATION_JSON), 200);
String jsonResponseString = rsp.getContentAsString(); String jsonResponseString = rsp.getContentAsString();
JSONObject jsonParsedObject = new JSONObject(new JSONTokener(jsonResponseString)); JSONObject jsonParsedObject = new JSONObject(new JSONTokener(jsonResponseString));
@@ -87,7 +101,10 @@ public class FormRestApiGet_Test extends AbstractTestFormRestApi {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public void testJsonFormData() throws Exception public void testJsonFormData() throws Exception
{ {
Response rsp = sendGetReq(referencingNodeUrl, 200); JSONObject jsonPostData = new JSONObject();
String jsonPostString = jsonPostData.toString();
Response rsp = sendRequest(new PostRequest(referencingNodeDefUrl,
jsonPostString, APPLICATION_JSON), 200);
String jsonResponseString = rsp.getContentAsString(); String jsonResponseString = rsp.getContentAsString();
// At this point the formData names have underscores // At this point the formData names have underscores
@@ -118,7 +135,10 @@ public class FormRestApiGet_Test extends AbstractTestFormRestApi {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public void testJsonDefinitionFields() throws Exception public void testJsonDefinitionFields() throws Exception
{ {
Response rsp = sendGetReq(referencingNodeUrl, 200); JSONObject jsonPostData = new JSONObject();
String jsonPostString = jsonPostData.toString();
Response rsp = sendRequest(new PostRequest(referencingNodeDefUrl,
jsonPostString, APPLICATION_JSON), 200);
String jsonResponseString = rsp.getContentAsString(); String jsonResponseString = rsp.getContentAsString();
JSONObject jsonParsedObject = new JSONObject(new JSONTokener(jsonResponseString)); JSONObject jsonParsedObject = new JSONObject(new JSONTokener(jsonResponseString));
@@ -149,4 +169,71 @@ public class FormRestApiGet_Test extends AbstractTestFormRestApi {
} }
} }
} }
public void testJsonSelectedFields() throws Exception
{
JSONObject jsonPostData = new JSONObject();
JSONArray jsonFields = new JSONArray();
jsonFields.put("cm:name");
jsonFields.put("cm:title");
jsonFields.put("cm:publisher");
jsonPostData.put("fields", jsonFields);
// Submit the JSON request.
String jsonPostString = jsonPostData.toString();
Response rsp = sendRequest(new PostRequest(referencingNodeDefUrl, jsonPostString,
APPLICATION_JSON), 200);
String jsonResponseString = rsp.getContentAsString();
JSONObject jsonParsedObject = new JSONObject(new JSONTokener(jsonResponseString));
assertNotNull(jsonParsedObject);
JSONObject rootDataObject = (JSONObject)jsonParsedObject.get("data");
JSONObject definitionObject = (JSONObject)rootDataObject.get("definition");
JSONArray fieldsArray = (JSONArray)definitionObject.get("fields");
assertEquals("Expected 2 fields", 2, fieldsArray.length());
// get the data and check it
JSONObject formDataObject = (JSONObject)rootDataObject.get("formData");
assertNotNull("Expected to find cm:name data", formDataObject.get("prop_cm_name"));
assertNotNull("Expected to find cm:title data", formDataObject.get("prop_cm_title"));
assertEquals(TEST_FORM_TITLE, formDataObject.get("prop_cm_title"));
}
public void testJsonForcedFields() throws Exception
{
JSONObject jsonPostData = new JSONObject();
JSONArray jsonFields = new JSONArray();
jsonFields.put("cm:name");
jsonFields.put("cm:title");
jsonFields.put("cm:publisher");
jsonFields.put("cm:wrong");
jsonPostData.put("fields", jsonFields);
JSONArray jsonForcedFields = new JSONArray();
jsonForcedFields.put("cm:publisher");
jsonForcedFields.put("cm:wrong");
jsonPostData.put("force", jsonForcedFields);
// Submit the JSON request.
String jsonPostString = jsonPostData.toString();
Response rsp = sendRequest(new PostRequest(referencingNodeDefUrl, jsonPostString,
APPLICATION_JSON), 200);
String jsonResponseString = rsp.getContentAsString();
JSONObject jsonParsedObject = new JSONObject(new JSONTokener(jsonResponseString));
assertNotNull(jsonParsedObject);
JSONObject rootDataObject = (JSONObject)jsonParsedObject.get("data");
JSONObject definitionObject = (JSONObject)rootDataObject.get("definition");
JSONArray fieldsArray = (JSONArray)definitionObject.get("fields");
assertEquals("Expected 3 fields", 3, fieldsArray.length());
// get the data and check it
JSONObject formDataObject = (JSONObject)rootDataObject.get("formData");
assertNotNull("Expected to find cm:name data", formDataObject.get("prop_cm_name"));
assertNotNull("Expected to find cm:title data", formDataObject.get("prop_cm_title"));
assertEquals(TEST_FORM_TITLE, formDataObject.get("prop_cm_title"));
}
} }

47
source/java/org/alfresco/repo/web/scripts/forms/FormRestApiJsonPost_Test.java
View File

@@ -36,7 +36,6 @@ import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.ContentData; import org.alfresco.service.cmr.repository.ContentData;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.RegexQNamePattern; import org.alfresco.service.namespace.RegexQNamePattern;
import org.alfresco.web.scripts.TestWebScriptServer.GetRequest;
import org.alfresco.web.scripts.TestWebScriptServer.PostRequest; import org.alfresco.web.scripts.TestWebScriptServer.PostRequest;
import org.alfresco.web.scripts.TestWebScriptServer.Response; import org.alfresco.web.scripts.TestWebScriptServer.Response;
import org.json.JSONException; import org.json.JSONException;
@@ -46,7 +45,6 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
{ {
private static final String PROP_CM_DESCRIPTION = "prop_cm_description"; private static final String PROP_CM_DESCRIPTION = "prop_cm_description";
private static final String PROP_MIMETYPE = "prop_mimetype"; private static final String PROP_MIMETYPE = "prop_mimetype";
private static final String APPLICATION_JSON = "application/json";
private static final String ASSOC_CM_REFERENCES = "assoc_cm_references"; private static final String ASSOC_CM_REFERENCES = "assoc_cm_references";
private static final String ASSOC_CM_REFERENCES_ADDED = "assoc_cm_references_added"; private static final String ASSOC_CM_REFERENCES_ADDED = "assoc_cm_references_added";
private static final String ASSOC_CM_REFERENCES_REMOVED = "assoc_cm_references_removed"; private static final String ASSOC_CM_REFERENCES_REMOVED = "assoc_cm_references_removed";
@@ -77,7 +75,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
// Submit the JSON request. // Submit the JSON request.
String jsonPostString = jsonPostData.toString(); String jsonPostString = jsonPostData.toString();
Response ignoredRsp = sendRequest(new PostRequest(referencingNodeUrl, jsonPostString, Response ignoredRsp = sendRequest(new PostRequest(referencingNodeUpdateUrl, jsonPostString,
APPLICATION_JSON), 200); APPLICATION_JSON), 200);
// The nodeService should give us the modified property. // The nodeService should give us the modified property.
@@ -85,7 +83,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
nodeService.getProperty(referencingDocNodeRef, ContentModel.PROP_DESCRIPTION); nodeService.getProperty(referencingDocNodeRef, ContentModel.PROP_DESCRIPTION);
assertEquals(proposedNewDescription, modifiedDescription); assertEquals(proposedNewDescription, modifiedDescription);
// get the original mimetype // get the modified mimetype
String modifiedMimetype = null; String modifiedMimetype = null;
content = (ContentData)this.nodeService.getProperty(referencingDocNodeRef, ContentModel.PROP_CONTENT); content = (ContentData)this.nodeService.getProperty(referencingDocNodeRef, ContentModel.PROP_CONTENT);
if (content != null) if (content != null)
@@ -95,7 +93,8 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
assertEquals(MimetypeMap.MIMETYPE_HTML, modifiedMimetype); assertEquals(MimetypeMap.MIMETYPE_HTML, modifiedMimetype);
// The Rest API should also give us the modified property. // The Rest API should also give us the modified property.
Response response = sendRequest(new GetRequest(referencingNodeUrl), 200); /*
Response response = sendRequest(new GetRequest(referencingNodeUpdateUrl), 200);
JSONObject jsonGetResponse = new JSONObject(response.getContentAsString()); JSONObject jsonGetResponse = new JSONObject(response.getContentAsString());
JSONObject jsonDataObj = (JSONObject)jsonGetResponse.get("data"); JSONObject jsonDataObj = (JSONObject)jsonGetResponse.get("data");
assertNotNull(jsonDataObj); assertNotNull(jsonDataObj);
@@ -105,7 +104,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
String retrievedValue = (String)formData.get(PROP_CM_DESCRIPTION); String retrievedValue = (String)formData.get(PROP_CM_DESCRIPTION);
assertEquals(modifiedDescription, retrievedValue); assertEquals(modifiedDescription, retrievedValue);
String retrievedMimetype = (String)formData.get(PROP_MIMETYPE); String retrievedMimetype = (String)formData.get(PROP_MIMETYPE);
assertEquals(MimetypeMap.MIMETYPE_HTML, modifiedMimetype); assertEquals(MimetypeMap.MIMETYPE_HTML, modifiedMimetype);*/
} }
/** /**
@@ -122,7 +121,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
jsonPostData.put(ASSOC_CM_REFERENCES_ADDED, assocsToAdd); jsonPostData.put(ASSOC_CM_REFERENCES_ADDED, assocsToAdd);
String jsonPostString = jsonPostData.toString(); String jsonPostString = jsonPostData.toString();
sendRequest(new PostRequest(referencingNodeUrl, jsonPostString, APPLICATION_JSON), 200); sendRequest(new PostRequest(referencingNodeUpdateUrl, jsonPostString, APPLICATION_JSON), 200);
// Check the now updated associations via the node service // Check the now updated associations via the node service
List<AssociationRef> modifiedAssocs = nodeService.getTargetAssocs(referencingDocNodeRef, RegexQNamePattern.MATCH_ALL); List<AssociationRef> modifiedAssocs = nodeService.getTargetAssocs(referencingDocNodeRef, RegexQNamePattern.MATCH_ALL);
@@ -142,7 +141,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
assertTrue(associatedNodes.contains(associatedDoc_E)); assertTrue(associatedNodes.contains(associatedDoc_E));
// The Rest API should also give us the modified assocs. // The Rest API should also give us the modified assocs.
Response response = sendRequest(new GetRequest(referencingNodeUrl), 200); /*Response response = sendRequest(new GetRequest(referencingNodeUpdateUrl), 200);
String jsonRspString = response.getContentAsString(); String jsonRspString = response.getContentAsString();
JSONObject jsonGetResponse = new JSONObject(jsonRspString); JSONObject jsonGetResponse = new JSONObject(jsonRspString);
JSONObject jsonData = (JSONObject)jsonGetResponse.get("data"); JSONObject jsonData = (JSONObject)jsonGetResponse.get("data");
@@ -158,7 +157,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
for (AssociationRef assocRef : modifiedAssocs) for (AssociationRef assocRef : modifiedAssocs)
{ {
assertTrue(jsonAssocs.contains(assocRef.getTargetRef().toString())); assertTrue(jsonAssocs.contains(assocRef.getTargetRef().toString()));
} }*/
} }
/** /**
@@ -176,7 +175,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
jsonPostData.put(ASSOC_CM_REFERENCES_REMOVED, assocsToRemove); jsonPostData.put(ASSOC_CM_REFERENCES_REMOVED, assocsToRemove);
String jsonPostString = jsonPostData.toString(); String jsonPostString = jsonPostData.toString();
sendRequest(new PostRequest(referencingNodeUrl, jsonPostString, APPLICATION_JSON), 200); sendRequest(new PostRequest(referencingNodeUpdateUrl, jsonPostString, APPLICATION_JSON), 200);
// Check the now updated associations via the node service // Check the now updated associations via the node service
List<AssociationRef> modifiedAssocs = nodeService.getTargetAssocs(referencingDocNodeRef, RegexQNamePattern.MATCH_ALL); List<AssociationRef> modifiedAssocs = nodeService.getTargetAssocs(referencingDocNodeRef, RegexQNamePattern.MATCH_ALL);
@@ -192,7 +191,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
assertTrue(associatedNodes.contains(associatedDoc_A)); assertTrue(associatedNodes.contains(associatedDoc_A));
// The Rest API should also give us the modified assocs. // The Rest API should also give us the modified assocs.
Response response = sendRequest(new GetRequest(referencingNodeUrl), 200); /*Response response = sendRequest(new GetRequest(referencingNodeUpdateUrl), 200);
String jsonRspString = response.getContentAsString(); String jsonRspString = response.getContentAsString();
JSONObject jsonGetResponse = new JSONObject(jsonRspString); JSONObject jsonGetResponse = new JSONObject(jsonRspString);
JSONObject jsonData = (JSONObject)jsonGetResponse.get("data"); JSONObject jsonData = (JSONObject)jsonGetResponse.get("data");
@@ -208,7 +207,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
for (AssociationRef assocRef : modifiedAssocs) for (AssociationRef assocRef : modifiedAssocs)
{ {
assertTrue(jsonAssocs.contains(assocRef.getTargetRef().toString())); assertTrue(jsonAssocs.contains(assocRef.getTargetRef().toString()));
} }*/
} }
/** /**
@@ -226,10 +225,10 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
jsonPostData.put(ASSOC_CM_REFERENCES_ADDED, assocsToAdd); jsonPostData.put(ASSOC_CM_REFERENCES_ADDED, assocsToAdd);
String jsonPostString = jsonPostData.toString(); String jsonPostString = jsonPostData.toString();
sendRequest(new PostRequest(referencingNodeUrl, jsonPostString, APPLICATION_JSON), 200); sendRequest(new PostRequest(referencingNodeUpdateUrl, jsonPostString, APPLICATION_JSON), 200);
// Try to add the same association again // Try to add the same association again
sendRequest(new PostRequest(referencingNodeUrl, jsonPostString, APPLICATION_JSON), 200); sendRequest(new PostRequest(referencingNodeUpdateUrl, jsonPostString, APPLICATION_JSON), 200);
} }
/** /**
@@ -247,7 +246,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
jsonPostData.put(ASSOC_CM_REFERENCES_REMOVED, assocsToRemove); jsonPostData.put(ASSOC_CM_REFERENCES_REMOVED, assocsToRemove);
String jsonPostString = jsonPostData.toString(); String jsonPostString = jsonPostData.toString();
sendRequest(new PostRequest(referencingNodeUrl, jsonPostString, APPLICATION_JSON), 200); sendRequest(new PostRequest(referencingNodeUpdateUrl, jsonPostString, APPLICATION_JSON), 200);
} }
/** /**
@@ -264,7 +263,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
jsonPostData.put(ASSOC_SYS_CHILDREN_ADDED, assocsToAdd); jsonPostData.put(ASSOC_SYS_CHILDREN_ADDED, assocsToAdd);
String jsonPostString = jsonPostData.toString(); String jsonPostString = jsonPostData.toString();
sendRequest(new PostRequest(containingNodeUrl.toString(), jsonPostString, APPLICATION_JSON), 200); sendRequest(new PostRequest(containingNodeUpdateUrl.toString(), jsonPostString, APPLICATION_JSON), 200);
// Check the now updated child associations via the node service // Check the now updated child associations via the node service
List<ChildAssociationRef> modifiedAssocs = nodeService.getChildAssocs(containerNodeRef); List<ChildAssociationRef> modifiedAssocs = nodeService.getChildAssocs(containerNodeRef);
@@ -284,7 +283,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
assertTrue(associatedNodes.contains(childDoc_E)); assertTrue(associatedNodes.contains(childDoc_E));
// The Rest API should also give us the modified assocs. // The Rest API should also give us the modified assocs.
Response response = sendRequest(new GetRequest(containingNodeUrl), 200); /*Response response = sendRequest(new GetRequest(containingNodeUpdateUrl), 200);
String jsonRspString = response.getContentAsString(); String jsonRspString = response.getContentAsString();
JSONObject jsonGetResponse = new JSONObject(jsonRspString); JSONObject jsonGetResponse = new JSONObject(jsonRspString);
@@ -303,7 +302,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
String childNodeRef = assocRef.getChildRef().toString(); String childNodeRef = assocRef.getChildRef().toString();
assertTrue(jsonAssocs.contains(childNodeRef)); assertTrue(jsonAssocs.contains(childNodeRef));
assertTrue(NodeRef.isNodeRef(childNodeRef)); assertTrue(NodeRef.isNodeRef(childNodeRef));
} }*/
} }
/** /**
@@ -321,7 +320,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
jsonPostData.put(ASSOC_SYS_CHILDREN_REMOVED, assocsToRemove); jsonPostData.put(ASSOC_SYS_CHILDREN_REMOVED, assocsToRemove);
String jsonPostString = jsonPostData.toString(); String jsonPostString = jsonPostData.toString();
sendRequest(new PostRequest(containingNodeUrl, jsonPostString, APPLICATION_JSON), 200); sendRequest(new PostRequest(containingNodeUpdateUrl, jsonPostString, APPLICATION_JSON), 200);
// Check the now updated child associations via the node service // Check the now updated child associations via the node service
List<ChildAssociationRef> modifiedAssocs = nodeService.getChildAssocs(containerNodeRef); List<ChildAssociationRef> modifiedAssocs = nodeService.getChildAssocs(containerNodeRef);
@@ -337,7 +336,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
assertTrue(associatedNodes.contains(childDoc_A)); assertTrue(associatedNodes.contains(childDoc_A));
// The Rest API should also give us the modified assocs. // The Rest API should also give us the modified assocs.
Response response = sendRequest(new GetRequest(containingNodeUrl), 200); /*Response response = sendRequest(new GetRequest(containingNodeUpdateUrl), 200);
String jsonRspString = response.getContentAsString(); String jsonRspString = response.getContentAsString();
JSONObject jsonGetResponse = new JSONObject(jsonRspString); JSONObject jsonGetResponse = new JSONObject(jsonRspString);
JSONObject jsonData = (JSONObject)jsonGetResponse.get("data"); JSONObject jsonData = (JSONObject)jsonGetResponse.get("data");
@@ -353,7 +352,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
for (ChildAssociationRef assocRef : modifiedAssocs) for (ChildAssociationRef assocRef : modifiedAssocs)
{ {
assertTrue(jsonAssocs.contains(assocRef.getChildRef().toString())); assertTrue(jsonAssocs.contains(assocRef.getChildRef().toString()));
} }*/
} }
/** /**
@@ -371,10 +370,10 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
jsonPostData.put(ASSOC_SYS_CHILDREN_ADDED, assocsToAdd); jsonPostData.put(ASSOC_SYS_CHILDREN_ADDED, assocsToAdd);
String jsonPostString = jsonPostData.toString(); String jsonPostString = jsonPostData.toString();
sendRequest(new PostRequest(referencingNodeUrl, jsonPostString, APPLICATION_JSON), 200); sendRequest(new PostRequest(referencingNodeUpdateUrl, jsonPostString, APPLICATION_JSON), 200);
// Try to add the same child association again // Try to add the same child association again
sendRequest(new PostRequest(referencingNodeUrl, jsonPostString, APPLICATION_JSON), 200); sendRequest(new PostRequest(referencingNodeUpdateUrl, jsonPostString, APPLICATION_JSON), 200);
} }
/** /**
@@ -392,7 +391,7 @@ public class FormRestApiJsonPost_Test extends AbstractTestFormRestApi
jsonPostData.put(ASSOC_SYS_CHILDREN_REMOVED, assocsToRemove); jsonPostData.put(ASSOC_SYS_CHILDREN_REMOVED, assocsToRemove);
String jsonPostString = jsonPostData.toString(); String jsonPostString = jsonPostData.toString();
sendRequest(new PostRequest(referencingNodeUrl, jsonPostString, APPLICATION_JSON), 200); sendRequest(new PostRequest(referencingNodeUpdateUrl, jsonPostString, APPLICATION_JSON), 200);
} }