uriPrefixPair = resolveToUriAndPrefix(parentPrefixedName);
+
+ qname = QName.createQName(uriPrefixPair.getFirst(), parentLocalName);
+ classDefinition = (isAspect) ? dictionaryService.getAspect(qname) : dictionaryService.getType(qname);
+ }
+
+ if (classDefinition == null)
+ {
+ String msgId = (isAspect) ? "cmm.rest_api.aspect_parent_not_exist" : "cmm.rest_api.type_parent_not_exist";
+ throw new ConstraintViolatedException(I18NUtil.getMessage(msgId, parentPrefixedName));
+ }
+ else
+ {
+ checkCircularDependency(classDefinition.getModel(), existingModel, parentPrefixedName);
+ }
+ }
+
+ /**
+ * Validates models circular dependencies
+ * E.g. if {@literal B -> A} denotes model B depends on model A, then {@link ConstraintViolatedException} must be thrown for following:
+ *
if {@literal B -> A}, then {@literal A -> B} must throw exception
+ * if {@literal B -> A} and {@literal C -> B}, then {@literal A -> C} must throw exception
+ * if {@literal B -> A} and {@literal C -> B} and {@literal D -> C}, then {@literal A -> D} must throw exception
+ * @param modelDefinition the model which has a reference to the model containing the {@code parentPrefixedName}
+ * @param existingModel the model being updated
+ * @param parentPrefixedName the type/aspect parent name
+ */
+ private void checkCircularDependency(ModelDefinition modelDefinition, CustomModel existingModel, String parentPrefixedName)
+ {
+ for (NamespaceDefinition importedNamespace : modelDefinition.getImportedNamespaces())
+ {
+ ModelDefinition md = null;
+ if ((md = customModelService.getCustomModelByUri(importedNamespace.getUri())) != null)
+ {
+ if (existingModel.getNamespaceUri().equals(importedNamespace.getUri()))
+ {
+ String msg = I18NUtil.getMessage("cmm.rest_api.circular_dependency_err", parentPrefixedName, existingModel.getName());
+ throw new ConstraintViolatedException(msg);
+ }
+ checkCircularDependency(md, existingModel, parentPrefixedName);
+ }
+ }
+ }
+
+ /**
+ * Returns the qualified name of the following format
+ * prefix:localName, as a pair of (prefix, localName)
+ *
+ * @param prefixedQName the prefixed name. E.g. prefix:localName
+ * @return {@link Pair} of (prefix, localName)
+ */
+ private Pair splitPrefixedQName(String prefixedQName)
+ {
+ // index 0 => prefix and index 1 => local name
+ String[] prefixLocalName = QName.splitPrefixedQName(prefixedQName);
+
+ if (NamespaceService.DEFAULT_PREFIX.equals(prefixLocalName[0]))
+ {
+ throw new InvalidArgumentException("cmm.rest_api.prefixed_qname_invalid_format", new Object[] { prefixedQName });
+ }
+
+ return new Pair(prefixLocalName[0], prefixLocalName[1]);
+ }
+
+ private CustomModelDefinition updateModel(ModelDetails modelDetails, String errorMsg)
+ {
+ M2Model m2Model = convertToM2Model(modelDetails);
+ try
+ {
+ CustomModelDefinition modelDef = customModelService.updateCustomModel(modelDetails.getModel().getName(), m2Model, modelDetails.isActive());
+ return modelDef;
+ }
+ catch (CustomModelConstraintException mce)
+ {
+ throw new ConstraintViolatedException(mce.getMessage());
+ }
+ catch (InvalidCustomModelException iex)
+ {
+ throw new InvalidArgumentException(iex.getMessage());
+ }
+ catch (Exception ex)
+ {
+ if (ex.getMessage() != null)
+ {
+ errorMsg = ex.getMessage();
+ }
+ throw new ApiException(errorMsg, ex);
+ }
+ }
+
+ private void mergeProperties(AbstractClassModel existingDetails, AbstractClassModel newDetails, Parameters parameters, boolean isModelActive)
+ {
+ validateList(newDetails.getProperties(), "cmm.rest_api.properties_empty_null");
+
+ // Transform existing properties into a map
+ Map existingProperties = transformToMap(existingDetails.getProperties(), toNameFunction());
+
+ // Transform new properties into a map
+ Map newProperties = transformToMap(newDetails.getProperties(), toNameFunction());
+
+ String propName = parameters.getParameter(PARAM_UPDATE_PROP);
+ // (propName == null) => property create request
+ if (propName == null)
+ {
+ // As this is a create request, check for duplicate properties
+ for (String name : newProperties.keySet())
+ {
+ if (existingProperties.containsKey(name))
+ {
+ throw new ConstraintViolatedException(I18NUtil.getMessage("cmm.rest_api.property_create_name_already_in_use", name));
+ }
+ }
+ }
+ else
+ {// Update request
+ CustomModelProperty existingProp = existingProperties.get(propName);
+ if (existingProp == null)
+ {
+ throw new EntityNotFoundException(propName);
+ }
+
+ CustomModelProperty modifiedProp = newProperties.get(propName);
+ if (modifiedProp == null)
+ {
+ throw new InvalidArgumentException("cmm.rest_api.property_update_prop_not_found", new Object[] { propName });
+ }
+
+ existingProp.setTitle(modifiedProp.getTitle());
+ existingProp.setDescription(modifiedProp.getDescription());
+ existingProp.setDefaultValue(modifiedProp.getDefaultValue());
+ existingProp.setConstraintRefs(modifiedProp.getConstraintRefs());
+ existingProp.setConstraints(modifiedProp.getConstraints());
+ if (isModelActive)
+ {
+ validateActivePropertyUpdate(existingProp, modifiedProp);
+ }
+ existingProp.setDataType(modifiedProp.getDataType());
+ existingProp.setMandatory(modifiedProp.isMandatory());
+ existingProp.setMandatoryEnforced(modifiedProp.isMandatoryEnforced());
+ existingProp.setMultiValued(modifiedProp.isMultiValued());
+ }
+ // Override properties
+ existingProperties.putAll(newProperties);
+ existingDetails.setProperties(new ArrayList<>(existingProperties.values()));
+ }
+
+ /**
+ * A helper method to throw a more informative exception (for an active model) rather than depending on the
+ * {@link org.alfresco.repo.dictionary.ModelValidatorImpl#validateModel}
+ * generic exception.
+ */
+ private void validateActivePropertyUpdate(CustomModelProperty existingProp, CustomModelProperty newProp)
+ {
+ if (!StringUtils.equals(existingProp.getDataType(), newProp.getDataType()))
+ {
+ throw new ConstraintViolatedException("cmm.rest_api.property_change_datatype_err");
+ }
+ if (existingProp.isMandatory() != newProp.isMandatory())
+ {
+ throw new ConstraintViolatedException("cmm.rest_api.property_change_mandatory_opt_err");
+ }
+ if (existingProp.isMandatoryEnforced() != newProp.isMandatoryEnforced())
+ {
+ throw new ConstraintViolatedException("cmm.rest_api.property_change_mandatory_enforced_opt_err");
+ }
+ if (existingProp.isMultiValued() != newProp.isMultiValued())
+ {
+ throw new ConstraintViolatedException("cmm.rest_api.property_change_multi_valued_opt_err");
+ }
+ }
+
+ private void deleteProperty(AbstractClassModel existingClassModel, String propertyName)
+ {
+ // Transform existing properties into a map
+ Map existingProperties = transformToMap(existingClassModel.getProperties(), toNameFunction());
+ if (!existingProperties.containsKey(propertyName))
+ {
+ throw new EntityNotFoundException(propertyName);
+ }
+ existingProperties.remove(propertyName);
+ existingClassModel.setProperties(new ArrayList<>(existingProperties.values()));
+ }
+
+ private void validateList(List list, String errorMsg)
+ {
+ if (CollectionUtils.isEmpty(list))
+ {
+ throw new InvalidArgumentException(errorMsg);
+ }
+ }
+
+ private static Map transformToMap(Collection collection, Function function)
+ {
+ Map map = new HashMap<>(collection.size());
+
+ for (V item : collection)
+ {
+ map.put(function.apply(item), item);
+ }
+ return map;
+ }
+
+ private static Map removeRightEntries(Map leftMap, Map rightMap)
+ {
+ Map result = new HashMap<>(leftMap);
+ for (K key : rightMap.keySet())
+ {
+ result.remove(key);
+ }
+ return result;
+ }
+
+ private void validateTypeAspectDelete(Collection list, String classPrefixedName)
+ {
+ for(AbstractClassModel acm : list)
+ {
+ if(classPrefixedName.equals(acm.getParentName()))
+ {
+ throw new ConstraintViolatedException(I18NUtil.getMessage("cmm.rest_api.aspect_type_cannot_delete", classPrefixedName, acm.getPrefixedName()));
+ }
+ }
+ }
+
+ private boolean hasSelectProperty(Parameters parameters, String param)
+ {
+ return parameters.getSelectedProperties().contains(param);
+ }
+
+ private static Function toNameFunction()
+ {
+ return new Function()
+ {
+ @Override
+ public String apply(AbstractCommonDetails details)
+ {
+ return details.getName();
+ }
+ };
+ }
+
+ private T getObjectByName(Collection collection, String name)
+ {
+ for (T details : collection)
+ {
+ if (details.getName().equals(name))
+ {
+ return details;
+ }
+ }
+ return null;
+ }
+
+ public class ModelDetails
+ {
+ private CustomModel model;
+ private boolean active;
+ private List types;
+ private List aspects;
+ private List modelDefinedConstraints;
+
+ public ModelDetails(CustomModelDefinition modelDefinition)
+ {
+ this.model = new CustomModel(modelDefinition);
+ this.active = modelDefinition.isActive();
+ this.types = convertToCustomTypes(modelDefinition.getTypeDefinitions(), false);
+ this.aspects = convertToCustomAspects(modelDefinition.getAspectDefinitions(), false);
+ this.modelDefinedConstraints = convertToCustomModelConstraints(modelDefinition.getModelDefinedConstraints());
+ }
+
+ public CustomModel getModel()
+ {
+ return this.model;
+ }
+
+ public void setModel(CustomModel model)
+ {
+ this.model = model;
+ }
+
+ public List getTypes()
+ {
+ return this.types;
+ }
+
+ public void setTypes(List types)
+ {
+ this.types = types;
+ }
+
+ public List getAspects()
+ {
+ return this.aspects;
+ }
+
+ public void setAspects(List aspects)
+ {
+ this.aspects = aspects;
+ }
+
+ public List getModelDefinedConstraints()
+ {
+ return this.modelDefinedConstraints;
+ }
+
+ public void setModelDefinedConstraints(List modelDefinedConstraints)
+ {
+ this.modelDefinedConstraints = modelDefinedConstraints;
+ }
+
+ public boolean isActive()
+ {
+ return this.active;
+ }
+ }
+
+ /**
+ * Constraint validator
+ *
+ * @author Jamal Kaabi-Mofrad
+ */
+ public enum ConstraintValidator
+ {
+ REGEX
+ {
+ @Override
+ public void validate(String parameterName, String value)
+ {
+ if ("expression".equals(parameterName))
+ {
+ try
+ {
+ Pattern.compile(value);
+ }
+ catch (Exception ex)
+ {
+ throw new InvalidArgumentException("cmm.rest_api.regex_constraint_invalid_expression", new Object[] { value });
+ }
+ }
+ }
+ },
+ MINMAX
+ {
+ @Override
+ public void validate(String parameterName, String value)
+ {
+ double parsedValue;
+ try
+ {
+ parsedValue = Double.parseDouble(value);
+ }
+ catch (Exception ex)
+ {
+ throw new InvalidArgumentException("cmm.rest_api.minmax_constraint_invalid_parameter", new Object[] { value, parameterName });
+ }
+ // SHA-1126. We check for the Double.MIN_VALUE to be consistent with NumericRangeConstraint.minValue
+ if("maxValue".equalsIgnoreCase(parameterName) && parsedValue < Double.MIN_VALUE)
+ {
+ throw new InvalidArgumentException("cmm.rest_api.minmax_constraint_invalid_max_value");
+ }
+ }
+
+ @Override
+ public void validateUsage(QName propDataType)
+ {
+ if (propDataType != null && !(DataTypeDefinition.INT.equals(propDataType)
+ || DataTypeDefinition.LONG.equals(propDataType)
+ || DataTypeDefinition.FLOAT.equals(propDataType)
+ || DataTypeDefinition.DOUBLE.equals(propDataType)))
+ {
+ throw new InvalidArgumentException("cmm.rest_api.minmax_constraint_invalid_use");
+ }
+ }
+ },
+ LENGTH
+ {
+ @Override
+ public void validate(String parameterName, String value)
+ {
+ try
+ {
+ Integer.parseInt(value);
+ }
+ catch (Exception ex)
+ {
+ throw new InvalidArgumentException("cmm.rest_api.length_constraint_invalid_parameter", new Object[] { value, parameterName });
+ }
+ }
+
+ @Override
+ public void validateUsage(QName propDataType)
+ {
+ if (propDataType != null && !(DataTypeDefinition.TEXT.equals(propDataType)
+ || DataTypeDefinition.MLTEXT.equals(propDataType)
+ || DataTypeDefinition.CONTENT.equals(propDataType)))
+ {
+ throw new InvalidArgumentException("cmm.rest_api.length_constraint_invalid_use");
+ }
+ }
+ },
+ DUMMY_CONSTRAINT
+ {
+ @Override
+ public void validate(String parameterName, String value)
+ {
+ // nothing to do
+ }
+ };
+
+ public abstract void validate(String parameterName, String value);
+
+ public void validateUsage(QName propDataType)
+ {
+ return; // nothing to do
+ }
+
+ public static ConstraintValidator findByType(String constraintType)
+ {
+ for (ConstraintValidator c : values())
+ {
+ if (c.name().equals(constraintType))
+ {
+ return c;
+ }
+ }
+ return DUMMY_CONSTRAINT;
+ }
+ }
+
+ @Override
+ public CustomModel createCustomModel(M2Model m2Model)
+ {
+ // Check the current user is authorised to import the custom model
+ validateCurrentUser();
+
+ validateImportedM2Model(m2Model);
+
+ CompiledModel compiledModel = null;
+ try
+ {
+ compiledModel = customModelService.compileModel(m2Model);
+ }
+ catch (CustomModelConstraintException mce)
+ {
+ throw new ConstraintViolatedException(mce.getMessage());
+ }
+ catch (InvalidCustomModelException iex)
+ {
+ throw new InvalidArgumentException(iex.getMessage());
+ }
+
+ ModelDefinition modelDefinition = compiledModel.getModelDefinition();
+ CustomModel customModel = new CustomModel();
+ customModel.setName(modelDefinition.getName().getLocalName());
+ customModel.setAuthor(modelDefinition.getAuthor());
+ customModel.setDescription(modelDefinition.getDescription(dictionaryService));
+ customModel.setStatus(ModelStatus.DRAFT);
+ NamespaceDefinition nsd = modelDefinition.getNamespaces().iterator().next();
+ customModel.setNamespaceUri(nsd.getUri());
+ customModel.setNamespacePrefix(nsd.getPrefix());
+
+ List customTypes = convertToCustomTypes(compiledModel.getTypes(), false);
+ List customAspects = convertToCustomAspects(compiledModel.getAspects(), false);
+
+ List constraintDefinitions = CustomModelDefinitionImpl.removeInlineConstraints(compiledModel);
+ List customModelConstraints = convertToCustomModelConstraints(constraintDefinitions);
+
+ customModel.setTypes(customTypes);
+ customModel.setAspects(customAspects);
+ customModel.setConstraints(customModelConstraints);
+
+ return createCustomModelImpl(customModel, false);
+ }
+
+ private void validateImportedM2Model(M2Model m2Model)
+ {
+ List namespaces = m2Model.getNamespaces();
+ if (namespaces.size() > 1)
+ {
+ throw new ConstraintViolatedException(I18NUtil.getMessage("cmm.rest_api.model.import_namespace_multiple_found", namespaces.size()));
+ }
+ else if (namespaces.isEmpty())
+ {
+ throw new ConstraintViolatedException("cmm.rest_api.model.import_namespace_undefined");
+ }
+
+ checkUnsupportedModelElements(m2Model.getTypes());
+ checkUnsupportedModelElements(m2Model.getAspects());
+ }
+
+ private void checkUnsupportedModelElements(Collection m2Classes)
+ {
+ for (M2Class cls : m2Classes)
+ {
+ if (cls.getAssociations().size() > 0)
+ {
+ throw new ConstraintViolatedException("cmm.rest_api.model.import_associations_unsupported");
+ }
+ if (cls.getPropertyOverrides().size() > 0)
+ {
+ throw new ConstraintViolatedException("cmm.rest_api.model.import_overrides_unsupported");
+ }
+ if (cls.getMandatoryAspects().size() > 0)
+ {
+ throw new ConstraintViolatedException("cmm.rest_api.model.import_mandatory_aspects_unsupported");
+ }
+ if(cls.getArchive() != null)
+ {
+ throw new ConstraintViolatedException("cmm.rest_api.model.import_archive_unsupported");
+ }
+ if(cls.getIncludedInSuperTypeQuery() != null)
+ {
+ throw new ConstraintViolatedException("cmm.rest_api.model.import_includedInSuperTQ_unsupported");
+ }
+ }
+ }
+}
diff --git a/source/java/org/alfresco/rest/api/model/AbstractClassModel.java b/source/java/org/alfresco/rest/api/model/AbstractClassModel.java
new file mode 100644
index 0000000000..3acd9adf84
--- /dev/null
+++ b/source/java/org/alfresco/rest/api/model/AbstractClassModel.java
@@ -0,0 +1,73 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.model;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.alfresco.service.namespace.QName;
+
+/**
+ * @author Jamal Kaabi-Mofrad
+ */
+public abstract class AbstractClassModel extends AbstractCommonDetails
+{
+ /* package */String parentName;
+ /* package */List properties = Collections.emptyList();
+
+ public String getParentName()
+ {
+ return this.parentName;
+ }
+
+ public void setParentName(String parentName)
+ {
+ this.parentName = parentName;
+ }
+
+ public List getProperties()
+ {
+ return this.properties;
+ }
+
+ public void setProperties(List properties)
+ {
+ this.properties = properties;
+ }
+
+ /* package */ List setList(List sourceList)
+ {
+ if (sourceList == null)
+ {
+ return Collections. emptyList();
+ }
+ return new ArrayList<>(sourceList);
+ }
+
+ /* package */String getParentNameAsString(QName parentQName)
+ {
+ if (parentQName != null)
+ {
+ return parentQName.toPrefixString();
+ }
+ return null;
+ }
+}
diff --git a/source/java/org/alfresco/rest/api/model/AbstractCommonDetails.java b/source/java/org/alfresco/rest/api/model/AbstractCommonDetails.java
new file mode 100644
index 0000000000..edb0f76bee
--- /dev/null
+++ b/source/java/org/alfresco/rest/api/model/AbstractCommonDetails.java
@@ -0,0 +1,111 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.model;
+
+/**
+ * @author Jamal Kaabi-Mofrad
+ */
+public abstract class AbstractCommonDetails implements Comparable
+{
+ /* package */String name;
+ /* package */String prefixedName;
+ /* package */String title;
+ /* package */String description;
+
+ public String getName()
+ {
+ return this.name;
+ }
+
+ public void setName(String name)
+ {
+ this.name = name;
+ }
+
+ public String getPrefixedName()
+ {
+ return this.prefixedName;
+ }
+
+ public String getTitle()
+ {
+ return this.title;
+ }
+
+ public void setTitle(String title)
+ {
+ this.title = title;
+ }
+
+ public String getDescription()
+ {
+ return this.description;
+ }
+
+ public void setDescription(String description)
+ {
+ this.description = description;
+ }
+
+ @Override
+ public int hashCode()
+ {
+ final int prime = 31;
+ int result = 1;
+ result = prime * result + ((this.name == null) ? 0 : this.name.hashCode());
+ return result;
+ }
+
+ @Override
+ public boolean equals(Object obj)
+ {
+ if (this == obj)
+ {
+ return true;
+ }
+ if (obj == null)
+ {
+ return false;
+ }
+ if (!(obj instanceof CustomModelConstraint))
+ {
+ return false;
+ }
+ CustomModelConstraint other = (CustomModelConstraint) obj;
+ if (this.name == null)
+ {
+ if (other.name != null)
+ {
+ return false;
+ }
+ }
+ else if (!this.name.equals(other.name))
+ {
+ return false;
+ }
+ return true;
+ }
+
+ @Override
+ public int compareTo(AbstractCommonDetails other)
+ {
+ return this.name.compareTo(other.getName());
+ }
+}
diff --git a/source/java/org/alfresco/rest/api/model/CustomAspect.java b/source/java/org/alfresco/rest/api/model/CustomAspect.java
new file mode 100644
index 0000000000..65a07a1bf3
--- /dev/null
+++ b/source/java/org/alfresco/rest/api/model/CustomAspect.java
@@ -0,0 +1,60 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.model;
+
+import java.util.List;
+
+import org.alfresco.service.cmr.dictionary.AspectDefinition;
+import org.alfresco.service.cmr.i18n.MessageLookup;
+
+/**
+ * @author Jamal Kaabi-Mofrad
+ */
+public class CustomAspect extends AbstractClassModel
+{
+
+ public CustomAspect()
+ {
+ }
+
+ public CustomAspect(AspectDefinition aspectDefinition, MessageLookup messageLookup, List properties)
+ {
+ this.name = aspectDefinition.getName().getLocalName();
+ this.prefixedName = aspectDefinition.getName().toPrefixString();
+ this.title = aspectDefinition.getTitle(messageLookup);
+ this.description = aspectDefinition.getDescription(messageLookup);
+ this.parentName = getParentNameAsString(aspectDefinition.getParentName());
+ this.properties = setList(properties);
+ }
+
+ @Override
+ public String toString()
+ {
+ StringBuilder builder = new StringBuilder(512);
+ builder.append("CustomAspect [name=").append(this.name)
+ .append(", prefixedName=").append(this.prefixedName)
+ .append(", title=").append(this.title)
+ .append(", description=").append(this.description)
+ .append(", parentName=").append(parentName)
+ .append(", properties=").append(properties)
+ .append(']');
+ return builder.toString();
+ }
+}
diff --git a/source/java/org/alfresco/rest/api/model/CustomModel.java b/source/java/org/alfresco/rest/api/model/CustomModel.java
new file mode 100644
index 0000000000..35e7852da6
--- /dev/null
+++ b/source/java/org/alfresco/rest/api/model/CustomModel.java
@@ -0,0 +1,217 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.model;
+
+import java.util.List;
+
+import org.alfresco.service.cmr.dictionary.CustomModelDefinition;
+import org.alfresco.service.cmr.dictionary.NamespaceDefinition;
+
+/**
+ * @author Jamal Kaabi-Mofrad
+ */
+public class CustomModel implements Comparable
+{
+ public static enum ModelStatus
+ {
+ ACTIVE, DRAFT
+ }
+
+ private String name;
+ private String author;
+ private String description;
+ private ModelStatus status;
+ private String namespaceUri;
+ private String namespacePrefix;
+ private List types;
+ private List aspects;
+ private List constraints;
+
+ public CustomModel()
+ {
+ }
+
+ public CustomModel(CustomModelDefinition modelDefinition)
+ {
+ this(modelDefinition, null, null, null);
+ }
+
+ public CustomModel(CustomModelDefinition modelDefinition, List types, List aspects, List constraints)
+ {
+ this.name = modelDefinition.getName().getLocalName();
+ this.author = modelDefinition.getAuthor();
+ this.description = modelDefinition.getDescription();
+ this.status = modelDefinition.isActive() ? ModelStatus.ACTIVE : ModelStatus.DRAFT;
+ // we don't need to check for NoSuchElementException, as we don't allow
+ // the model to be saved without a valid namespace
+ NamespaceDefinition nsd = modelDefinition.getNamespaces().iterator().next();
+ this.namespaceUri = nsd.getUri();
+ this.namespacePrefix = nsd.getPrefix();
+ this.types = types;
+ this.aspects = aspects;
+ this.constraints = constraints;
+ }
+
+ public String getName()
+ {
+ return this.name;
+ }
+
+ public void setName(String name)
+ {
+ this.name = name;
+ }
+
+ public String getAuthor()
+ {
+ return this.author;
+ }
+
+ public void setAuthor(String author)
+ {
+ this.author = author;
+ }
+
+ public String getDescription()
+ {
+ return this.description;
+ }
+
+ public void setDescription(String description)
+ {
+ this.description = description;
+ }
+
+ public ModelStatus getStatus()
+ {
+ return this.status;
+ }
+
+ public void setStatus(ModelStatus status)
+ {
+ this.status = status;
+ }
+
+ public String getNamespaceUri()
+ {
+ return this.namespaceUri;
+ }
+
+ public void setNamespaceUri(String namespaceUri)
+ {
+ this.namespaceUri = namespaceUri;
+ }
+
+ public String getNamespacePrefix()
+ {
+ return this.namespacePrefix;
+ }
+
+ public void setNamespacePrefix(String namespacePrefix)
+ {
+ this.namespacePrefix = namespacePrefix;
+ }
+
+ public List getTypes()
+ {
+ return this.types;
+ }
+
+ public void setTypes(List types)
+ {
+ this.types = types;
+ }
+
+ public List getAspects()
+ {
+ return this.aspects;
+ }
+
+ public void setAspects(List aspects)
+ {
+ this.aspects = aspects;
+ }
+
+ public List getConstraints()
+ {
+ return this.constraints;
+ }
+
+ public void setConstraints(List constraints)
+ {
+ this.constraints = constraints;
+ }
+
+ @Override
+ public int hashCode()
+ {
+ final int prime = 31;
+ int result = 1;
+ result = prime * result + ((this.name == null) ? 0 : this.name.hashCode());
+ return result;
+ }
+
+ @Override
+ public boolean equals(Object obj)
+ {
+ if (this == obj)
+ {
+ return true;
+ }
+ if (obj == null)
+ {
+ return false;
+ }
+ if (!(obj instanceof CustomModel))
+ {
+ return false;
+ }
+ CustomModel other = (CustomModel) obj;
+ if (this.name == null)
+ {
+ if (other.name != null)
+ {
+ return false;
+ }
+ }
+ else if (!this.name.equals(other.name))
+ {
+ return false;
+ }
+ return true;
+ }
+
+ @Override
+ public int compareTo(CustomModel customModel)
+ {
+ return this.name.compareTo(customModel.getName());
+ }
+
+ @Override
+ public String toString()
+ {
+ StringBuilder builder = new StringBuilder(512);
+ builder.append("CustomModel [name=").append(this.name).append(", author=").append(this.author)
+ .append(", description=").append(this.description).append(", status=").append(this.status)
+ .append(", namespaceUri=").append(this.namespaceUri).append(", namespacePrefix=")
+ .append(this.namespacePrefix).append(']');
+ return builder.toString();
+ }
+}
diff --git a/source/java/org/alfresco/rest/api/model/CustomModelConstraint.java b/source/java/org/alfresco/rest/api/model/CustomModelConstraint.java
new file mode 100644
index 0000000000..481e025c20
--- /dev/null
+++ b/source/java/org/alfresco/rest/api/model/CustomModelConstraint.java
@@ -0,0 +1,97 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.model;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import org.alfresco.service.cmr.dictionary.ConstraintDefinition;
+import org.alfresco.service.cmr.i18n.MessageLookup;
+
+/**
+ * @author Jamal Kaabi-Mofrad
+ */
+public class CustomModelConstraint extends AbstractCommonDetails
+{
+ private String type;
+ private List parameters = Collections.emptyList();
+
+ public CustomModelConstraint()
+ {
+ }
+
+ public CustomModelConstraint(ConstraintDefinition constraintDefinition, MessageLookup messageLookup)
+ {
+ this.name = constraintDefinition.getName().getLocalName();
+ this.prefixedName = constraintDefinition.getConstraint().getShortName();
+ this.type = constraintDefinition.getConstraint().getType();
+ this.title = constraintDefinition.getTitle(messageLookup);
+ this.description = constraintDefinition.getDescription(messageLookup);
+ this.parameters = convertToNamedValue(constraintDefinition.getConstraint().getParameters());
+ }
+
+ private List convertToNamedValue(Map params)
+ {
+ List list = new ArrayList<>(params.size());
+ for (Entry en : params.entrySet())
+ {
+ list.add(new CustomModelNamedValue(en.getKey(), en.getValue()));
+ }
+
+ return list;
+ }
+
+ public String getType()
+ {
+ return this.type;
+ }
+
+ public void setType(String type)
+ {
+ this.type = type;
+ }
+
+ public List getParameters()
+ {
+ return this.parameters;
+ }
+
+ public void setParameters(List parameters)
+ {
+ this.parameters = parameters;
+ }
+
+ @Override
+ public String toString()
+ {
+ StringBuilder builder = new StringBuilder(300);
+ builder.append("CustomModelConstraint [name=").append(this.name)
+ .append(", prefixedName=").append(this.prefixedName)
+ .append(", type=").append(this.type)
+ .append(", title=").append(this.title)
+ .append(", description=").append(this.description)
+ .append(", parameters=").append(this.parameters)
+ .append(']');
+ return builder.toString();
+ }
+}
\ No newline at end of file
diff --git a/source/java/org/alfresco/rest/api/model/CustomModelDownload.java b/source/java/org/alfresco/rest/api/model/CustomModelDownload.java
new file mode 100644
index 0000000000..99cee5234c
--- /dev/null
+++ b/source/java/org/alfresco/rest/api/model/CustomModelDownload.java
@@ -0,0 +1,94 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.model;
+
+import org.alfresco.service.cmr.repository.NodeRef;
+
+/**
+ * @author Jamal Kaabi-Mofrad
+ */
+public class CustomModelDownload implements Comparable
+{
+ private String nodeRef;
+
+ public CustomModelDownload()
+ {
+ }
+
+ public CustomModelDownload(NodeRef nodeRef)
+ {
+ this.nodeRef = nodeRef.toString();
+ }
+
+ public String getNodeRef()
+ {
+ return this.nodeRef;
+ }
+
+ public void setNodeRef(String nodeRef)
+ {
+ this.nodeRef = nodeRef;
+ }
+
+ @Override
+ public int hashCode()
+ {
+ final int prime = 31;
+ int result = 1;
+ result = prime * result + ((this.nodeRef == null) ? 0 : this.nodeRef.hashCode());
+ return result;
+ }
+
+ @Override
+ public boolean equals(Object obj)
+ {
+ if (this == obj)
+ {
+ return true;
+ }
+ if (obj == null)
+ {
+ return false;
+ }
+ if (!(obj instanceof CustomModelDownload))
+ {
+ return false;
+ }
+ CustomModelDownload other = (CustomModelDownload) obj;
+ if (this.nodeRef == null)
+ {
+ if (other.nodeRef != null)
+ {
+ return false;
+ }
+ }
+ else if (!this.nodeRef.equals(other.nodeRef))
+ {
+ return false;
+ }
+ return true;
+ }
+
+ @Override
+ public int compareTo(CustomModelDownload other)
+ {
+ return this.nodeRef.toString().compareTo(other.getNodeRef().toString());
+ }
+}
diff --git a/source/java/org/alfresco/rest/api/model/CustomModelNamedValue.java b/source/java/org/alfresco/rest/api/model/CustomModelNamedValue.java
new file mode 100644
index 0000000000..a2c4b26f6e
--- /dev/null
+++ b/source/java/org/alfresco/rest/api/model/CustomModelNamedValue.java
@@ -0,0 +1,159 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
+import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter;
+import org.alfresco.service.cmr.repository.datatype.TypeConversionException;
+
+/**
+ *
+ *
+ * @author Jamal Kaabi-Mofrad
+ */
+public class CustomModelNamedValue implements Comparable
+{
+ private String name;
+ private String simpleValue = null;
+ private List listValue = null;
+
+ public CustomModelNamedValue()
+ {
+ }
+
+ public CustomModelNamedValue(String name, Object value)
+ {
+ this.name = name;
+ if (value instanceof List)
+ {
+ List values = (List) value;
+ listValue = new ArrayList<>(values.size());
+ for(Object val : values)
+ {
+ listValue.add(convertToString(val));
+ }
+ }
+ else
+ {
+ simpleValue = convertToString(value);
+ }
+ }
+
+ private String convertToString(Object value)
+ {
+ try
+ {
+ return DefaultTypeConverter.INSTANCE.convert(String.class, value);
+ }
+ catch (TypeConversionException e)
+ {
+ throw new InvalidArgumentException("Cannot convert to string '" + value + "'.");
+ }
+ }
+
+ public String getName()
+ {
+ return this.name;
+ }
+
+ public void setName(String name)
+ {
+ this.name = name;
+ }
+
+ public String getSimpleValue()
+ {
+ return this.simpleValue;
+ }
+
+ public void setSimpleValue(String simpleValue)
+ {
+ this.simpleValue = simpleValue;
+ }
+
+ public List getListValue()
+ {
+ return this.listValue;
+ }
+
+ public void setListValue(List listValue)
+ {
+ this.listValue = listValue;
+ }
+
+ @Override
+ public int hashCode()
+ {
+ final int prime = 31;
+ int result = 1;
+ result = prime * result + ((this.name == null) ? 0 : this.name.hashCode());
+ return result;
+ }
+
+ @Override
+ public boolean equals(Object obj)
+ {
+ if (this == obj)
+ {
+ return true;
+ }
+ if (obj == null)
+ {
+ return false;
+ }
+ if (!(obj instanceof CustomModelNamedValue))
+ {
+ return false;
+ }
+ CustomModelNamedValue other = (CustomModelNamedValue) obj;
+ if (this.name == null)
+ {
+ if (other.name != null)
+ {
+ return false;
+ }
+ }
+ else if (!this.name.equals(other.name))
+ {
+ return false;
+ }
+ return true;
+ }
+
+ @Override
+ public int compareTo(CustomModelNamedValue other)
+ {
+ return name.compareTo(other.getName());
+ }
+
+ @Override
+ public String toString()
+ {
+ StringBuilder builder = new StringBuilder(120);
+ builder.append("CustomModelNamedValue [name=").append(this.name)
+ .append(", simpleValue=").append(this.simpleValue)
+ .append(", listValue=").append(this.listValue)
+ .append(']');
+ return builder.toString();
+ }
+}
diff --git a/source/java/org/alfresco/rest/api/model/CustomModelProperty.java b/source/java/org/alfresco/rest/api/model/CustomModelProperty.java
new file mode 100644
index 0000000000..5ae137d9d1
--- /dev/null
+++ b/source/java/org/alfresco/rest/api/model/CustomModelProperty.java
@@ -0,0 +1,206 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.model;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.alfresco.repo.dictionary.Facetable;
+import org.alfresco.repo.dictionary.IndexTokenisationMode;
+import org.alfresco.service.cmr.dictionary.ConstraintDefinition;
+import org.alfresco.service.cmr.dictionary.PropertyDefinition;
+import org.alfresco.service.cmr.i18n.MessageLookup;
+
+/**
+ * @author Jamal Kaabi-Mofrad
+ */
+public class CustomModelProperty extends AbstractCommonDetails
+{
+ private String dataType;
+ private boolean isMandatory;
+ private boolean isMandatoryEnforced;
+ private boolean isMultiValued;
+ private String defaultValue;
+ private boolean isIndexed = true;
+ private Facetable facetable = Facetable.UNSET;
+ private IndexTokenisationMode indexTokenisationMode;
+ private List constraintRefs = Collections.emptyList();
+ private List constraints = Collections.emptyList();
+
+ public CustomModelProperty()
+ {
+ }
+
+ public CustomModelProperty(PropertyDefinition propertyDefinition, MessageLookup messageLookup)
+ {
+ this.name = propertyDefinition.getName().getLocalName();
+ this.prefixedName = propertyDefinition.getName().toPrefixString();
+ this.title = propertyDefinition.getTitle(messageLookup);
+ this.dataType = propertyDefinition.getDataType().getName().toPrefixString();
+ this.description = propertyDefinition.getDescription(messageLookup);
+ this.isMandatory = propertyDefinition.isMandatory();
+ this.isMandatoryEnforced = propertyDefinition.isMandatoryEnforced();
+ this.isMultiValued = propertyDefinition.isMultiValued();
+ this.defaultValue = propertyDefinition.getDefaultValue();
+ this.isIndexed = propertyDefinition.isIndexed();
+ this.facetable = propertyDefinition.getFacetable();
+ this.indexTokenisationMode = propertyDefinition.getIndexTokenisationMode();
+ List constraintDefs = propertyDefinition.getConstraints();
+ if (constraintDefs.size() > 0)
+ {
+ this.constraintRefs = new ArrayList<>();
+ this.constraints = new ArrayList<>();
+ for (ConstraintDefinition cd : constraintDefs)
+ {
+ if (cd.getRef() != null)
+ {
+ constraintRefs.add(cd.getRef().toPrefixString());
+ }
+ else
+ {
+ constraints.add(new CustomModelConstraint(cd, messageLookup));
+ }
+ }
+ }
+ }
+
+ public String getDataType()
+ {
+ return this.dataType;
+ }
+
+ public void setDataType(String dataType)
+ {
+ this.dataType = dataType;
+ }
+
+ public boolean isMandatory()
+ {
+ return this.isMandatory;
+ }
+
+ public void setMandatory(boolean isMandatory)
+ {
+ this.isMandatory = isMandatory;
+ }
+
+ public boolean isMandatoryEnforced()
+ {
+ return this.isMandatoryEnforced;
+ }
+
+ public void setMandatoryEnforced(boolean isMandatoryEnforced)
+ {
+ this.isMandatoryEnforced = isMandatoryEnforced;
+ }
+
+ public boolean isMultiValued()
+ {
+ return this.isMultiValued;
+ }
+
+ public void setMultiValued(boolean isMultiValued)
+ {
+ this.isMultiValued = isMultiValued;
+ }
+
+ public String getDefaultValue()
+ {
+ return this.defaultValue;
+ }
+
+ public void setDefaultValue(String defaultValue)
+ {
+ this.defaultValue = defaultValue;
+ }
+
+ public boolean isIndexed()
+ {
+ return this.isIndexed;
+ }
+
+ public void setIndexed(boolean isIndexed)
+ {
+ this.isIndexed = isIndexed;
+ }
+
+ public Facetable getFacetable()
+ {
+ return this.facetable;
+ }
+
+ public void setFacetable(Facetable facetable)
+ {
+ this.facetable = facetable;
+ }
+
+ public IndexTokenisationMode getIndexTokenisationMode()
+ {
+ return this.indexTokenisationMode;
+ }
+
+ public void setIndexTokenisationMode(IndexTokenisationMode indexTokenisationMode)
+ {
+ this.indexTokenisationMode = indexTokenisationMode;
+ }
+
+ public List getConstraintRefs()
+ {
+ return this.constraintRefs;
+ }
+
+ public void setConstraintRefs(List constraintRefs)
+ {
+ this.constraintRefs = constraintRefs;
+ }
+
+ public List getConstraints()
+ {
+ return this.constraints;
+ }
+
+ public void setConstraints(List constraints)
+ {
+ this.constraints = constraints;
+ }
+
+ @Override
+ public String toString()
+ {
+ StringBuilder builder = new StringBuilder(612);
+ builder.append("CustomModelProperty [name=").append(this.name)
+ .append(", prefixedName=").append(this.prefixedName)
+ .append(", title=").append(this.title)
+ .append(", description=").append(this.description)
+ .append(", dataType=").append(this.dataType)
+ .append(", isMandatory=").append(this.isMandatory)
+ .append(", isMandatoryEnforced=").append(this.isMandatoryEnforced)
+ .append(", isMultiValued=").append(this.isMultiValued)
+ .append(", defaultValue=").append(this.defaultValue)
+ .append(", isIndexed=").append(this.isIndexed)
+ .append(", facetable=").append(this.facetable)
+ .append(", indexTokenisationMode=").append(this.indexTokenisationMode)
+ .append(", constraintRefs=").append(this.constraintRefs)
+ .append(", constraints=").append(this.constraints)
+ .append(']');
+ return builder.toString();
+ }
+}
diff --git a/source/java/org/alfresco/rest/api/model/CustomType.java b/source/java/org/alfresco/rest/api/model/CustomType.java
new file mode 100644
index 0000000000..4e9f0e9d71
--- /dev/null
+++ b/source/java/org/alfresco/rest/api/model/CustomType.java
@@ -0,0 +1,60 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.model;
+
+import java.util.List;
+
+import org.alfresco.service.cmr.dictionary.TypeDefinition;
+import org.alfresco.service.cmr.i18n.MessageLookup;
+
+/**
+ * @author Jamal Kaabi-Mofrad
+ */
+public class CustomType extends AbstractClassModel
+{
+
+ public CustomType()
+ {
+ }
+
+ public CustomType(TypeDefinition typeDefinition, MessageLookup messageLookup, List properties)
+ {
+ this.name = typeDefinition.getName().getLocalName();
+ this.prefixedName = typeDefinition.getName().toPrefixString();
+ this.title = typeDefinition.getTitle(messageLookup);
+ this.description = typeDefinition.getDescription(messageLookup);
+ this.parentName = getParentNameAsString(typeDefinition.getParentName());
+ this.properties = setList(properties);
+ }
+
+ @Override
+ public String toString()
+ {
+ StringBuilder builder = new StringBuilder(512);
+ builder.append("CustomType [name=").append(this.name)
+ .append(", prefixedName=").append(this.prefixedName)
+ .append(", title=").append(this.title)
+ .append(", description=").append(this.description)
+ .append(", parentName=").append(parentName)
+ .append(", properties=").append(properties)
+ .append(']');
+ return builder.toString();
+ }
+}
diff --git a/source/test-java/org/alfresco/RemoteApi01TestSuite.java b/source/test-java/org/alfresco/RemoteApi01TestSuite.java
index 642670e5c5..13a3e80117 100644
--- a/source/test-java/org/alfresco/RemoteApi01TestSuite.java
+++ b/source/test-java/org/alfresco/RemoteApi01TestSuite.java
@@ -93,4 +93,9 @@ public class RemoteApi01TestSuite extends TestSuite
suite.addTest(new JUnit4TestAdapter(org.alfresco.rest.workflow.api.tests.ProcessWorkflowApiTest.class));
suite.addTest(new JUnit4TestAdapter(org.alfresco.rest.workflow.api.tests.TaskWorkflowApiTest.class));
}
+
+ static void tests8(TestSuite suite) //
+ {
+ suite.addTest(org.alfresco.rest.api.tests.CMMApiTestSuite.suite());
+ }
}
\ No newline at end of file
diff --git a/source/test-java/org/alfresco/repo/web/scripts/WebScriptTestSuite.java b/source/test-java/org/alfresco/repo/web/scripts/WebScriptTestSuite.java
index ac1177e144..04b99c8c5d 100644
--- a/source/test-java/org/alfresco/repo/web/scripts/WebScriptTestSuite.java
+++ b/source/test-java/org/alfresco/repo/web/scripts/WebScriptTestSuite.java
@@ -28,6 +28,7 @@ import org.alfresco.repo.web.scripts.admin.AdminWebScriptTest;
import org.alfresco.repo.web.scripts.audit.AuditWebScriptTest;
import org.alfresco.repo.web.scripts.blogs.BlogServiceTest;
import org.alfresco.repo.web.scripts.comment.CommentsApiTest;
+import org.alfresco.repo.web.scripts.custommodel.CustomModelImportTest;
import org.alfresco.repo.web.scripts.dictionary.DictionaryRestApiTest;
import org.alfresco.repo.web.scripts.discussion.DiscussionRestApiTest;
import org.alfresco.repo.web.scripts.facet.FacetRestApiTest;
@@ -98,12 +99,13 @@ public class WebScriptTestSuite extends TestSuite
suite.addTestSuite( SOLRWebScriptTest.class );
suite.addTestSuite( SubscriptionServiceRestApiTest.class );
suite.addTestSuite( FacetRestApiTest.class );
- suite.addTestSuite( CommentsApiTest.class );
+ suite.addTestSuite( CommentsApiTest.class );
suite.addTestSuite( DeclarativeSpreadsheetWebScriptTest.class );
suite.addTestSuite( XssVulnerabilityTest.class );
suite.addTestSuite( LinksRestApiTest.class );
suite.addTestSuite( RemoteFileFolderLoaderTest.class );
suite.addTestSuite( ReadOnlyTransactionInGetRestApiTest.class );
+ suite.addTestSuite( CustomModelImportTest.class );
// This uses a slightly different context
// As such, we can't run it in the same suite as the others,
// due to finalisers closing caches when we're not looking
diff --git a/source/test-java/org/alfresco/repo/web/scripts/custommodel/CustomModelImportTest.java b/source/test-java/org/alfresco/repo/web/scripts/custommodel/CustomModelImportTest.java
new file mode 100644
index 0000000000..512e22dcf5
--- /dev/null
+++ b/source/test-java/org/alfresco/repo/web/scripts/custommodel/CustomModelImportTest.java
@@ -0,0 +1,487 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.repo.web.scripts.custommodel;
+
+import java.io.BufferedOutputStream;
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipFile;
+import java.util.zip.ZipOutputStream;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.repo.dictionary.CustomModelServiceImpl;
+import org.alfresco.repo.dictionary.M2Association;
+import org.alfresco.repo.dictionary.M2Model;
+import org.alfresco.repo.dictionary.M2Type;
+import org.alfresco.repo.security.authentication.AuthenticationUtil;
+import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
+import org.alfresco.repo.transaction.RetryingTransactionHelper;
+import org.alfresco.repo.web.scripts.BaseWebScriptTest;
+import org.alfresco.service.cmr.dictionary.CustomModelService;
+import org.alfresco.service.cmr.security.AuthorityService;
+import org.alfresco.service.cmr.security.AuthorityType;
+import org.alfresco.service.cmr.security.MutableAuthenticationService;
+import org.alfresco.service.cmr.security.PersonService;
+import org.alfresco.service.namespace.NamespaceService;
+import org.alfresco.service.namespace.QName;
+import org.alfresco.util.PropertyMap;
+import org.alfresco.util.TempFileProvider;
+import org.alfresco.util.XMLUtil;
+import org.apache.commons.httpclient.methods.multipart.FilePart;
+import org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity;
+import org.apache.commons.httpclient.methods.multipart.Part;
+import org.apache.commons.httpclient.params.HttpMethodParams;
+import org.json.JSONObject;
+import org.json.JSONTokener;
+import org.springframework.extensions.webscripts.TestWebScriptServer.PostRequest;
+import org.springframework.extensions.webscripts.TestWebScriptServer.Response;
+import org.springframework.util.ResourceUtils;
+import org.w3c.dom.Document;
+import org.w3c.dom.NodeList;
+
+/**
+ * This class tests the custom model upload REST API.
+ *
+ * @author Jamal Kaabi-Mofrad
+ */
+public class CustomModelImportTest extends BaseWebScriptTest
+{
+ private static final String NON_ADMIN_USER = "nonAdminUserName";
+ private static final String CUSTOM_MODEL_ADMIN = "customModelAdmin";
+ private static final String RESOURCE_PREFIX = "custommodel/";
+ private static final String UPLOAD_URL = "/api/cmm/upload";
+ private static final int BUFFER_SIZE = 20 * 1024;
+
+ private MutableAuthenticationService authenticationService;
+ private AuthorityService authorityService;
+ private PersonService personService;
+ private RetryingTransactionHelper transactionHelper;
+ private CustomModelService customModelService;
+ private List importedModels = new ArrayList<>();
+ private List tempFiles = new ArrayList<>();
+
+ @Override
+ protected void setUp() throws Exception
+ {
+ super.setUp();
+ authenticationService = getServer().getApplicationContext().getBean("AuthenticationService", MutableAuthenticationService.class);
+ authorityService = getServer().getApplicationContext().getBean("AuthorityService", AuthorityService.class);
+ personService = getServer().getApplicationContext().getBean("PersonService", PersonService.class);
+ transactionHelper = getServer().getApplicationContext().getBean("retryingTransactionHelper", RetryingTransactionHelper.class);
+ customModelService = getServer().getApplicationContext().getBean("customModelService", CustomModelService.class);
+
+ AuthenticationUtil.clearCurrentSecurityContext();
+
+ AuthenticationUtil.runAsSystem(new RunAsWork()
+ {
+ @Override
+ public Void doWork() throws Exception
+ {
+ createUser(NON_ADMIN_USER);
+ createUser(CUSTOM_MODEL_ADMIN);
+
+ if (!authorityService.getContainingAuthorities(AuthorityType.GROUP, CUSTOM_MODEL_ADMIN, true).contains(
+ CustomModelServiceImpl.GROUP_ALFRESCO_MODEL_ADMINISTRATORS_AUTHORITY))
+ {
+ authorityService.addAuthority(CustomModelServiceImpl.GROUP_ALFRESCO_MODEL_ADMINISTRATORS_AUTHORITY, CUSTOM_MODEL_ADMIN);
+ }
+ return null;
+ }
+ });
+ AuthenticationUtil.setFullyAuthenticatedUser(CUSTOM_MODEL_ADMIN);
+ }
+
+ @Override
+ public void tearDown() throws Exception
+ {
+ for (File file : tempFiles)
+ {
+ file.delete();
+ }
+
+ transactionHelper.doInTransaction(new RetryingTransactionHelper.RetryingTransactionCallback()
+ {
+ public Void execute() throws Throwable
+ {
+ for (String modelName : importedModels)
+ {
+ customModelService.deleteCustomModel(modelName);
+ }
+ return null;
+ }
+ });
+
+ AuthenticationUtil.runAsSystem(new RunAsWork()
+ {
+ @Override
+ public Void doWork() throws Exception
+ {
+ transactionHelper.doInTransaction(new RetryingTransactionHelper.RetryingTransactionCallback()
+ {
+ public Void execute() throws Throwable
+ {
+ deleteUser(NON_ADMIN_USER);
+ deleteUser(CUSTOM_MODEL_ADMIN);
+ return null;
+ }
+ });
+ return null;
+ }
+ });
+
+ AuthenticationUtil.clearCurrentSecurityContext();
+
+ super.tearDown();
+ }
+
+ public void testValidUpload_ModelAndExtModule() throws Exception
+ {
+ File zipFile = getResourceFile("validModelAndExtModule.zip");
+ PostRequest postRequest = buildMultipartPostRequest(zipFile);
+
+ AuthenticationUtil.setFullyAuthenticatedUser(NON_ADMIN_USER);
+ Response response = sendRequest(postRequest, 403);
+
+ AuthenticationUtil.setFullyAuthenticatedUser(CUSTOM_MODEL_ADMIN);
+ response = sendRequest(postRequest, 200);
+
+ JSONObject json = new JSONObject(new JSONTokener(response.getContentAsString()));
+
+ String importedModelName = json.getString("modelName");
+ importedModels.add(importedModelName);
+
+ String extModule = json.getString("shareExtModule");
+ Document document = XMLUtil.parse(extModule);
+ NodeList nodes = document.getElementsByTagName("id");
+ assertEquals(1, nodes.getLength());
+ assertNotNull(nodes.item(0).getTextContent());
+ }
+
+ public void testValidUpload_ModelOnly() throws Exception
+ {
+ File zipFile = getResourceFile("validModel.zip");
+ PostRequest postRequest = buildMultipartPostRequest(zipFile);
+
+ AuthenticationUtil.setFullyAuthenticatedUser(NON_ADMIN_USER);
+ Response response = sendRequest(postRequest, 403);
+
+ AuthenticationUtil.setFullyAuthenticatedUser(CUSTOM_MODEL_ADMIN);
+ response = sendRequest(postRequest, 200);
+
+ JSONObject json = new JSONObject(new JSONTokener(response.getContentAsString()));
+ String importedModelName = json.getString("modelName");
+ importedModels.add(importedModelName);
+
+ assertFalse(json.has("shareExtModule"));
+
+ // Import the same model again
+ sendRequest(postRequest, 409); // name conflict
+ }
+
+ public void testValidUpload_ExtModuleOnly() throws Exception
+ {
+ File zipFile = getResourceFile("validExtModule.zip");
+ PostRequest postRequest = buildMultipartPostRequest(zipFile);
+
+ AuthenticationUtil.setFullyAuthenticatedUser(NON_ADMIN_USER);
+ Response response = sendRequest(postRequest, 403);
+
+ AuthenticationUtil.setFullyAuthenticatedUser(CUSTOM_MODEL_ADMIN);
+ response = sendRequest(postRequest, 200);
+
+ JSONObject json = new JSONObject(new JSONTokener(response.getContentAsString()));
+ assertFalse(json.has("modelName"));
+
+ String extModule = json.getString("shareExtModule");
+ Document document = XMLUtil.parse(extModule);
+ NodeList nodes = document.getElementsByTagName("id");
+ assertEquals(1, nodes.getLength());
+ assertNotNull(nodes.item(0).getTextContent());
+ }
+
+ public void testNotZipFileUpload() throws Exception
+ {
+ File file = getResourceFile("validModel.zip");
+ ZipFile zipFile = new ZipFile(file);
+ ZipEntry zipEntry = zipFile.entries().nextElement();
+
+ File unzippedModelFile = TempFileProvider.createTempFile(zipFile.getInputStream(zipEntry), "validModel", ".xml");
+ tempFiles.add(unzippedModelFile);
+ zipFile.close();
+
+ PostRequest postRequest = buildMultipartPostRequest(unzippedModelFile);
+ sendRequest(postRequest, 400); // CMM upload supports only zip file.
+ }
+
+ public void testInvalidZipUpload() throws Exception
+ {
+ String content = ""
+ + "Jane"
+ + "John"
+ + "Upload test"
+ + "This is an invalid model or a Share extension module"
+ +"";
+
+ ZipEntryContext context = new ZipEntryContext("invalidFormat.xml", content.getBytes());
+ File zipFile = createZip(context);
+
+ PostRequest postRequest = buildMultipartPostRequest(zipFile);
+ sendRequest(postRequest, 400); // Invalid. Neither a model nor a Share extension module file
+ }
+
+ public void testUploadModel_Invalid() throws Exception
+ {
+ long timestamp = System.currentTimeMillis();
+ final String modelName = getClass().getSimpleName() + timestamp;
+ final String prefix = "prefix" + timestamp;
+ final String uri = "uriNamespace" + timestamp;
+
+ M2Model model = M2Model.createModel(prefix + QName.NAMESPACE_PREFIX + modelName);
+ model.setAuthor("Admin");
+ model.setDescription("Desc");
+
+ ByteArrayOutputStream xml = new ByteArrayOutputStream();
+ model.toXML(xml);
+ ZipEntryContext context = new ZipEntryContext(modelName + ".xml", xml.toByteArray());
+ File zipFile = createZip(context);
+
+ PostRequest postRequest = buildMultipartPostRequest(zipFile);
+ sendRequest(postRequest, 409); // no namespace has been defined
+
+ // Create two namespaces
+ model.createNamespace(uri, prefix);
+ model.createNamespace(uri + "anotherUri", prefix + "anotherPrefix");
+ xml = new ByteArrayOutputStream();
+ model.toXML(xml);
+ context = new ZipEntryContext(modelName + ".xml", xml.toByteArray());
+ zipFile = createZip(context);
+
+ postRequest = buildMultipartPostRequest(zipFile);
+ sendRequest(postRequest, 409); // custom model can only have one namespace
+ }
+
+ public void testUploadModel_UnsupportedModelElements() throws Exception
+ {
+ // Note: here we only test a couple of not-supported model elements to check for the correct status code.
+ // This test should be removed when we implement the required support
+
+ long timestamp = System.currentTimeMillis();
+ final String modelName = getClass().getSimpleName() + timestamp;
+ final String prefix = "prefix"+timestamp;
+ final String uri = "uriNamespace"+timestamp;
+ final String aspectName = prefix + QName.NAMESPACE_PREFIX + "testAspec";
+ final String typeName = prefix + QName.NAMESPACE_PREFIX + "testType";
+ final String associationName = prefix + QName.NAMESPACE_PREFIX + "testAssociation";
+
+ M2Model model = M2Model.createModel(prefix + QName.NAMESPACE_PREFIX + modelName);
+ model.createNamespace(uri, prefix);
+ model.setAuthor("John Doe");
+ model.createAspect(aspectName);
+ model.createImport(NamespaceService.CONTENT_MODEL_1_0_URI, NamespaceService.CONTENT_MODEL_PREFIX);
+
+ M2Type type = model.createType(typeName);
+ // Add 'association' not supported yet.
+ M2Association association = type.createAssociation(associationName);
+ association.setSourceMandatory(false);
+ association.setSourceMany(false);
+ association.setTargetMandatory(false);
+ association.setTargetClassName("cm:content");
+
+ ByteArrayOutputStream xml = new ByteArrayOutputStream();
+ model.toXML(xml);
+ ZipEntryContext context = new ZipEntryContext(modelName + ".xml", xml.toByteArray());
+ File zipFile = createZip(context);
+
+ PostRequest postRequest = buildMultipartPostRequest(zipFile);
+ sendRequest(postRequest, 409); // element is not supported yet
+
+ type.removeAssociation(associationName);
+ // Add 'mandatory-aspect' not supported yet.
+ type.addMandatoryAspect(aspectName);
+ xml = new ByteArrayOutputStream();
+ model.toXML(xml);
+ context = new ZipEntryContext(modelName + ".xml", xml.toByteArray());
+ zipFile = createZip(context);
+
+ postRequest = buildMultipartPostRequest(zipFile);
+ sendRequest(postRequest, 409); // element is not supported yet
+ }
+
+ public void testInvalidNumberOfZipEntries() throws Exception
+ {
+ long timestamp = System.currentTimeMillis();
+ String modelName = getClass().getSimpleName() + timestamp;
+ String prefix = "prefix" + timestamp;
+ String uri = "uriNamespace" + timestamp;
+
+ // Model one
+ M2Model modelOne = M2Model.createModel(prefix + QName.NAMESPACE_PREFIX + modelName);
+ modelOne.createNamespace(uri, prefix);
+ modelOne.setDescription("Model 1");
+ ByteArrayOutputStream xml = new ByteArrayOutputStream();
+ modelOne.toXML(xml);
+ ZipEntryContext contextOne = new ZipEntryContext(modelName + ".xml", xml.toByteArray());
+
+ // Model two
+ modelName += "two";
+ prefix += "two";
+ uri += "two";
+ M2Model modelTwo = M2Model.createModel(prefix + QName.NAMESPACE_PREFIX + modelName);
+ modelTwo.createNamespace(uri, prefix);
+ modelTwo.setDescription("Model 2");
+ xml = new ByteArrayOutputStream();
+ modelTwo.toXML(xml);
+ ZipEntryContext contextTwo = new ZipEntryContext(modelName + ".xml", xml.toByteArray());
+
+ // Model three
+ modelName += "three";
+ prefix += "three";
+ uri += "three";
+ M2Model modelThree = M2Model.createModel(prefix + QName.NAMESPACE_PREFIX + modelName);
+ modelThree.createNamespace(uri, prefix);
+ modelThree.setDescription("Model 3");
+ xml = new ByteArrayOutputStream();
+ modelThree.toXML(xml);
+ ZipEntryContext contextThree = new ZipEntryContext(modelName + ".xml", xml.toByteArray());
+
+ File zipFile = createZip(contextOne, contextTwo, contextThree);
+
+ PostRequest postRequest = buildMultipartPostRequest(zipFile);
+ sendRequest(postRequest, 400); // more than two zip entries
+ }
+
+ public PostRequest buildMultipartPostRequest(File file) throws IOException
+ {
+ Part[] parts = { new FilePart("filedata", file.getName(), file, "application/zip", null) };
+
+ MultipartRequestEntity multipartRequestEntity = new MultipartRequestEntity(parts, new HttpMethodParams());
+
+ ByteArrayOutputStream os = new ByteArrayOutputStream();
+ multipartRequestEntity.writeRequest(os);
+
+ PostRequest postReq = new PostRequest(UPLOAD_URL, os.toByteArray(), multipartRequestEntity.getContentType());
+ return postReq;
+ }
+
+ private void createUser(String userName)
+ {
+ if (!authenticationService.authenticationExists(userName))
+ {
+ authenticationService.createAuthentication(userName, "PWD".toCharArray());
+ }
+
+ if (!personService.personExists(userName))
+ {
+ PropertyMap ppOne = new PropertyMap(4);
+ ppOne.put(ContentModel.PROP_USERNAME, userName);
+ ppOne.put(ContentModel.PROP_FIRSTNAME, "firstName");
+ ppOne.put(ContentModel.PROP_LASTNAME, "lastName");
+ ppOne.put(ContentModel.PROP_EMAIL, "email@email.com");
+ ppOne.put(ContentModel.PROP_JOBTITLE, "jobTitle");
+
+ personService.createPerson(ppOne);
+ }
+ }
+
+ private void deleteUser(String userName)
+ {
+ if (personService.personExists(userName))
+ {
+ personService.deletePerson(userName);
+ }
+ }
+
+ private File getResourceFile(String xmlFileName) throws FileNotFoundException
+ {
+ URL url = CustomModelImportTest.class.getClassLoader().getResource(RESOURCE_PREFIX + xmlFileName);
+ if (url == null)
+ {
+ fail("Cannot get the resource: " + xmlFileName);
+ }
+ return ResourceUtils.getFile(url);
+ }
+
+ private File createZip(ZipEntryContext... zipEntryContexts)
+ {
+ File zipFile = TempFileProvider.createTempFile(getClass().getSimpleName(), ".zip");
+ tempFiles.add(zipFile);
+
+ byte[] buffer = new byte[BUFFER_SIZE];
+ try
+ {
+ OutputStream out = new BufferedOutputStream(new FileOutputStream(zipFile), BUFFER_SIZE);
+ ZipOutputStream zos = new ZipOutputStream(out);
+
+ for (ZipEntryContext context : zipEntryContexts)
+ {
+ ZipEntry zipEntry = new ZipEntry(context.getZipEntryName());
+ zos.putNextEntry(zipEntry);
+
+ InputStream input = context.getEntryContent();
+ int len;
+ while ((len = input.read(buffer)) > 0)
+ {
+ zos.write(buffer, 0, len);
+ }
+ input.close();
+ }
+ zos.closeEntry();
+ zos.close();
+ }
+ catch (IOException ex)
+ {
+ fail("couldn't create zip file.");
+ }
+
+ return zipFile;
+ }
+
+ private static class ZipEntryContext
+ {
+ private final String zipEntryName;
+ private final InputStream entryContent;
+
+ public ZipEntryContext(String zipEntryName, byte[] zipEntryContent)
+ {
+ this.zipEntryName = zipEntryName;
+ this.entryContent = new ByteArrayInputStream(zipEntryContent);
+ }
+
+ public String getZipEntryName()
+ {
+ return this.zipEntryName;
+ }
+
+ public InputStream getEntryContent()
+ {
+ return this.entryContent;
+ }
+ }
+}
diff --git a/source/test-java/org/alfresco/rest/api/tests/BaseCustomModelApiTest.java b/source/test-java/org/alfresco/rest/api/tests/BaseCustomModelApiTest.java
new file mode 100644
index 0000000000..548f2d3285
--- /dev/null
+++ b/source/test-java/org/alfresco/rest/api/tests/BaseCustomModelApiTest.java
@@ -0,0 +1,432 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.tests;
+
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+import org.alfresco.repo.dictionary.CustomModelServiceImpl;
+import org.alfresco.repo.security.authentication.AuthenticationUtil;
+import org.alfresco.repo.transaction.RetryingTransactionHelper;
+import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
+import org.alfresco.rest.api.model.AbstractClassModel;
+import org.alfresco.rest.api.model.CustomAspect;
+import org.alfresco.rest.api.model.CustomModel;
+import org.alfresco.rest.api.model.CustomModelConstraint;
+import org.alfresco.rest.api.model.CustomModelNamedValue;
+import org.alfresco.rest.api.model.CustomModelProperty;
+import org.alfresco.rest.api.model.CustomType;
+import org.alfresco.rest.api.model.CustomModel.ModelStatus;
+import org.alfresco.rest.api.tests.RepoService.TestPerson;
+import org.alfresco.rest.api.tests.client.HttpResponse;
+import org.alfresco.rest.api.tests.client.RequestContext;
+import org.alfresco.rest.api.tests.client.PublicApiClient.Paging;
+import org.alfresco.rest.api.tests.util.RestApiUtil;
+import org.alfresco.service.cmr.dictionary.CustomModelDefinition;
+import org.alfresco.service.cmr.dictionary.CustomModelService;
+import org.alfresco.service.cmr.dictionary.NamespaceDefinition;
+import org.alfresco.service.cmr.security.AuthorityService;
+import org.alfresco.service.cmr.security.MutableAuthenticationService;
+import org.alfresco.service.cmr.security.PersonService;
+import org.alfresco.util.Pair;
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.junit.After;
+import org.junit.Before;
+
+/**
+ * Base class for CMM API tests
+ *
+ * @author Jamal Kaabi-Mofrad
+ */
+public class BaseCustomModelApiTest extends EnterpriseTestApi
+{
+ public static final String CMM_SCOPE = "private";
+ public static final String SELECT_PROPS_QS = "?select=props";
+ public static final String SELECT_STATUS_QS = "?select=status";
+ public static final String SELECT_ALL = "?select=all";
+ public static final String SELECT_ALL_PROPS = "?select=allProps";
+
+ protected String nonAdminUserName;
+ protected String customModelAdmin;
+
+ protected MutableAuthenticationService authenticationService;
+ protected PersonService personService;
+ protected CustomModelService customModelService;
+
+ private List users = new ArrayList<>();
+
+ @Before
+ public void setup() throws Exception
+ {
+ authenticationService = applicationContext.getBean("authenticationService", MutableAuthenticationService.class);
+ personService = applicationContext.getBean("personService", PersonService.class);
+ customModelService = applicationContext.getBean("customModelService", CustomModelService.class);
+
+ final AuthorityService authorityService = applicationContext.getBean("authorityService", AuthorityService.class);
+
+ this.nonAdminUserName = createUser("nonAdminUser" + System.currentTimeMillis());
+ this.customModelAdmin = createUser("customModelAdmin" + System.currentTimeMillis());
+ users.add(nonAdminUserName);
+ users.add(customModelAdmin);
+ // Add 'customModelAdmin' user into 'ALFRESCO_MODEL_ADMINISTRATORS' group
+ transactionHelper.doInTransaction(new RetryingTransactionCallback()
+ {
+ @Override
+ public Void execute() throws Throwable
+ {
+ authorityService.addAuthority(CustomModelServiceImpl.GROUP_ALFRESCO_MODEL_ADMINISTRATORS_AUTHORITY, customModelAdmin);
+ return null;
+ }
+ });
+ }
+
+ @After
+ public void tearDown() throws Exception
+ {
+ AuthenticationUtil.setAdminUserAsFullyAuthenticatedUser();
+ for (final String user : users)
+ {
+ transactionHelper.doInTransaction(new RetryingTransactionHelper.RetryingTransactionCallback()
+ {
+ @Override
+ public Void execute() throws Throwable
+ {
+ authenticationService.deleteAuthentication(user);
+ personService.deletePerson(user);
+ return null;
+ }
+ });
+ }
+ users.clear();
+ AuthenticationUtil.clearCurrentSecurityContext();
+ }
+
+ protected String createUser(String username)
+ {
+ PersonInfo personInfo = new PersonInfo(username, username, username, "password", null, null, null, null, null, null, null);
+ TestPerson person = repoService.createUser(personInfo, username, null);
+ return person.getId();
+ }
+
+ protected HttpResponse post(String url, String runAsUser, String body, int expectedStatus) throws Exception
+ {
+ publicApiClient.setRequestContext(new RequestContext(runAsUser));
+
+ HttpResponse response = publicApiClient.post(CMM_SCOPE, url, null, null, null, body);
+ checkStatus(expectedStatus, response.getStatusCode());
+
+ return response;
+ }
+
+ protected HttpResponse post(String url, String runAsUser, String body, String queryString, int expectedStatus) throws Exception
+ {
+ publicApiClient.setRequestContext(new RequestContext(runAsUser));
+ if (queryString != null)
+ {
+ url += queryString;
+ }
+ HttpResponse response = publicApiClient.post(CMM_SCOPE, url, null, null, null, body);
+ checkStatus(expectedStatus, response.getStatusCode());
+
+ return response;
+ }
+
+ protected HttpResponse getAll(String url, String runAsUser, Paging paging, int expectedStatus) throws Exception
+ {
+ publicApiClient.setRequestContext(new RequestContext(runAsUser));
+ Map params = (paging == null) ? null : createParams(paging, null);
+
+ HttpResponse response = publicApiClient.get(CMM_SCOPE, url, null, null, null, params);
+ checkStatus(expectedStatus, response.getStatusCode());
+
+ return response;
+ }
+
+ protected HttpResponse getSingle(String url, String runAsUser, String entityId, int expectedStatus) throws Exception
+ {
+ publicApiClient.setRequestContext(new RequestContext(runAsUser));
+
+ HttpResponse response = publicApiClient.get(CMM_SCOPE, url, entityId, null, null, null);
+ checkStatus(expectedStatus, response.getStatusCode());
+
+ return response;
+ }
+
+ protected HttpResponse put(String url, String runAsUser, String entityId, String body, String queryString, int expectedStatus) throws Exception
+ {
+ publicApiClient.setRequestContext(new RequestContext(runAsUser));
+ if (queryString != null)
+ {
+ entityId += queryString;
+ }
+ HttpResponse response = publicApiClient.put(CMM_SCOPE, url, entityId, null, null, body, null);
+ checkStatus(expectedStatus, response.getStatusCode());
+
+ return response;
+ }
+
+ protected HttpResponse delete(String url, String runAsUser, String entityId, int expectedStatus) throws Exception
+ {
+ publicApiClient.setRequestContext(new RequestContext(runAsUser));
+
+ HttpResponse response = publicApiClient.delete(CMM_SCOPE, url, entityId, null, null);
+ checkStatus(expectedStatus, response.getStatusCode());
+
+ return response;
+ }
+
+ protected void checkStatus(int expectedStatus, int actualStatus)
+ {
+ if (expectedStatus > 0 && expectedStatus != actualStatus)
+ {
+ fail("Status code " + actualStatus + " returned, but expected " + expectedStatus);
+ }
+ }
+
+ protected CustomModel createCustomModel(String modelName, Pair namespacePair, ModelStatus status) throws Exception
+ {
+ return createCustomModel(modelName, namespacePair, status, "Test model description", null);
+ }
+
+ protected CustomModel createCustomModel(String modelName, Pair namespacePair, ModelStatus status, String desc, String author)
+ throws Exception
+ {
+ CustomModel customModel = new CustomModel();
+ customModel.setName(modelName);
+ customModel.setNamespaceUri(namespacePair.getFirst());
+ customModel.setNamespacePrefix(namespacePair.getSecond());
+ customModel.setDescription(desc);
+ customModel.setStatus(status);
+ customModel.setAuthor(author);
+
+ // Create the model as a Model Administrator
+ HttpResponse response = post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 201);
+ CustomModel returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ if (author == null)
+ {
+ // ignore 'author' in the comparison
+ compareCustomModels(customModel, returnedModel, "author");
+ }
+ else
+ {
+ compareCustomModels(customModel, returnedModel);
+ }
+
+ return customModel;
+ }
+
+ protected T createTypeAspect(Class glazz, String modelName, String typeAspectName, String title, String desc,
+ String parent) throws Exception
+ {
+ AbstractClassModel classModel = null;
+ String uri = "cmm/" + modelName;
+ if (glazz.equals(CustomType.class))
+ {
+ classModel = new CustomType();
+ uri += "/types";
+ }
+ else
+ {
+ classModel = new CustomAspect();
+ uri += "/aspects";
+ }
+
+ classModel.setName(typeAspectName);
+ classModel.setDescription(desc);
+ classModel.setTitle(title);
+ classModel.setParentName(parent);
+
+ // Create type as a Model Administrator
+ HttpResponse response = post(uri, customModelAdmin, RestApiUtil.toJsonAsString(classModel), 201);
+ T returnedClassModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), glazz);
+
+ compareCustomTypesAspects(classModel, returnedClassModel, "prefixedName");
+
+ return returnedClassModel;
+ }
+
+ protected void compareCustomModels(CustomModel expectedModel, CustomModel actualModel, String... excludeFields)
+ {
+ boolean result = EqualsBuilder.reflectionEquals(expectedModel, actualModel, excludeFields);
+ assertTrue("Two models are not equal. Expected:<" + expectedModel.toString() + "> but was:<" + actualModel.toString() + ">", result);
+ }
+
+ protected void compareCustomTypesAspects(AbstractClassModel expectedDetails, AbstractClassModel actualDetails, String... excludeFields)
+ {
+ List expectedProps = expectedDetails.getProperties();
+ List actualProps = actualDetails.getProperties();
+ // Sort them
+ sortIfnotNull(expectedProps);
+ sortIfnotNull(actualProps);
+
+ boolean propEqualResult = true;
+ if (expectedProps.size() == actualProps.size())
+ {
+ for (int i = 0, size = expectedProps.size(); i < size; i++)
+ {
+ boolean equalProp = EqualsBuilder.reflectionEquals(expectedProps.get(i), actualProps.get(i), excludeFields);
+ if (!equalProp)
+ {
+ propEqualResult = false;
+ break;
+ }
+ }
+ }
+ else
+ {
+ propEqualResult = false;
+ }
+
+ if (excludeFields.length > 0)
+ {
+ int size = excludeFields.length;
+ excludeFields = Arrays.copyOf(excludeFields, size + 1);
+ excludeFields[size] = "properties";
+ }
+ boolean result = EqualsBuilder.reflectionEquals(expectedDetails, actualDetails, excludeFields);
+
+ String typesAspects = (expectedDetails instanceof CustomAspect) ? "aspects" : "types";
+ assertTrue("Two " + typesAspects + " are not equal. Expected:<" + expectedDetails.toString() + "> but was:<" + actualDetails.toString() + ">",
+ (result && propEqualResult));
+ }
+
+ protected void compareCustomModelConstraints(CustomModelConstraint expectedConstraint, CustomModelConstraint actualConstraint, String... excludeFields)
+ {
+ boolean result = EqualsBuilder.reflectionEquals(expectedConstraint, actualConstraint, excludeFields);
+ assertTrue("Two constraints are not equal. Expected:<" + expectedConstraint.toString() + "> but was:<" + actualConstraint.toString() + ">", result);
+ }
+
+ protected void compareCustomModelProperties(CustomModelProperty expectedProperty, CustomModelProperty actualProperty, String... excludeFields)
+ {
+ boolean result = EqualsBuilder.reflectionEquals(expectedProperty, actualProperty, excludeFields);
+ assertTrue("Two constraints are not equal. Expected:<" + expectedProperty.toString() + "> but was:<" + actualProperty.toString() + ">", result);
+ }
+
+ protected Pair getTestNamespaceUriPrefixPair()
+ {
+ long timeMillis = System.currentTimeMillis();
+ String uri = "http://www.alfresco.org/model/testcmmnamespace" + timeMillis + "/1.0";
+ String prefix = "testcmm" + timeMillis;
+
+ return new Pair(uri, prefix);
+ }
+
+ protected CustomModelDefinition getModelDefinition(final String modelName)
+ {
+ return transactionHelper.doInTransaction(new RetryingTransactionCallback()
+ {
+ @Override
+ public CustomModelDefinition execute() throws Throwable
+ {
+ return customModelService.getCustomModel(modelName);
+ }
+ });
+ }
+
+ protected void sortIfnotNull(List list)
+ {
+ if (list != null && list.size() > 0)
+ {
+ Collections.sort(list);
+ }
+ }
+
+ protected boolean hasNamespaceUri(Collection namespaces, String expectedNamespaceUri)
+ {
+ for (NamespaceDefinition ns : namespaces)
+ {
+ if (ns.getUri().equals(expectedNamespaceUri))
+ {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ protected boolean hasNamespacePrefix(Collection namespaces, String expectedNamespacePrefix)
+ {
+ for (NamespaceDefinition ns : namespaces)
+ {
+ if (ns.getPrefix().equals(expectedNamespacePrefix))
+ {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ protected CustomModelProperty getProperty(List properties, String propName)
+ {
+ for (CustomModelProperty prop : properties)
+ {
+ if (prop.getName().equals(propName))
+ {
+ return prop;
+ }
+ }
+ return null;
+ }
+
+ protected CustomModelNamedValue buildNamedValue(String name, String simpleValue, String... listValue)
+ {
+ CustomModelNamedValue namedValue = new CustomModelNamedValue();
+ namedValue.setName(name);
+ namedValue.setSimpleValue(simpleValue);
+ if (listValue.length > 0)
+ {
+ namedValue.setListValue(Arrays.asList(listValue));
+ }
+
+ return namedValue;
+ }
+
+ protected String getParameterSimpleValue(List params, String paramName)
+ {
+ for (CustomModelNamedValue p : params)
+ {
+ if (p.getName().equals(paramName))
+ {
+ return p.getSimpleValue();
+ }
+ }
+ return null;
+ }
+
+ protected List getParameterListValue(List params, String paramName)
+ {
+ for (CustomModelNamedValue p : params)
+ {
+ if (p.getName().equals(paramName))
+ {
+ return p.getListValue();
+ }
+ }
+ return null;
+ }
+}
diff --git a/source/test-java/org/alfresco/rest/api/tests/CMMApiTestSuite.java b/source/test-java/org/alfresco/rest/api/tests/CMMApiTestSuite.java
new file mode 100644
index 0000000000..f85915b0d9
--- /dev/null
+++ b/source/test-java/org/alfresco/rest/api/tests/CMMApiTestSuite.java
@@ -0,0 +1,47 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.tests;
+
+import junit.framework.JUnit4TestAdapter;
+import junit.framework.Test;
+import junit.framework.TestSuite;
+
+/**
+ * @author Jamal Kaabi-Mofrad
+ */
+public class CMMApiTestSuite extends TestSuite
+{
+ /**
+ * Creates the test suite
+ *
+ * @return the test suite
+ */
+ public static Test suite()
+ {
+ TestSuite suite = new TestSuite();
+ suite.addTest(new JUnit4TestAdapter(TestCustomModel.class));
+ suite.addTest(new JUnit4TestAdapter(TestCustomTypeAspect.class));
+ suite.addTest(new JUnit4TestAdapter(TestCustomProperty.class));
+ suite.addTest(new JUnit4TestAdapter(TestCustomConstraint.class));
+ suite.addTest(new JUnit4TestAdapter(TestCustomModelExport.class));
+
+ return suite;
+ }
+}
diff --git a/source/test-java/org/alfresco/rest/api/tests/TestCustomConstraint.java b/source/test-java/org/alfresco/rest/api/tests/TestCustomConstraint.java
new file mode 100644
index 0000000000..12c809f396
--- /dev/null
+++ b/source/test-java/org/alfresco/rest/api/tests/TestCustomConstraint.java
@@ -0,0 +1,1009 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.tests;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.repo.dictionary.constraint.AbstractConstraint;
+import org.alfresco.repo.tenant.TenantUtil;
+import org.alfresco.repo.tenant.TenantUtil.TenantRunAsWork;
+import org.alfresco.rest.api.model.CustomAspect;
+import org.alfresco.rest.api.model.CustomModel;
+import org.alfresco.rest.api.model.CustomModelConstraint;
+import org.alfresco.rest.api.model.CustomModelNamedValue;
+import org.alfresco.rest.api.model.CustomModelProperty;
+import org.alfresco.rest.api.model.CustomType;
+import org.alfresco.rest.api.model.CustomModel.ModelStatus;
+import org.alfresco.rest.api.tests.RepoService.SiteInformation;
+import org.alfresco.rest.api.tests.RepoService.TestNetwork;
+import org.alfresco.rest.api.tests.RepoService.TestPerson;
+import org.alfresco.rest.api.tests.RepoService.TestSite;
+import org.alfresco.rest.api.tests.client.HttpResponse;
+import org.alfresco.rest.api.tests.client.PublicApiClient.Paging;
+import org.alfresco.rest.api.tests.util.RestApiUtil;
+import org.alfresco.service.cmr.dictionary.ConstraintException;
+import org.alfresco.service.cmr.dictionary.CustomModelService;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.NodeService;
+import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter;
+import org.alfresco.service.cmr.site.SiteVisibility;
+import org.alfresco.service.namespace.QName;
+import org.alfresco.util.Pair;
+import org.junit.Test;
+
+/**
+ * Tests the REST API of the constraints of the {@link CustomModelService}.
+ *
+ * @author Jamal Kaabi-Mofrad
+ */
+public class TestCustomConstraint extends BaseCustomModelApiTest
+{
+
+ @Test
+ public void testCreateConstraints() throws Exception
+ {
+ final Paging paging = getPaging(0, Integer.MAX_VALUE);
+
+ String modelName = "testModelConstraint" + System.currentTimeMillis();
+ final Pair namespacePair = getTestNamespaceUriPrefixPair();
+ // Create the model as a Model Administrator
+ createCustomModel(modelName, namespacePair, ModelStatus.DRAFT);
+
+ // Create RegEx constraint
+ {
+ String regExConstraintName = "testFileNameRegEx" + System.currentTimeMillis();
+ CustomModelConstraint regExConstraint = new CustomModelConstraint();
+ regExConstraint.setName(regExConstraintName);
+ regExConstraint.setType("REGEX");
+ regExConstraint.setTitle("test RegEx title");
+ regExConstraint.setDescription("test RegEx desc");
+ // Create the RegEx constraint's parameters
+ List parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("expression", "(.*[\\\"\\*\\\\\\>\\<\\?\\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$)"));
+ parameters.add(buildNamedValue("requiresMatch", "false"));
+ // Add the parameters into the constraint
+ regExConstraint.setParameters(parameters);
+
+ // Try to create constraint as a non Admin user
+ post("cmm/" + modelName + "/constraints", nonAdminUserName, RestApiUtil.toJsonAsString(regExConstraint), 403);
+
+ // Create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(regExConstraint), 201);
+
+ // Retrieve the created RegEx constraint
+ HttpResponse response = getSingle("cmm/" + modelName + "/constraints", customModelAdmin, regExConstraintName, 200);
+ CustomModelConstraint returnedConstraint = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModelConstraint.class);
+ compareCustomModelConstraints(regExConstraint, returnedConstraint, "prefixedName");
+
+ // Try to create a duplicate constraint
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(regExConstraint), 409);
+
+ // Retrieve all the model's constraints
+ response = getAll("cmm/" + modelName + "/constraints", customModelAdmin, paging, 200);
+ List constraints = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModelConstraint.class);
+ assertEquals(1, constraints.size());
+ }
+
+ // Try to create invalid RegEx constraint
+ {
+ String regExConstraintName = "testFileNameInvalidRegEx" + System.currentTimeMillis();
+ CustomModelConstraint regExConstraint = new CustomModelConstraint();
+ regExConstraint.setName(regExConstraintName);
+ regExConstraint.setType("REGEX");
+ // Create the RegEx constraint's parameters
+ List parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("expression", "*******"));
+ parameters.add(buildNamedValue("requiresMatch", "false"));
+ // Add the parameters into the constraint
+ regExConstraint.setParameters(parameters);
+
+ // Try to create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(regExConstraint), 400);
+ }
+
+ // Create MINMAX constraint
+ {
+ String minMaxConstraintName = "testMinMaxConstraint" + System.currentTimeMillis();
+ CustomModelConstraint minMaxConstraint = new CustomModelConstraint();
+ minMaxConstraint.setName(minMaxConstraintName);
+ minMaxConstraint.setTitle("test MinMax title");
+ minMaxConstraint.setDescription("test MinMax desc");
+ // Create the MinMax constraint's parameters
+ List parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("maxValue", "100.0"));
+ parameters.add(buildNamedValue("minValue", "0.0"));
+ // Add the parameters into the constraint
+ minMaxConstraint.setParameters(parameters);
+
+ // Try to create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(minMaxConstraint), 400); // constraint's type is mandatory
+
+ minMaxConstraint.setType("MINMAX");
+ parameters.clear();
+ parameters.add(buildNamedValue("maxValue", "abc")); // invalid number
+ parameters.add(buildNamedValue("minValue", "0.0"));
+ // Add the parameters into the constraint
+ minMaxConstraint.setParameters(parameters);
+ // Try to create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(minMaxConstraint), 400);
+
+ parameters.clear();
+ parameters.add(buildNamedValue("maxValue", "100"));
+ parameters.add(buildNamedValue("minValue", "text")); // invalid number
+ // Add the parameters into the constraint
+ minMaxConstraint.setParameters(parameters);
+ // Try to create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(minMaxConstraint), 400);
+
+ parameters.clear();
+ parameters.add(buildNamedValue("maxValue", "100.0"));
+ parameters.add(buildNamedValue("minValue", "0.0"));
+ // Add the parameters into the constraint
+ minMaxConstraint.setParameters(parameters);
+ // Create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(minMaxConstraint), 201);
+
+ // Retrieve the created MINMAX constraint
+ HttpResponse response = getSingle("cmm/" + modelName + "/constraints", customModelAdmin, minMaxConstraintName, 200);
+ CustomModelConstraint returnedConstraint = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModelConstraint.class);
+ compareCustomModelConstraints(minMaxConstraint, returnedConstraint, "prefixedName");
+
+ // Retrieve all the model's constraints
+ response = getAll("cmm/" + modelName + "/constraints", customModelAdmin, paging, 200);
+ List constraints = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModelConstraint.class);
+ assertEquals(2, constraints.size());
+ }
+
+ // Create LENGTH constraint
+ {
+ String lengthConstraintName = "testLengthConstraint" + System.currentTimeMillis();
+ CustomModelConstraint lengthConstraint = new CustomModelConstraint();
+ lengthConstraint.setName(lengthConstraintName);
+ lengthConstraint.setType("LENGTH");
+ lengthConstraint.setTitle("test Length title");
+ lengthConstraint.setDescription("test Length desc");
+ // Create the Length constraint's parameters
+ List parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("maxLength", "text")); // invalid number
+ parameters.add(buildNamedValue("minLength", "0"));
+ // Add the parameters into the constraint
+ lengthConstraint.setParameters(parameters);
+
+ // Try to create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(lengthConstraint), 400);
+
+ parameters.clear();
+ parameters.add(buildNamedValue("maxLength", "256"));
+ parameters.add(buildNamedValue("minLength", "1.0")); // double number
+ // Add the parameters into the constraint
+ lengthConstraint.setParameters(parameters);
+ // Try to create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(lengthConstraint), 400);
+
+ parameters.clear();
+ parameters.add(buildNamedValue("maxLength", "256"));
+ parameters.add(buildNamedValue("minLength", "0"));
+ // Add the parameters into the constraint
+ lengthConstraint.setParameters(parameters);
+ // Create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(lengthConstraint), 201);
+
+ // Retrieve the created LENGTH constraint
+ HttpResponse response = getSingle("cmm/" + modelName + "/constraints", customModelAdmin, lengthConstraintName, 200);
+ CustomModelConstraint returnedConstraint = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModelConstraint.class);
+ compareCustomModelConstraints(lengthConstraint, returnedConstraint, "prefixedName");
+
+ // Retrieve all the model's constraints
+ response = getAll("cmm/" + modelName + "/constraints", customModelAdmin, paging, 200);
+ List constraints = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModelConstraint.class);
+ assertEquals(3, constraints.size());
+ }
+
+ // Create LIST constraint
+ {
+ String listConstraintName = "testListConstraint" + System.currentTimeMillis();
+ CustomModelConstraint listConstraint = new CustomModelConstraint();
+ listConstraint.setName(listConstraintName);
+ listConstraint.setType("LIST");
+ listConstraint.setTitle("test List title");
+ listConstraint.setDescription("test List desc");
+ // Create the List constraint's parameters
+ List parameters = new ArrayList<>(3);
+ parameters.add(buildNamedValue("allowedValues", null, "High", "Normal", "Low"));// list value
+ parameters.add(buildNamedValue("sorted", "false"));
+ // Add the parameters into the constraint
+ listConstraint.setParameters(parameters);
+
+ // Create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(listConstraint), 201);
+
+ // Retrieve the created List constraint
+ HttpResponse response = getSingle("cmm/" + modelName + "/constraints", customModelAdmin, listConstraintName, 200);
+ CustomModelConstraint returnedConstraint = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModelConstraint.class);
+ compareCustomModelConstraints(listConstraint, returnedConstraint, "prefixedName", "parameters");
+ String sorted = getParameterSimpleValue(returnedConstraint.getParameters(), "sorted");
+ assertEquals("false", sorted);
+ List listValues = getParameterListValue(returnedConstraint.getParameters(), "allowedValues");
+ assertNotNull(listValues);
+ assertEquals(3, listValues.size());
+ assertEquals("High", listValues.get(0));
+ assertEquals("Normal", listValues.get(1));
+ assertEquals("Low", listValues.get(2));
+
+ // Retrieve all the model's constraints
+ response = getAll("cmm/" + modelName + "/constraints", customModelAdmin, paging, 200);
+ List constraints = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModelConstraint.class);
+ assertEquals(4, constraints.size());
+ }
+
+ // Create authorityName constraint
+ {
+ String authorityNameConstraintName = "authorityNameConstraint" + System.currentTimeMillis();
+ CustomModelConstraint authorityNameConstraint = new CustomModelConstraint();
+ authorityNameConstraint.setName(authorityNameConstraintName);
+ authorityNameConstraint.setType("org.alfresco.repo.dictionary.constraint.AuthorityNameConstraint");
+ // Create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(authorityNameConstraint), 201);
+
+ // Retrieve the created authorityName constraint
+ HttpResponse response = getSingle("cmm/" + modelName + "/constraints", customModelAdmin, authorityNameConstraintName, 200);
+ CustomModelConstraint returnedConstraint = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModelConstraint.class);
+ compareCustomModelConstraints(authorityNameConstraint, returnedConstraint, "prefixedName");
+
+ // Retrieve all the model's constraints
+ response = getAll("cmm/" + modelName + "/constraints", customModelAdmin, paging, 200);
+ List constraints = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModelConstraint.class);
+ assertEquals(5, constraints.size());
+ }
+
+ // Create Invalid constraint
+ {
+ String invalidConstraintName = "testInvalidConstraint" + System.currentTimeMillis();
+ CustomModelConstraint invalidConstraint = new CustomModelConstraint();
+ invalidConstraint.setName(invalidConstraintName);
+ invalidConstraint.setType("InvalidConstraintType"+ System.currentTimeMillis());
+ invalidConstraint.setTitle("test Invalid title");
+ invalidConstraint.setDescription("test Invalid desc");
+ // Create the MinMax constraint's parameters
+ List parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("maxValue", "100.0"));
+ parameters.add(buildNamedValue("minValue", "0.0"));
+ // Add the parameters into the constraint
+ invalidConstraint.setParameters(parameters);
+
+ // Try to create an invalid constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(invalidConstraint), 400);
+
+ // Retrieve all the model's constraints
+ HttpResponse response = getAll("cmm/" + modelName + "/constraints", customModelAdmin, paging, 200);
+ List constraints = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModelConstraint.class);
+ assertEquals(5, constraints.size());
+ }
+
+ // Activate the model
+ CustomModel updatePayload = new CustomModel();
+ updatePayload.setStatus(ModelStatus.ACTIVE);
+ put("cmm", customModelAdmin, modelName, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 200);
+
+ // Retrieve all the model's constraints
+ HttpResponse response = getAll("cmm/" + modelName + "/constraints", customModelAdmin, paging, 200);
+ List constraints = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModelConstraint.class);
+ assertEquals(5, constraints.size());
+
+ // Deactivate the model
+ updatePayload = new CustomModel();
+ updatePayload.setStatus(ModelStatus.DRAFT);
+ put("cmm", customModelAdmin, modelName, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 200);
+
+ // Retrieve all the model's constraints
+ response = getAll("cmm/" + modelName + "/constraints", customModelAdmin, paging, 200);
+ constraints = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModelConstraint.class);
+ assertEquals(5, constraints.size());
+ }
+
+ @Test
+ public void testCreateConstraintAndAddToProperty() throws Exception
+ {
+ String modelName = "testModelConstraint" + System.currentTimeMillis();
+ final Pair namespacePair = getTestNamespaceUriPrefixPair();
+ // Create the model as a Model Administrator
+ createCustomModel(modelName, namespacePair, ModelStatus.DRAFT);
+
+ // Create RegEx constraint
+ String regExConstraintName = "testFileNameRegEx" + System.currentTimeMillis();
+ CustomModelConstraint regExConstraint = new CustomModelConstraint();
+ regExConstraint.setName(regExConstraintName);
+ regExConstraint.setType("REGEX");
+ regExConstraint.setTitle("test RegEx title");
+ regExConstraint.setDescription("test RegEx desc");
+ // Create the RegEx constraint's parameters
+ List parameters= new ArrayList<>(2);
+ parameters.add(buildNamedValue("expression", "(.*[\\\"\\*\\\\\\>\\<\\?\\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$)"));
+ parameters.add(buildNamedValue("requiresMatch", "false"));
+ // Add the parameters into the constraint
+ regExConstraint.setParameters(parameters);
+
+ // Create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(regExConstraint), 201);
+
+ // Retrieve the created constraint
+ HttpResponse response = getSingle("cmm/" + modelName + "/constraints", customModelAdmin, regExConstraintName, 200);
+ CustomModelConstraint returnedConstraint = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModelConstraint.class);
+
+ // Retrieve all the model's constraints
+ Paging paging = getPaging(0, Integer.MAX_VALUE);
+ response = getAll("cmm/" + modelName + "/constraints", customModelAdmin, paging, 200);
+ List constraints = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModelConstraint.class);
+ assertEquals(1, constraints.size());
+
+ // Create aspect
+ String aspectName = "testAspect1" + System.currentTimeMillis();
+ createTypeAspect(CustomAspect.class, modelName, aspectName, "title", "desc", null);
+
+ // Update the Aspect by adding property
+ CustomAspect payload = new CustomAspect();
+ payload.setName(aspectName);
+ final String aspectPropName = "testAspect1Prop1" + System.currentTimeMillis();
+ CustomModelProperty aspectProp = new CustomModelProperty();
+ aspectProp.setName(aspectPropName);
+ aspectProp.setTitle("property title");
+ aspectProp.setDataType("d:text");
+ aspectProp.setConstraintRefs(Arrays.asList(returnedConstraint.getPrefixedName()));// Add the constraint ref
+ List props = new ArrayList<>(1);
+ props.add(aspectProp);
+ payload.setProperties(props);
+
+ // Create the property
+ put("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, RestApiUtil.toJsonAsString(payload), SELECT_PROPS_QS, 200);
+
+ // Activate the model
+ CustomModel updatePayload = new CustomModel();
+ updatePayload.setStatus(ModelStatus.ACTIVE);
+ put("cmm", customModelAdmin, modelName, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 200);
+
+ // Retrieve all the model's constraints
+ // Test to see if the API took care of duplicate constraints when referencing a constraint within a property.
+ response = getAll("cmm/" + modelName + "/constraints", customModelAdmin, paging, 200);
+ constraints = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModelConstraint.class);
+ assertEquals(1, constraints.size());
+
+ // Test RegEx constrain enforcement
+ {
+ final NodeService nodeService = repoService.getNodeService();
+ final QName aspectQName = QName.createQName("{" + namespacePair.getFirst() + "}" + aspectName);
+
+ TestNetwork testNetwork = getTestFixture().getRandomNetwork();
+ TestPerson person = testNetwork.createUser();
+ final String siteName = "site" + System.currentTimeMillis();
+
+ TenantUtil.runAsUserTenant(new TenantRunAsWork()
+ {
+ @Override
+ public Void doWork() throws Exception
+ {
+ SiteInformation siteInfo = new SiteInformation(siteName, siteName, siteName, SiteVisibility.PRIVATE);
+ TestSite site = repoService.createSite(null, siteInfo);
+
+ NodeRef nodeRef = repoService.createDocument(site.getContainerNodeRef("documentLibrary"), "Test Doc", "Test Content");
+
+ nodeService.addAspect(nodeRef, aspectQName, null);
+ assertTrue(nodeService.hasAspect(nodeRef, aspectQName));
+
+ try
+ {
+ QName propQName = QName.createQName("{" + namespacePair.getFirst() + "}" + aspectPropName);
+ nodeService.setProperty(nodeRef, propQName, "Invalid$Char.");
+ fail("Invalid property value. Should have caused integrity violations.");
+ }
+ catch (Exception e)
+ {
+ // Expected
+ }
+
+ // Permanently remove model from repository
+ nodeService.addAspect(nodeRef, ContentModel.ASPECT_TEMPORARY, null);
+ nodeService.deleteNode(nodeRef);
+
+ return null;
+ }
+ }, person.getId(), testNetwork.getId());
+ }
+
+ // Deactivate the model
+ updatePayload = new CustomModel();
+ updatePayload.setStatus(ModelStatus.DRAFT);
+ put("cmm", customModelAdmin, modelName, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 200);
+
+ // Test update the namespace prefix (test to see if the API updates the constraints refs with this new prefix)
+ CustomModel updateModelPayload = new CustomModel();
+ String modifiedPrefix = namespacePair.getSecond() + "Modified";
+ updateModelPayload.setNamespacePrefix(modifiedPrefix);
+ updateModelPayload.setNamespaceUri(namespacePair.getFirst());
+ response = put("cmm", customModelAdmin, modelName, RestApiUtil.toJsonAsString(updateModelPayload), null, 200);
+ CustomModel returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ assertEquals(modifiedPrefix, returnedModel.getNamespacePrefix());
+ assertEquals("The namespace URI shouldn't have changed.", namespacePair.getFirst(), returnedModel.getNamespaceUri());
+
+ // Test update the namespace URI
+ updateModelPayload = new CustomModel();
+ updateModelPayload.setNamespacePrefix(modifiedPrefix);
+ String modifiedURI = namespacePair.getFirst() + "Modified";
+ updateModelPayload.setNamespaceUri(modifiedURI);
+ response = put("cmm", customModelAdmin, modelName, RestApiUtil.toJsonAsString(updateModelPayload), null, 200);
+ returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ assertEquals(modifiedURI, returnedModel.getNamespaceUri());
+ assertEquals("The namespace prefix shouldn't have changed.", modifiedPrefix, returnedModel.getNamespacePrefix());
+ }
+
+ @Test
+ public void testCreateInlineConstraint() throws Exception
+ {
+ String modelName = "testModelInlineConstraint" + System.currentTimeMillis();
+ final Pair namespacePair = getTestNamespaceUriPrefixPair();
+ // Create the model as a Model Administrator
+ createCustomModel(modelName, namespacePair, ModelStatus.DRAFT);
+
+ String regExConstraintName = "testInlineFileNameRegEx" + System.currentTimeMillis();
+ {
+ // Create RegEx constraint
+ CustomModelConstraint inlineRegExConstraint = new CustomModelConstraint();
+ inlineRegExConstraint.setName(regExConstraintName);
+ inlineRegExConstraint.setType("REGEX");
+ // Create the inline RegEx constraint's parameters
+ List parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("expression", "(.*[\\\"\\*\\\\\\>\\<\\?\\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$)"));
+ parameters.add(buildNamedValue("requiresMatch", "false"));
+ // Add the parameters into the constraint
+ inlineRegExConstraint.setParameters(parameters);
+
+ // Create aspect
+ String aspectName = "testAspect1" + System.currentTimeMillis();
+ createTypeAspect(CustomAspect.class, modelName, aspectName, "title", "desc", null);
+
+ // Update the Aspect by adding property
+ CustomAspect aspectPayload = new CustomAspect();
+ aspectPayload.setName(aspectName);
+ final String aspectPropName = "testAspect1Prop1" + System.currentTimeMillis();
+ CustomModelProperty aspectProp = new CustomModelProperty();
+ aspectProp.setName(aspectPropName);
+ aspectProp.setTitle("property title");
+ aspectProp.setDataType("d:text");
+ aspectProp.setConstraints(Arrays.asList(inlineRegExConstraint));// Add inline constraint
+ List props = new ArrayList<>(1);
+ props.add(aspectProp);
+ aspectPayload.setProperties(props);
+
+ // Create the property
+ put("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, RestApiUtil.toJsonAsString(aspectPayload), SELECT_PROPS_QS, 200);
+
+ // Retrieve all the model's constraints
+ Paging paging = getPaging(0, Integer.MAX_VALUE);
+ HttpResponse response = getAll("cmm/" + modelName + "/constraints", customModelAdmin, paging, 200);
+ List constraints = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModelConstraint.class);
+ assertEquals("Inline constraints should not be included with the model defined constraints.", 0, constraints.size());
+
+ // Retrieve the updated aspect
+ response = getSingle("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, 200);
+ CustomAspect returnedAspect = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomAspect.class);
+
+ // Check the aspect's added property
+ assertEquals(1, returnedAspect.getProperties().size());
+ CustomModelProperty customModelProperty = returnedAspect.getProperties().get(0);
+ assertEquals(aspectPropName, customModelProperty.getName());
+
+ assertEquals(0, customModelProperty.getConstraintRefs().size());
+ List inlineConstraints = customModelProperty.getConstraints();
+ assertEquals(1, inlineConstraints.size());
+ compareCustomModelConstraints(inlineRegExConstraint, inlineConstraints.get(0), "prefixedName");
+ }
+
+ // Create inline and referenced constraint
+ {
+ // Create RegEx constraint
+ CustomModelConstraint regExConstraint = new CustomModelConstraint();
+ regExConstraint.setName(regExConstraintName); // duplicate name
+ regExConstraint.setType("REGEX");
+ regExConstraint.setTitle("test RegEx title");
+ // Create the RegEx constraint's parameters
+ List parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("expression", "(.*[\\\"\\*\\\\\\>\\<\\?\\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$)"));
+ parameters.add(buildNamedValue("requiresMatch", "false"));
+ // Add the parameters into the constraint
+ regExConstraint.setParameters(parameters);
+
+ // Try to create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(regExConstraint), 409); // duplicate name
+
+ String newRegExConstraintName = "testFileNameRegEx" + System.currentTimeMillis();
+ regExConstraint.setName(newRegExConstraintName);
+ // Create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(regExConstraint), 201);
+ // Retrieve the created RegEx constraint
+ HttpResponse response = getSingle("cmm/" + modelName + "/constraints", customModelAdmin, newRegExConstraintName, 200);
+ CustomModelConstraint returnedRegExConstraint = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModelConstraint.class);
+
+ // Create inline anonymous LENGTH constraint
+ CustomModelConstraint inlineAnonymousLengthConstraint = new CustomModelConstraint();
+ inlineAnonymousLengthConstraint.setType("LENGTH");
+ inlineAnonymousLengthConstraint.setTitle("test Length title");
+ // Create the Length constraint's parameters
+ parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("maxLength", "256"));
+ parameters.add(buildNamedValue("minLength", "0"));
+ // Add the parameters into the constraint
+ inlineAnonymousLengthConstraint.setParameters(parameters);
+
+ // Create type
+ String typeName = "testType1" + System.currentTimeMillis();
+ CustomType type = createTypeAspect(CustomType.class, modelName, typeName, "test type1 title", "test type1 Desc", "cm:content");
+
+ // Update the Type by adding property
+ CustomType typePayload = new CustomType();
+ typePayload.setName(typeName);
+ String typePropName = "testType1Prop1" + System.currentTimeMillis();
+ CustomModelProperty typeProp = new CustomModelProperty();
+ typeProp.setName(typePropName);
+ typeProp.setTitle("property title");
+ typeProp.setDataType("d:int");
+ typeProp.setConstraintRefs(Arrays.asList(returnedRegExConstraint.getPrefixedName())); // Constraint Ref
+ typeProp.setConstraints(Arrays.asList(inlineAnonymousLengthConstraint)); // inline constraint
+ List props = new ArrayList<>(1);
+ props.add(typeProp);
+ typePayload.setProperties(props);
+
+ // Try to create the property - LENGTH constraint can only be used with textual data type
+ put("cmm/" + modelName + "/types", customModelAdmin, typeName, RestApiUtil.toJsonAsString(typePayload), SELECT_PROPS_QS, 400);
+
+ typeProp.setDataType("d:double");
+ // CTry to create the property - LENGTH constraint can only be used with textual data type
+ put("cmm/" + modelName + "/types", customModelAdmin, typeName, RestApiUtil.toJsonAsString(typePayload), SELECT_PROPS_QS, 400);
+
+ typeProp.setDataType("d:text");
+ put("cmm/" + modelName + "/types", customModelAdmin, typeName, RestApiUtil.toJsonAsString(typePayload), SELECT_PROPS_QS, 200);
+
+ // Retrieve the updated type
+ response = getSingle("cmm/" + modelName + "/types", customModelAdmin, type.getName(), 200);
+ CustomType returnedType = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomType.class);
+
+ // Check the type's added property
+ assertEquals(1, returnedType.getProperties().size());
+ CustomModelProperty customModelProperty = returnedType.getProperties().get(0);
+ assertEquals(typePropName, customModelProperty.getName());
+
+ assertEquals(1, customModelProperty.getConstraintRefs().size());
+ assertEquals(returnedRegExConstraint.getPrefixedName(), customModelProperty.getConstraintRefs().get(0));
+
+ assertEquals(1, customModelProperty.getConstraints().size());
+ assertNotNull(customModelProperty.getConstraints().get(0).getName()); // M2PropertyDefinition will add a name
+ compareCustomModelConstraints(inlineAnonymousLengthConstraint, customModelProperty.getConstraints().get(0), "prefixedName", "name");
+ }
+ }
+
+ @Test
+ public void testCreateListConstraintInvalid() throws Exception
+ {
+ String modelName = "testModelConstraintInvalid" + System.currentTimeMillis();
+ final Pair namespacePair = getTestNamespaceUriPrefixPair();
+ // Create the model as a Model Administrator
+ createCustomModel(modelName, namespacePair, ModelStatus.DRAFT);
+
+ // Create aspect
+ String aspectName = "testAspect" + System.currentTimeMillis();
+ createTypeAspect(CustomAspect.class, modelName, aspectName, "title", "desc", null);
+
+ // Update the Aspect by adding property
+ CustomAspect aspectPayload = new CustomAspect();
+ aspectPayload.setName(aspectName);
+ final String aspectPropName = "testAspect1Prop" + System.currentTimeMillis();
+ CustomModelProperty aspectProp = new CustomModelProperty();
+ aspectProp.setName(aspectPropName);
+ aspectProp.setTitle("property title");
+ aspectProp.setDataType("d:int");
+
+ //Create LIST constraint
+ String inlineListConstraintName = "testListConstraint" + System.currentTimeMillis();
+ CustomModelConstraint inlineListConstraint = new CustomModelConstraint();
+ inlineListConstraint.setName(inlineListConstraintName);
+ inlineListConstraint.setType("LIST");
+ inlineListConstraint.setTitle("test List title");
+ inlineListConstraint.setDescription("test List desc");
+ // Create the List constraint's parameters
+ List parameters = new ArrayList<>(3);
+ parameters.add(buildNamedValue("allowedValues", null, "a", "b", "c"));// text list value, but the the property data type is d:int
+ parameters.add(buildNamedValue("sorted", "false"));
+ // Add the parameters into the constraint
+ inlineListConstraint.setParameters(parameters);
+ aspectProp.setConstraints(Arrays.asList(inlineListConstraint));// Add inline constraint
+ List props = new ArrayList<>(1);
+ props.add(aspectProp);
+ aspectPayload.setProperties(props);
+
+ // Try to create the property - Invalid LIST values
+ put("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, RestApiUtil.toJsonAsString(aspectPayload), SELECT_PROPS_QS, 400);
+
+ // Test d:double LIST values with d:int property data type
+ parameters = new ArrayList<>(3);
+ parameters.add(buildNamedValue("allowedValues", null, "1.0", "2.0", "3.0"));// double list value, but the the property data type is d:int
+ parameters.add(buildNamedValue("sorted", "false"));
+ // Add the parameters into the constraint
+ inlineListConstraint.setParameters(parameters);
+ aspectProp.setConstraints(Arrays.asList(inlineListConstraint));// Add inline constraint
+ props = new ArrayList<>(1);
+ props.add(aspectProp);
+ aspectPayload.setProperties(props);
+
+ // Try to create the property - Invalid LIST values
+ put("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, RestApiUtil.toJsonAsString(aspectPayload), SELECT_PROPS_QS, 400);
+ }
+
+ @Test
+ public void testCreateMinMaxConstraintInvalid() throws Exception
+ {
+ String modelName = "testModelMinMaxInvalid" + System.currentTimeMillis();
+ final Pair namespacePair = getTestNamespaceUriPrefixPair();
+ // Create the model as a Model Administrator
+ createCustomModel(modelName, namespacePair, ModelStatus.DRAFT);
+
+ // Create aspect
+ String aspectName = "testAspect" + System.currentTimeMillis();
+ createTypeAspect(CustomAspect.class, modelName, aspectName, "title", "desc", null);
+
+ // Update the Aspect by adding property
+ CustomAspect aspectPayload = new CustomAspect();
+ aspectPayload.setName(aspectName);
+ final String aspectPropName = "testAspect1Prop" + System.currentTimeMillis();
+ CustomModelProperty aspectProp = new CustomModelProperty();
+ aspectProp.setName(aspectPropName);
+ aspectProp.setTitle("property title");
+ aspectProp.setDataType("d:text");
+
+ String minMaxConstraintName = "testMinMaxConstraint" + System.currentTimeMillis();
+ CustomModelConstraint minMaxConstraint = new CustomModelConstraint();
+ minMaxConstraint.setType("MINMAX");
+ minMaxConstraint.setName(minMaxConstraintName);
+ minMaxConstraint.setTitle("test MinMax title");
+ minMaxConstraint.setDescription("test MinMax desc");
+ // Create the MinMax constraint's parameters
+ List parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("maxValue", "100.0"));
+ parameters.add(buildNamedValue("minValue", "0.0"));
+ // Add the parameters into the constraint
+ minMaxConstraint.setParameters(parameters);
+
+ aspectProp.setConstraints(Arrays.asList(minMaxConstraint));// Add inline constraint
+ List props = new ArrayList<>(1);
+ props.add(aspectProp);
+ aspectPayload.setProperties(props);
+
+ // Try to create constraint as a Model Administrator
+ // MINMAX constraint can only be used with numeric data type.
+ put("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, RestApiUtil.toJsonAsString(aspectPayload), SELECT_PROPS_QS, 400);
+
+ // Change type
+ aspectProp.setDataType("d:datetime");
+ // MINMAX constraint can only be used with numeric data type.
+ put("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, RestApiUtil.toJsonAsString(aspectPayload), SELECT_PROPS_QS, 400);
+
+ // SHA-1126
+ {
+ //Change type
+ aspectProp.setDataType("d:double");
+ parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("maxValue", "0.0"));
+ parameters.add(buildNamedValue("minValue", "-5.0"));
+ // Add the parameters into the constraint
+ minMaxConstraint.setParameters(parameters);
+
+ aspectProp.setConstraints(Arrays.asList(minMaxConstraint));// Add inline constraint
+ props = new ArrayList<>(1);
+ props.add(aspectProp);
+ aspectPayload.setProperties(props);
+ // Maximum value of the MINMAX constraint must be a positive nonzero value.
+ put("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, RestApiUtil.toJsonAsString(aspectPayload), SELECT_PROPS_QS, 400);
+ }
+ }
+
+ @Test
+ public void testPropDefaultValueWithInlineConstraint() throws Exception
+ {
+ String modelName = "testModelInlineConstraint" + System.currentTimeMillis();
+ final Pair namespacePair = getTestNamespaceUriPrefixPair();
+ // Create the model as a Model Administrator
+ createCustomModel(modelName, namespacePair, ModelStatus.DRAFT);
+
+ {
+ // Create RegEx constraint
+ String regExConstraintName = "testInlineFileNameRegEx" + System.currentTimeMillis();
+ CustomModelConstraint inlineRegExConstraint = new CustomModelConstraint();
+ inlineRegExConstraint.setName(regExConstraintName);
+ inlineRegExConstraint.setType("REGEX");
+ // Create the inline RegEx constraint's parameters
+ List parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("expression", "(.*[\\\"\\*\\\\\\>\\<\\?\\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$)"));
+ parameters.add(buildNamedValue("requiresMatch", "false"));
+ // Add the parameters into the constraint
+ inlineRegExConstraint.setParameters(parameters);
+
+ // Create aspect
+ String aspectName = "testAspect1" + System.currentTimeMillis();
+ createTypeAspect(CustomAspect.class, modelName, aspectName, "title", "desc", null);
+
+ // Update the Aspect by adding property
+ CustomAspect aspectPayload = new CustomAspect();
+ aspectPayload.setName(aspectName);
+ final String aspectPropName = "testAspect1Prop1" + System.currentTimeMillis();
+ CustomModelProperty aspectProp = new CustomModelProperty();
+ aspectProp.setName(aspectPropName);
+ aspectProp.setTitle("property with REGEX constraint");
+ aspectProp.setDataType("d:text");
+ aspectProp.setDefaultValue("invalid props = new ArrayList<>(1);
+ props.add(aspectProp);
+ aspectPayload.setProperties(props);
+
+ // Try to create the property - constraint violation
+ put("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, RestApiUtil.toJsonAsString(aspectPayload), SELECT_PROPS_QS, 409);
+ }
+
+ {
+ // Create inline anonymous LENGTH constraint
+ CustomModelConstraint inlineAnonymousLengthConstraint = new CustomModelConstraint();
+ inlineAnonymousLengthConstraint.setType("LENGTH");
+ // Create the Length constraint's parameters
+ Listparameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("maxLength", "4"));
+ parameters.add(buildNamedValue("minLength", "0"));
+ // Add the parameters into the constraint
+ inlineAnonymousLengthConstraint.setParameters(parameters);
+
+ // Create type
+ String typeName = "testType1" + System.currentTimeMillis();
+ createTypeAspect(CustomType.class, modelName, typeName, "test type1 title", "test type1 Desc", "cm:content");
+
+ // Update the Type by adding property
+ CustomType typePayload = new CustomType();
+ typePayload.setName(typeName);
+ String typePropName = "testType1Prop1" + System.currentTimeMillis();
+ CustomModelProperty typeProp = new CustomModelProperty();
+ typeProp.setName(typePropName);
+ typeProp.setTitle("property with LENGTH constraint");
+ typeProp.setDataType("d:text");
+ typeProp.setDefaultValue("abcdef"); // Invalid length
+ typeProp.setConstraints(Arrays.asList(inlineAnonymousLengthConstraint)); // inline constraint
+ List props = new ArrayList<>(1);
+ props.add(typeProp);
+ typePayload.setProperties(props);
+
+ // Try to create the property - constraint violation
+ put("cmm/" + modelName + "/types", customModelAdmin, typeName, RestApiUtil.toJsonAsString(typePayload), SELECT_PROPS_QS, 409);
+ }
+
+ {
+ // Create inline anonymous MINMAX constraint
+ CustomModelConstraint inlineAnonymousMinMaxConstraint = new CustomModelConstraint();
+ inlineAnonymousMinMaxConstraint.setType("MINMAX");
+ // Create the MinMax constraint's parameters
+ Listparameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("maxValue", "10"));
+ parameters.add(buildNamedValue("minValue", "0"));
+ // Add the parameters into the constraint
+ inlineAnonymousMinMaxConstraint.setParameters(parameters);
+
+ // Create type
+ String typeName = "testType1" + System.currentTimeMillis();
+ createTypeAspect(CustomType.class, modelName, typeName, "test type1 title", "test type1 Desc", "cm:content");
+
+ // Update the Type by adding property
+ CustomType typePayload = new CustomType();
+ typePayload.setName(typeName);
+ String typePropName = "testType1Prop1" + System.currentTimeMillis();
+ CustomModelProperty typeProp = new CustomModelProperty();
+ typeProp.setName(typePropName);
+ typeProp.setTitle("property with MINMAX constraint");
+ typeProp.setDataType("d:int");
+ typeProp.setDefaultValue("20"); // Not in the defined range [0,10]
+ typeProp.setConstraints(Arrays.asList(inlineAnonymousMinMaxConstraint)); // inline constraint
+ List props = new ArrayList<>(1);
+ props.add(typeProp);
+ typePayload.setProperties(props);
+
+ // Try to create the property - constraint violation
+ put("cmm/" + modelName + "/types", customModelAdmin, typeName, RestApiUtil.toJsonAsString(typePayload), SELECT_PROPS_QS, 409);
+ }
+
+ {
+ // Create LIST constraint
+ String listConstraintName = "testListConstraint" + System.currentTimeMillis();
+ CustomModelConstraint inlineListConstraint = new CustomModelConstraint();
+ inlineListConstraint.setName(listConstraintName);
+ inlineListConstraint.setType("LIST");
+ // Create the List constraint's parameters
+ List parameters = new ArrayList<>(3);
+ parameters.add(buildNamedValue("allowedValues", null, "one", "two", "three"));
+ parameters.add(buildNamedValue("sorted", "false"));
+ // Add the parameters into the constraint
+ inlineListConstraint.setParameters(parameters);
+
+ // Create aspect
+ String aspectName = "testAspect" + System.currentTimeMillis();
+ createTypeAspect(CustomAspect.class, modelName, aspectName, "title", "desc", null);
+
+ // Update the Aspect by adding property
+ CustomAspect aspectPayload = new CustomAspect();
+ aspectPayload.setName(aspectName);
+ final String aspectPropName = "testAspect1Prop" + System.currentTimeMillis();
+ CustomModelProperty aspectProp = new CustomModelProperty();
+ aspectProp.setName(aspectPropName);
+ aspectProp.setTitle("property with LIST constraint");
+ aspectProp.setDataType("d:text");
+ aspectProp.setDefaultValue("four"); // Not in the list
+ aspectProp.setConstraints(Arrays.asList(inlineListConstraint));// Add inline constraint
+ List props = new ArrayList<>(1);
+ props.add(aspectProp);
+ aspectPayload.setProperties(props);
+
+ // Try to create the property - constraint violation
+ put("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, RestApiUtil.toJsonAsString(aspectPayload), SELECT_PROPS_QS, 409);
+ }
+
+ {
+ // Create Java Class constraint
+ String inlineJavaClassConstraintName = "testJavaClassConstraint" + System.currentTimeMillis();
+ CustomModelConstraint inlineListConstraint = new CustomModelConstraint();
+ inlineListConstraint.setName(inlineJavaClassConstraintName);
+ inlineListConstraint.setType("org.alfresco.rest.api.tests.TestCustomConstraint$DummyJavaClassConstraint");
+
+ // Create aspect
+ String aspectName = "testAspect" + System.currentTimeMillis();
+ createTypeAspect(CustomAspect.class, modelName, aspectName, "title", "desc", null);
+
+ // Update the Aspect by adding property
+ CustomAspect aspectPayload = new CustomAspect();
+ aspectPayload.setName(aspectName);
+ final String aspectPropName = "testAspect1Prop" + System.currentTimeMillis();
+ CustomModelProperty aspectProp = new CustomModelProperty();
+ aspectProp.setName(aspectPropName);
+ aspectProp.setTitle("property with Java Class constraint");
+ aspectProp.setDataType("d:text");
+ aspectProp.setDefaultValue("invalid#value"); // Invalid default value
+ aspectProp.setConstraints(Arrays.asList(inlineListConstraint));// Add inline constraint
+ List props = new ArrayList<>(1);
+ props.add(aspectProp);
+ aspectPayload.setProperties(props);
+
+ // Try to create the property - constraint violation
+ put("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, RestApiUtil.toJsonAsString(aspectPayload), SELECT_PROPS_QS, 409);
+ }
+ }
+
+ @Test
+ public void testPropDefaultValueWithConstraintRef() throws Exception
+ {
+ String modelName = "testModelConstraintRef" + System.currentTimeMillis();
+ final Pair namespacePair = getTestNamespaceUriPrefixPair();
+ // Create the model as a Model Administrator
+ createCustomModel(modelName, namespacePair, ModelStatus.DRAFT);
+
+ {
+ // Create List constraint
+ String listConstraintName = "testListConstraint" + System.currentTimeMillis();
+ CustomModelConstraint listConstraint = new CustomModelConstraint();
+ listConstraint.setName(listConstraintName);
+ listConstraint.setType("LIST");
+ // Create the List constraint's parameters
+ List parameters = new ArrayList<>(3);
+ parameters.add(buildNamedValue("allowedValues", null, "London", "Paris", "New York"));// list value
+ parameters.add(buildNamedValue("sorted", "false"));
+ // Add the parameters into the constraint
+ listConstraint.setParameters(parameters);
+
+ // Create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(listConstraint), 201);
+ // Retrieve the created List constraint
+ HttpResponse response = getSingle("cmm/" + modelName + "/constraints", customModelAdmin, listConstraintName, 200);
+ CustomModelConstraint returnedConstraint = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModelConstraint.class);
+
+ // Create aspect
+ String aspectName = "testAspect" + System.currentTimeMillis();
+ createTypeAspect(CustomAspect.class, modelName, aspectName, "title", "desc", null);
+
+ // Update the Aspect by adding property
+ CustomAspect aspectPayload = new CustomAspect();
+ aspectPayload.setName(aspectName);
+ final String aspectPropName = "testAspect1Prop" + System.currentTimeMillis();
+ CustomModelProperty aspectProp = new CustomModelProperty();
+ aspectProp.setName(aspectPropName);
+ aspectProp.setTitle("property with LIST constraint ref");
+ aspectProp.setDataType("d:text");
+ aspectProp.setDefaultValue("Berlin"); // Not in the list
+ aspectProp.setConstraintRefs(Arrays.asList(returnedConstraint.getPrefixedName())); // constrain ref
+ List props = new ArrayList<>(1);
+ props.add(aspectProp);
+ aspectPayload.setProperties(props);
+
+ // Try to create the property - constraint violation
+ put("cmm/" + modelName + "/aspects", customModelAdmin, aspectName, RestApiUtil.toJsonAsString(aspectPayload), SELECT_PROPS_QS, 409);
+ }
+
+ {
+ // Create MINMAX constraint
+ String minMaxConstraintName = "testMinMaxConstraint" + System.currentTimeMillis();
+ CustomModelConstraint minMaxConstraint = new CustomModelConstraint();
+ minMaxConstraint.setName(minMaxConstraintName);
+ minMaxConstraint.setType("MINMAX");
+ // Create the MinMax constraint's parameters
+ List parameters = new ArrayList<>(2);
+ parameters.add(buildNamedValue("maxValue", "100"));
+ parameters.add(buildNamedValue("minValue", "50"));
+ // Add the parameters into the constraint
+ minMaxConstraint.setParameters(parameters);
+
+ // Create constraint as a Model Administrator
+ post("cmm/" + modelName + "/constraints", customModelAdmin, RestApiUtil.toJsonAsString(minMaxConstraint), 201);
+ // Retrieve the created MinMax constraint
+ HttpResponse response = getSingle("cmm/" + modelName + "/constraints", customModelAdmin, minMaxConstraintName, 200);
+ CustomModelConstraint returnedConstraint = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModelConstraint.class);
+
+ // Create type
+ String typeName = "testType1" + System.currentTimeMillis();
+ createTypeAspect(CustomType.class, modelName, typeName, "test type1 title", "test type1 Desc", "cm:content");
+
+ // Update the Type by adding property
+ CustomType typePayload = new CustomType();
+ typePayload.setName(typeName);
+ String typePropName = "testType1Prop1" + System.currentTimeMillis();
+ CustomModelProperty typeProp = new CustomModelProperty();
+ typeProp.setName(typePropName);
+ typeProp.setTitle("property with MINMAX constraint ref");
+ typeProp.setDataType("d:int");
+ typeProp.setDefaultValue("35"); // Not in the defined range [50,100]
+ typeProp.setConstraintRefs(Arrays.asList(returnedConstraint.getPrefixedName())); // constrain ref
+ List props = new ArrayList<>(1);
+ props.add(typeProp);
+ typePayload.setProperties(props);
+
+ // Try to create the property - constraint violation
+ put("cmm/" + modelName + "/types", customModelAdmin, typeName, RestApiUtil.toJsonAsString(typePayload), SELECT_PROPS_QS, 409);
+ }
+ }
+
+ public static class DummyJavaClassConstraint extends AbstractConstraint
+ {
+ @Override
+ protected void evaluateSingleValue(Object value)
+ {
+ String checkValue = DefaultTypeConverter.INSTANCE.convert(String.class, value);
+
+ if (checkValue.contains("#"))
+ {
+ throw new ConstraintException("The value must not contain '#'");
+ }
+ }
+ }
+}
diff --git a/source/test-java/org/alfresco/rest/api/tests/TestCustomModel.java b/source/test-java/org/alfresco/rest/api/tests/TestCustomModel.java
new file mode 100644
index 0000000000..4061bef4c4
--- /dev/null
+++ b/source/test-java/org/alfresco/rest/api/tests/TestCustomModel.java
@@ -0,0 +1,661 @@
+/*
+ * 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 .
+ */
+
+package org.alfresco.rest.api.tests;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import java.util.List;
+
+import org.alfresco.rest.api.model.CustomAspect;
+import org.alfresco.rest.api.model.CustomModel;
+import org.alfresco.rest.api.model.CustomModel.ModelStatus;
+import org.alfresco.rest.api.model.CustomType;
+import org.alfresco.rest.api.tests.client.HttpResponse;
+import org.alfresco.rest.api.tests.client.PublicApiClient.Paging;
+import org.alfresco.rest.api.tests.util.RestApiUtil;
+import org.alfresco.service.cmr.dictionary.CustomModelService;
+import org.alfresco.service.namespace.QName;
+import org.alfresco.util.Pair;
+import org.junit.Test;
+
+/**
+ * Tests the REST API of the models of the {@link CustomModelService}.
+ *
+ * @author Jamal Kaabi-Mofrad
+ */
+public class TestCustomModel extends BaseCustomModelApiTest
+{
+
+ @Test
+ public void testCreateBasicModel() throws Exception
+ {
+ String modelName = "testModel" + System.currentTimeMillis();
+ Pair namespacePair = getTestNamespaceUriPrefixPair();
+
+ CustomModel customModel = new CustomModel();
+ customModel.setName(modelName);
+ customModel.setNamespaceUri(namespacePair.getFirst());
+ customModel.setNamespacePrefix(namespacePair.getSecond());
+ customModel.setDescription("Test model description");
+ customModel.setStatus(CustomModel.ModelStatus.DRAFT);
+
+ // Try to create the model as a non Admin user
+ post("cmm", nonAdminUserName, RestApiUtil.toJsonAsString(customModel), 403);
+
+ // Create the model as a Model Administrator
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 201);
+
+ // Retrieve the created model
+ HttpResponse response = getSingle("cmm", customModelAdmin, modelName, 200);
+ CustomModel returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ // Check the retrieved model is the expected model.
+ // Note: since we didn't specify the Author when created the Model,
+ // we have to exclude it from the objects comparison. Because,
+ // the system will add the current authenticated user as the author
+ // of the model, if the Author hasn't been set.
+ compareCustomModels(customModel, returnedModel, "author");
+ }
+
+ @Test
+ public void testCreateBasicModel_Invalid() throws Exception
+ {
+ String modelName = "testModel" + System.currentTimeMillis();
+ Pair namespacePair = getTestNamespaceUriPrefixPair();
+
+ CustomModel customModel = new CustomModel();
+ customModel.setName(modelName);
+ customModel.setNamespaceUri(namespacePair.getFirst());
+ customModel.setNamespacePrefix(namespacePair.getSecond());
+
+ // Test invalid inputs
+ {
+ customModel.setName(modelName + "");
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 400);
+
+ customModel.setName("prefix:" + modelName);
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 400); // Invalid name. Contains ':'
+
+ customModel.setName("prefix " + modelName);
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 400); // Invalid name. Contains space
+
+ customModel.setName(modelName);
+ customModel.setNamespacePrefix(namespacePair.getSecond()+" space");
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 400); // Invalid prefix. Contains space
+
+ customModel.setNamespacePrefix(namespacePair.getSecond()+"invalid/");
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 400); // Invalid prefix. Contains '/'
+
+ customModel.setNamespacePrefix(namespacePair.getSecond());
+ customModel.setNamespaceUri(namespacePair.getFirst()+" space");
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 400); // Invalid URI. Contains space
+
+ customModel.setNamespaceUri(namespacePair.getFirst()+"\\");
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 400); // Invalid URI. Contains '\'
+ }
+
+ // Test mandatory properties of the model
+ {
+ customModel.setName("");
+ customModel.setNamespacePrefix(namespacePair.getSecond());
+ customModel.setNamespaceUri(namespacePair.getFirst());
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 400); // name is mandatory
+
+ customModel.setName(modelName);
+ customModel.setNamespaceUri(null);
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 400); // namespaceUri is mandatory
+
+ customModel.setName(modelName);
+ customModel.setNamespaceUri(namespacePair.getFirst());
+ customModel.setNamespacePrefix(null);
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 400); // namespacePrefix is mandatory
+ }
+
+ // Test duplicate model name
+ {
+ // Test create a model with the same name as the bootstrapped model
+ customModel.setName("contentmodel");
+ customModel.setNamespaceUri(namespacePair.getFirst());
+ customModel.setNamespacePrefix(namespacePair.getSecond());
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 409);
+
+ // Create the model
+ customModel.setName(modelName);
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 201);
+
+ // Create a duplicate model
+ // Set a new namespace to make sure the 409 status code is returned
+ // because of a name conflict rather than namespace URI
+ namespacePair = getTestNamespaceUriPrefixPair();
+ customModel.setNamespaceUri(namespacePair.getFirst());
+ customModel.setNamespacePrefix(namespacePair.getSecond());
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 409);
+ }
+
+ // Test duplicate namespaceUri
+ {
+ String modelNameTwo = "testModelTwo" + System.currentTimeMillis();
+ Pair namespacePairTwo = getTestNamespaceUriPrefixPair();
+
+ CustomModel customModelTwo = new CustomModel();
+ customModelTwo.setName(modelNameTwo);
+ customModelTwo.setNamespaceUri(namespacePairTwo.getFirst());
+ customModelTwo.setNamespacePrefix(namespacePairTwo.getSecond());
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModelTwo), 201);
+
+ String modelNameThree = "testModelThree" + System.currentTimeMillis();
+ Pair namespacePairThree = getTestNamespaceUriPrefixPair();
+ CustomModel customModelThree = new CustomModel();
+ customModelThree.setName(modelNameThree);
+ customModelThree.setNamespaceUri(namespacePairTwo.getFirst()); // duplicate URI
+ customModelThree.setNamespacePrefix(namespacePairThree.getSecond());
+
+ // Try to create a model with a namespace uri which has already been used.
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModelThree), 409);
+
+ customModelThree.setNamespaceUri(namespacePairThree.getFirst());
+ customModelThree.setNamespacePrefix(namespacePairTwo.getSecond()); // duplicate prefix
+
+ // Try to create a model with a namespace prefix which has already been used.
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModelThree), 409);
+ }
+ }
+
+ @Test
+ public void testListBasicModels() throws Exception
+ {
+ String modelName_1 = "testModel1" + System.currentTimeMillis();
+ // Create the model as a Model Administrator
+ CustomModel customModel_1 = createCustomModel(modelName_1, getTestNamespaceUriPrefixPair(), ModelStatus.DRAFT);
+
+ String modelName_2 = "testModel2" + System.currentTimeMillis();
+ CustomModel customModel_2 = createCustomModel(modelName_2, getTestNamespaceUriPrefixPair(), ModelStatus.DRAFT);
+
+ String modelName_3 = "testModel3" + System.currentTimeMillis();
+ CustomModel customModel_3 = createCustomModel(modelName_3, getTestNamespaceUriPrefixPair(), ModelStatus.DRAFT);
+
+ Paging paging = getPaging(0, Integer.MAX_VALUE);
+ HttpResponse response = getAll("cmm", customModelAdmin, paging, 200);
+ List models = RestApiUtil.parseRestApiEntries(response.getJsonResponse(), CustomModel.class);
+
+ assertTrue(models.size() >= 3);
+ assertTrue(models.contains(customModel_1));
+ assertTrue(models.contains(customModel_2));
+ assertTrue(models.contains(customModel_3));
+ }
+
+ @Test
+ public void testActivateCustomModel() throws Exception
+ {
+ String modelNameOne = "testActivateModelOne" + System.currentTimeMillis();
+ Pair namespacePair = getTestNamespaceUriPrefixPair();
+ // Create the model as a Model Administrator
+ CustomModel customModelOne = createCustomModel(modelNameOne, namespacePair, ModelStatus.DRAFT, "Test model description", "Jane Doe");
+
+ // Retrieve the created model and check its status (the default is DRAFT)
+ HttpResponse response = getSingle("cmm", customModelAdmin, modelNameOne, 200);
+ CustomModel returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ assertEquals(ModelStatus.DRAFT, returnedModel.getStatus());
+
+ // We only want to update the status, so ignore the other properties
+ CustomModel updatePayload = new CustomModel();
+ updatePayload.setStatus(ModelStatus.ACTIVE);
+
+ // Try to activate the model as a non Admin user
+ put("cmm", nonAdminUserName, modelNameOne, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 403);
+
+ // Activate the model as a Model Administrator
+ put("cmm", customModelAdmin, modelNameOne, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 200);
+
+ response = getSingle("cmm", customModelAdmin, modelNameOne, 200);
+ returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ assertEquals(ModelStatus.ACTIVE, returnedModel.getStatus());
+ // Check other properties have not been modified
+ compareCustomModels(customModelOne, returnedModel, "status");
+
+ // Try to activate the already activated model as a Model Administrator
+ put("cmm", customModelAdmin, modelNameOne, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 500);
+
+ // Create another Model
+ String modelNameTwo = "testActivateModelTwo" + System.currentTimeMillis();
+ Pair namespacePairTwo = getTestNamespaceUriPrefixPair();
+ CustomModel customModelTwo = createCustomModel(modelNameTwo, namespacePairTwo, ModelStatus.DRAFT, null, "John Doe");
+
+ // Activate the model as a Model Administrator
+ customModelTwo.setStatus(ModelStatus.ACTIVE);
+ put("cmm", customModelAdmin, modelNameTwo, RestApiUtil.toJsonAsString(customModelTwo), SELECT_STATUS_QS, 200);
+
+ response = getSingle("cmm", customModelAdmin, modelNameTwo, 200);
+ returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ assertEquals(ModelStatus.ACTIVE, returnedModel.getStatus());
+ // Check other properties have not been modified
+ compareCustomModels(customModelTwo, returnedModel, "status");
+ }
+
+ @Test
+ public void testDeactivateCustomModel() throws Exception
+ {
+ String modelNameOne = "testDeactivateModelOne" + System.currentTimeMillis();
+ Pair namespacePair = getTestNamespaceUriPrefixPair();
+ // Create the model as a Model Administrator
+ CustomModel customModelOne = createCustomModel(modelNameOne, namespacePair, ModelStatus.ACTIVE, null, "Mark Moe");
+
+ // Retrieve the created model and check its status
+ HttpResponse response = getSingle("cmm", customModelAdmin, modelNameOne, 200);
+ CustomModel returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ assertEquals(ModelStatus.ACTIVE, returnedModel.getStatus());
+
+ // We only want to update the status (Deactivate), so ignore the other properties
+ CustomModel updatePayload = new CustomModel();
+ updatePayload.setStatus(ModelStatus.DRAFT);
+
+ // Try to deactivate the model as a non Admin user
+ put("cmm", nonAdminUserName, modelNameOne, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 403);
+
+ // Deactivate the model as a Model Administrator
+ put("cmm", customModelAdmin, modelNameOne, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 200);
+
+ response = getSingle("cmm", customModelAdmin, modelNameOne, 200);
+ returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ assertEquals(ModelStatus.DRAFT, returnedModel.getStatus());
+ // Check other properties have not been modified
+ compareCustomModels(customModelOne, returnedModel, "status");
+
+ // Try to deactivate the already deactivated model as a Model Administrator
+ put("cmm", customModelAdmin, modelNameOne, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 500);
+
+ // Activate/Deactivate a model with an aspect
+ {
+ // Create another Model
+ final String modelNameTwo = "testDeactivateModelTwo" + System.currentTimeMillis();
+ Pair namespacePairTwo = getTestNamespaceUriPrefixPair();
+ CustomModel customModelTwo = createCustomModel(modelNameTwo, namespacePairTwo, ModelStatus.DRAFT, null, "Mark Moe");
+
+ // Aspect
+ CustomAspect aspect = new CustomAspect();
+ aspect.setName("testMarkerAspect");
+ post("cmm/" + modelNameTwo + "/aspects", customModelAdmin, RestApiUtil.toJsonAsString(aspect), 201);
+ // Retrieve the created aspect
+ getSingle("cmm/" + modelNameTwo + "/aspects", customModelAdmin, aspect.getName(), 200);
+
+ // Activate the model as a Model Administrator
+ customModelTwo.setStatus(ModelStatus.ACTIVE);
+ put("cmm", customModelAdmin, modelNameTwo, RestApiUtil.toJsonAsString(customModelTwo), SELECT_STATUS_QS, 200);
+
+ response = getSingle("cmm", customModelAdmin, modelNameTwo, 200);
+ returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ assertEquals(ModelStatus.ACTIVE, returnedModel.getStatus());
+
+ updatePayload = new CustomModel();
+ updatePayload.setStatus(ModelStatus.DRAFT);
+ // Deactivate the model as a Model Administrator
+ put("cmm", customModelAdmin, modelNameTwo, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 200);
+
+ response = getSingle("cmm", customModelAdmin, modelNameTwo, 200);
+ returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ assertEquals(ModelStatus.DRAFT, returnedModel.getStatus());
+ }
+ }
+
+ @Test
+ public void testDeleteCustomModel() throws Exception
+ {
+ String modelName = "testDeleteModel" + System.currentTimeMillis();
+ Pair namespacePair = getTestNamespaceUriPrefixPair();
+ // Create the model as a Model Administrator
+ CustomModel customModel = createCustomModel(modelName, namespacePair, ModelStatus.DRAFT, null, "Joe Bloggs");
+
+ // Retrieve the created model
+ HttpResponse response = getSingle("cmm", customModelAdmin, modelName, 200);
+ CustomModel returnedModel = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), CustomModel.class);
+ compareCustomModels(customModel, returnedModel);
+
+ // Try to delete the model as a non Admin user
+ delete("cmm", nonAdminUserName, modelName, 403);
+
+ // Delete the model as a Model Administrator
+ delete("cmm", customModelAdmin, modelName, 204);
+
+ // Create the model again
+ post("cmm", customModelAdmin, RestApiUtil.toJsonAsString(customModel), 201);
+
+ // Activated the model
+ CustomModel updatePayload = new CustomModel();
+ updatePayload.setStatus(ModelStatus.ACTIVE);
+ put("cmm", customModelAdmin, modelName, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 200);
+
+ // Try to delete the active model
+ delete("cmm", customModelAdmin, modelName, 409);
+
+ // Deactivate and then delete the model
+ updatePayload = new CustomModel();
+ updatePayload.setStatus(ModelStatus.DRAFT);
+ put("cmm", customModelAdmin, modelName, RestApiUtil.toJsonAsString(updatePayload), SELECT_STATUS_QS, 200);
+ delete("cmm", customModelAdmin, modelName, 204);
+ }
+
+ @Test
+ public void testUpdateBasicModel() throws Exception
+ {
+ String modelName = "testModel" + System.currentTimeMillis();
+ Pair