org.structr.files.cmis.CMISRepositoryService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of structr-ui Show documentation
Show all versions of structr-ui Show documentation
Structr is an open source framework based on the popular Neo4j graph database.
The newest version!
/**
* Copyright (C) 2010-2016 Structr GmbH
*
* This file is part of Structr .
*
* Structr is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* Structr 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Structr. If not, see getRepositoryInfos(final ExtensionsData extension) {
final List infoList = new LinkedList<>();
infoList.add(repositoryInfo);
return infoList;
}
@Override
public RepositoryInfo getRepositoryInfo(String repositoryId, ExtensionsData extension) {
if (repositoryId != null && repositoryId.equals(repositoryInfo.getId())) {
return repositoryInfo;
}
throw new CmisObjectNotFoundException(repositoryId);
}
@Override
public TypeDefinitionList getTypeChildren(String repositoryId, String typeId, Boolean includePropertyDefinitions, BigInteger maxItems, BigInteger skipCount, ExtensionsData extension) {
// important: children are the direct children of a type, as opposed to the descendants
final CMISTypeDefinitionListWrapper results = new CMISTypeDefinitionListWrapper(maxItems, skipCount);
if (typeId != null) {
final BaseTypeId baseTypeId = getBaseTypeId(typeId);
if (baseTypeId != null) {
results.addAll(getBaseTypeChildren(baseTypeId, includePropertyDefinitions));
} else {
final Class type = StructrApp.getConfiguration().getNodeEntityClass(typeId);
if (type != null) {
results.addAll(getTypeChildren(typeId, includePropertyDefinitions));
} else {
throw new CmisObjectNotFoundException("Type with ID " + typeId + " does not exist");
}
}
} else {
results.add(getDocumentTypeDefinition(BaseTypeId.CMIS_DOCUMENT.value(), includePropertyDefinitions, true));
results.add(getFolderTypeDefinition(BaseTypeId.CMIS_FOLDER.value(), includePropertyDefinitions, true));
results.add(getItemTypeDefinition(BaseTypeId.CMIS_ITEM.value(), includePropertyDefinitions, true));
results.add(getPolicyTypeDefinition(BaseTypeId.CMIS_POLICY.value(), includePropertyDefinitions, true));
results.add(getRelationshipTypeDefinition(BaseTypeId.CMIS_RELATIONSHIP.value(), includePropertyDefinitions, true));
results.add(getSecondaryTypeDefinition(BaseTypeId.CMIS_SECONDARY.value(), includePropertyDefinitions, true));
}
return results;
}
@Override
public List getTypeDescendants(String repositoryId, String typeId, BigInteger depth, Boolean includePropertyDefinitions, ExtensionsData extension) {
// important: descendants are ALL children and children of children, i.e. the whole tree
/*
Id typeId: The typeId of an object-type specified in the repository.
- If specified, then the repository MUST return all of descendant types of the specified type.
- If not specified, then the Repository MUST return all types and MUST ignore the value of the depth parameter.
*/
final List results = new LinkedList<>();
if (typeId != null) {
final BaseTypeId baseTypeId = getBaseTypeId(typeId);
if (baseTypeId != null) {
final TypeDefinition typeDefinition = getTypeDefinition(repositoryId, typeId, extension);
final TypeDefinitionContainer container = getTypeDefinitionContainer(typeDefinition, includePropertyDefinitions);
results.add(container);
} else {
final Class type = StructrApp.getConfiguration().getNodeEntityClass(typeId);
if (type != null) {
final TypeDefinition typeDefinition = extendTypeDefinition(type, includePropertyDefinitions);
if (typeDefinition != null) {
results.add(getTypeDefinitionContainer(typeDefinition, includePropertyDefinitions));
} else {
throw new CmisObjectNotFoundException("Type with ID " + typeId + " does not exist");
}
} else {
throw new CmisObjectNotFoundException("Type with ID " + typeId + " does not exist");
}
}
} else {
results.add(getTypeDefinitionContainer(getDocumentTypeDefinition(BaseTypeId.CMIS_DOCUMENT.value(), includePropertyDefinitions, true), includePropertyDefinitions));
results.add(getTypeDefinitionContainer(getFolderTypeDefinition(BaseTypeId.CMIS_FOLDER.value(), includePropertyDefinitions, true), includePropertyDefinitions));
results.add(getTypeDefinitionContainer(getItemTypeDefinition(BaseTypeId.CMIS_ITEM.value(), includePropertyDefinitions, true), includePropertyDefinitions));
results.add(getTypeDefinitionContainer(getPolicyTypeDefinition(BaseTypeId.CMIS_POLICY.value(), includePropertyDefinitions, true), includePropertyDefinitions));
results.add(getTypeDefinitionContainer(getRelationshipTypeDefinition(BaseTypeId.CMIS_RELATIONSHIP.value(), includePropertyDefinitions, true), includePropertyDefinitions));
results.add(getTypeDefinitionContainer(getSecondaryTypeDefinition(BaseTypeId.CMIS_SECONDARY.value(), includePropertyDefinitions, true), includePropertyDefinitions));
}
return results;
}
@Override
public TypeDefinition getTypeDefinition(final String repositoryId, final String typeId, final ExtensionsData extension) {
switch (typeId) {
case "cmis:document":
return getDocumentTypeDefinition(typeId, true, true);
case "cmis:folder":
return getFolderTypeDefinition(typeId, true, true);
case "cmis:item":
return getItemTypeDefinition(typeId, true, true);
case "cmis:policy":
return getPolicyTypeDefinition(typeId, true, true);
case "cmis:relationship":
return getRelationshipTypeDefinition(typeId, true, true);
case "cmis:secondary":
return getSecondaryTypeDefinition(typeId, true, true);
}
final Class type = StructrApp.getConfiguration().getNodeEntityClass(typeId);
if (type != null) {
final TypeDefinition extendedTypeDefinition = extendTypeDefinition(type, true);
if (extendedTypeDefinition != null) {
return extendedTypeDefinition;
}
}
throw new CmisObjectNotFoundException("Type with ID " + typeId + " does not exist");
}
@Override
public TypeDefinition createType(String repositoryId, TypeDefinition type, ExtensionsData extension) {
return null;
}
@Override
public TypeDefinition updateType(String repositoryId, TypeDefinition type, ExtensionsData extension) {
return null;
}
@Override
public void deleteType(String repositoryId, String typeId, ExtensionsData extension) {
}
// ----- private methods -----
private MutableSecondaryTypeDefinition getSecondaryTypeDefinition(final String typeId, final boolean includePropertyDefinitions, final boolean baseType) {
final TypeDefinitionFactory factory = TypeDefinitionFactory.newInstance();
final MutableSecondaryTypeDefinition def = factory.createSecondaryTypeDefinition(CmisVersion.CMIS_1_1, baseType ? null : BaseTypeId.CMIS_SECONDARY.value());
def.setIsCreatable(false);
initializeExtendedType(def, typeId);
if (!includePropertyDefinitions) {
def.removeAllPropertyDefinitions();
}
return def;
}
private MutableRelationshipTypeDefinition getRelationshipTypeDefinition(final String typeId, final boolean includePropertyDefinitions, final boolean baseType) {
final TypeDefinitionFactory factory = TypeDefinitionFactory.newInstance();
final MutableRelationshipTypeDefinition def = factory.createRelationshipTypeDefinition(CmisVersion.CMIS_1_1, baseType ? null : BaseTypeId.CMIS_RELATIONSHIP.value());
def.setIsCreatable(false);
initializeExtendedType(def, typeId);
if (!includePropertyDefinitions) {
def.removeAllPropertyDefinitions();
}
return def;
}
private MutableItemTypeDefinition getItemTypeDefinition(final String typeId, final boolean includePropertyDefinitions, final boolean baseType) {
final TypeDefinitionFactory factory = TypeDefinitionFactory.newInstance();
final MutableItemTypeDefinition def = factory.createItemTypeDefinition(CmisVersion.CMIS_1_1, baseType ? null : BaseTypeId.CMIS_ITEM.value());
def.setIsCreatable(false);
initializeExtendedType(def, typeId);
if (!includePropertyDefinitions) {
def.removeAllPropertyDefinitions();
}
return def;
}
private MutablePolicyTypeDefinition getPolicyTypeDefinition(final String typeId, final boolean includePropertyDefinitions, final boolean baseType) {
final TypeDefinitionFactory factory = TypeDefinitionFactory.newInstance();
final MutablePolicyTypeDefinition def = factory.createPolicyTypeDefinition(CmisVersion.CMIS_1_1, baseType ? null : BaseTypeId.CMIS_POLICY.value());
def.setIsCreatable(false);
initializeExtendedType(def, typeId);
if (!includePropertyDefinitions) {
def.removeAllPropertyDefinitions();
}
return def;
}
private MutableFolderTypeDefinition getFolderTypeDefinition(final String typeId, final boolean includePropertyDefinitions, final boolean baseType) {
final TypeDefinitionFactory factory = TypeDefinitionFactory.newInstance();
final MutableFolderTypeDefinition def = factory.createFolderTypeDefinition(CmisVersion.CMIS_1_1, baseType ? null : BaseTypeId.CMIS_FOLDER.value());
initializeExtendedType(def, typeId);
if (!includePropertyDefinitions) {
def.removeAllPropertyDefinitions();
}
return def;
}
private MutableDocumentTypeDefinition getDocumentTypeDefinition(final String typeId, final boolean includePropertyDefinitions, final boolean baseType) {
final TypeDefinitionFactory factory = TypeDefinitionFactory.newInstance();
final MutableDocumentTypeDefinition def = factory.createDocumentTypeDefinition(CmisVersion.CMIS_1_1, baseType ? null : BaseTypeId.CMIS_DOCUMENT.value());
// content is required for Structr documents
def.setContentStreamAllowed(ContentStreamAllowed.REQUIRED);
initializeExtendedType(def, typeId);
if (!includePropertyDefinitions) {
def.removeAllPropertyDefinitions();
}
return def;
}
private List getTypeChildren(final String typeId, final Boolean includePropertyDefinitions) {
final Set subtypes = new LinkedHashSet<>(SearchCommand.getAllSubtypesAsStringSet(typeId));
final ConfigurationProvider config = StructrApp.getConfiguration();
final List result = new LinkedList<>();
// subtypes set from Structr contains initial type as well..
subtypes.remove(typeId);
for (final String subtype : subtypes) {
final Class subclass = config.getNodeEntityClass(subtype);
if (subclass != null) {
final TypeDefinition extendedTypeDefinition = extendTypeDefinition(subclass, includePropertyDefinitions);
if (extendedTypeDefinition != null) {
result.add(extendedTypeDefinition);
}
}
}
return result;
}
private List getBaseTypeChildren(final BaseTypeId baseTypeId, final Boolean includePropertyDefinitions) {
final ConfigurationProvider config = StructrApp.getConfiguration();
final List result = new LinkedList<>();
final App app = StructrApp.getInstance();
// static definition of base type children, add new types here!
switch (baseTypeId) {
case CMIS_DOCUMENT:
result.add(extendTypeDefinition(File.class, includePropertyDefinitions));
break;
case CMIS_FOLDER:
result.add(extendTypeDefinition(Folder.class, includePropertyDefinitions));
break;
case CMIS_ITEM:
try (final Tx tx = app.tx()) {
for (final SchemaNode schemaNode : app.nodeQuery(SchemaNode.class).sort(AbstractNode.name).getAsList()) {
final Class type = config.getNodeEntityClass(schemaNode.getClassName());
if (type != null) {
final CMISInfo info = getCMISInfo(type);
if (info != null && baseTypeId.equals(info.getBaseTypeId())) {
final TypeDefinition extendedTypeDefinition = extendTypeDefinition(type, includePropertyDefinitions);
if (extendedTypeDefinition != null) {
result.add(extendedTypeDefinition);
}
}
}
}
tx.success();
} catch (final FrameworkException fex) {
logger.log(Level.WARNING, "", fex);
}
break;
}
return result;
}
private TypeDefinitionContainer getTypeDefinitionContainer(final TypeDefinition typeDefinition, final Boolean includePropertyDefinitions) {
final TypeDefinitionContainerImpl result = new TypeDefinitionContainerImpl();
final List list = new LinkedList<>();
result.setTypeDefinition(typeDefinition);
result.setChildren(list);
final String typeId = typeDefinition.getId();
final BaseTypeId baseTypeId = getBaseTypeId(typeId);
if (baseTypeId != null) {
for (final TypeDefinition child : getBaseTypeChildren(baseTypeId, includePropertyDefinitions)) {
list.add(getTypeDefinitionContainer(child, includePropertyDefinitions));
}
} else {
for (final TypeDefinition child : getTypeChildren(typeDefinition.getId(), includePropertyDefinitions)) {
list.add(getTypeDefinitionContainer(child, includePropertyDefinitions));
}
}
return result;
}
private MutableTypeDefinition extendTypeDefinition(final Class type, final Boolean includePropertyDefinitions) {
final String typeName = type.getSimpleName();
MutableTypeDefinition result = null;
try {
// instantiate class to obtain runtime CMIS information
final GraphObject obj = type.newInstance();
if (obj != null) {
final CMISInfo info = obj.getCMISInfo();
if (info != null) {
final BaseTypeId baseTypeId = info.getBaseTypeId();
if (baseTypeId != null) {
switch (baseTypeId) {
case CMIS_DOCUMENT:
result = getDocumentTypeDefinition(typeName, includePropertyDefinitions, false);
break;
case CMIS_FOLDER:
result = getFolderTypeDefinition(typeName, includePropertyDefinitions, false);
break;
case CMIS_ITEM:
result = getItemTypeDefinition(typeName, includePropertyDefinitions, false);
break;
case CMIS_POLICY:
result = getPolicyTypeDefinition(typeName, includePropertyDefinitions, false);
break;
case CMIS_RELATIONSHIP:
result = getRelationshipTypeDefinition(typeName, includePropertyDefinitions, false);
break;
case CMIS_SECONDARY:
result = getSecondaryTypeDefinition(typeName, includePropertyDefinitions, false);
break;
}
if (result != null) {
// initialize..
for (final PropertyKey key : StructrApp.getConfiguration().getPropertySet(type, PropertyView.All)) {
final MutablePropertyDefinition property = createProperty(type, key);
if (property != null) {
result.addPropertyDefinition(property);
}
}
}
}
}
}
} catch (final IllegalAccessException | InstantiationException iex) {
logger.log(Level.WARNING, "", iex);
}
return result;
}
private void initializeExtendedType(final MutableTypeDefinition type, final String typeId) {
type.setId(typeId);
type.setLocalName(typeId);
type.setQueryName(typeId);
type.setDisplayName(typeId);
type.setDescription(typeId);
}
private MutablePropertyDefinition createProperty(final Class type, final PropertyKey key) {
// include all dynamic and CMIS-enabled keys in definition
if (key.isDynamic() || key.isCMISProperty()) {
// only include primitives here
final TypeDefinitionFactory factory = TypeDefinitionFactory.newInstance();
final PropertyType dataType = key.getDataType();
if (dataType != null) {
final String propertyId = key.jsonName();
final String displayName = propertyId;
final String description = StringUtils.capitalize(propertyId);
final Class declaringClass = key.getDeclaringClass();
final boolean isInherited = !type.getSimpleName().equals(declaringClass.getSimpleName());
final Cardinality cardinality = Cardinality.SINGLE;
final Updatability updatability = Updatability.READWRITE;
final boolean required = key.isNotNull();
final boolean queryable = key.isIndexed();
final boolean orderable = key.isIndexed();
final MutablePropertyDefinition property = factory.createPropertyDefinition(
propertyId,
displayName,
description,
dataType,
cardinality,
updatability,
isInherited,
required,
queryable,
orderable
);
// add enum choices if present
final Class valueType = key.valueType();
if (valueType != null && valueType.isEnum()) {
final List choices = new LinkedList<>();
for (final Object option : valueType.getEnumConstants()) {
final String optionName = option.toString();
choices.add(factory.createChoice(optionName, optionName));
}
property.setIsOpenChoice(false);
property.setChoices(choices);
}
return property;
}
}
return null;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy