mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
509708b273
- follows pattern of Alfresco Dictionary - simplified and much reduced DictionaryService interface - model now compiled and cached (no more lots of small continuous object creations) - walk model via simple getters - validated (no dangling references) - fix up property inheritance - fix up sub-types for all types - implements strict mode only for now (i.e. doesn't go outside of CMIS doc, folder, rel and policy) - abstract helper for building other CMIS dictionaries (e.g. mapping all types in Alfresco) Alfresco Dictionary: - add event for initialized or re-initialized Fix up usage in CMIS REST, Web Services and query. Tests pass. REST support for custom sub-types and properties now reliable as constrained by validated CMIS model. TODO: - hook property value accessors into CMIS Dictionary git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@13768 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
513 lines
15 KiB
Java
513 lines
15 KiB
Java
/*
|
|
* Copyright (C) 2005-2008 Alfresco Software Limited.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
|
|
* This program 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 General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
* As a special exception to the terms and conditions of version 2.0 of
|
|
* the GPL, you may redistribute this Program in connection with Free/Libre
|
|
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
|
* FLOSS exception. You should have recieved a copy of the text describing
|
|
* the FLOSS exception, and it is also available here:
|
|
* http://www.alfresco.com/legal/licensing"
|
|
*/
|
|
package org.alfresco.repo.cmis.rest;
|
|
|
|
import java.util.Collection;
|
|
import java.util.Iterator;
|
|
|
|
import org.alfresco.cmis.CMISFullTextSearchEnum;
|
|
import org.alfresco.cmis.CMISJoinEnum;
|
|
import org.alfresco.cmis.CMISQueryEnum;
|
|
import org.alfresco.cmis.CMISService;
|
|
import org.alfresco.cmis.CMISTypesFilterEnum;
|
|
import org.alfresco.cmis.dictionary.CMISDictionaryService;
|
|
import org.alfresco.cmis.dictionary.CMISTypeDefinition;
|
|
import org.alfresco.cmis.dictionary.CMISTypeId;
|
|
import org.alfresco.cmis.property.CMISPropertyService;
|
|
import org.alfresco.cmis.search.CMISQueryOptions;
|
|
import org.alfresco.cmis.search.CMISQueryService;
|
|
import org.alfresco.cmis.search.CMISResultSet;
|
|
import org.alfresco.error.AlfrescoRuntimeException;
|
|
import org.alfresco.repo.jscript.BaseScopableProcessorExtension;
|
|
import org.alfresco.repo.jscript.ScriptNode;
|
|
import org.alfresco.repo.model.Repository;
|
|
import org.alfresco.repo.web.util.paging.Cursor;
|
|
import org.alfresco.repo.web.util.paging.Page;
|
|
import org.alfresco.repo.web.util.paging.PagedResults;
|
|
import org.alfresco.repo.web.util.paging.Paging;
|
|
import org.alfresco.service.ServiceRegistry;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.namespace.QName;
|
|
|
|
|
|
/**
|
|
* CMIS Javascript API
|
|
*
|
|
* @author davic
|
|
*/
|
|
public class CMISScript extends BaseScopableProcessorExtension
|
|
{
|
|
private ServiceRegistry services;
|
|
private Repository repository;
|
|
private CMISService cmisService;
|
|
private CMISDictionaryService cmisDictionaryService;
|
|
private CMISPropertyService cmisPropertyService;
|
|
private CMISQueryService cmisQueryService;
|
|
private Paging paging;
|
|
|
|
|
|
/**
|
|
* Set the service registry
|
|
*
|
|
* @param services the service registry
|
|
*/
|
|
public void setServiceRegistry(ServiceRegistry services)
|
|
{
|
|
this.services = services;
|
|
}
|
|
|
|
/**
|
|
* Set the repository
|
|
*
|
|
* @param repository
|
|
*/
|
|
public void setRepository(Repository repository)
|
|
{
|
|
this.repository = repository;
|
|
}
|
|
|
|
/**
|
|
* Set the paging helper
|
|
*
|
|
* @param paging
|
|
*/
|
|
public void setPaging(Paging paging)
|
|
{
|
|
this.paging = paging;
|
|
}
|
|
|
|
/**
|
|
* Set the CMIS Service
|
|
*
|
|
* @param cmisService
|
|
*/
|
|
public void setCMISService(CMISService cmisService)
|
|
{
|
|
this.cmisService = cmisService;
|
|
}
|
|
|
|
/**
|
|
* Set the CMIS Dictionary Service
|
|
*
|
|
* @param cmisDictionaryService
|
|
*/
|
|
public void setCMISDictionaryService(CMISDictionaryService cmisDictionaryService)
|
|
{
|
|
this.cmisDictionaryService = cmisDictionaryService;
|
|
}
|
|
|
|
/**
|
|
* Set the CMIS Property Service
|
|
*
|
|
* @param cmisPropertyService
|
|
*/
|
|
public void setCMISPropertyService(CMISPropertyService cmisPropertyService)
|
|
{
|
|
this.cmisPropertyService = cmisPropertyService;
|
|
}
|
|
|
|
/**
|
|
* Set the CMIS Query Service
|
|
*
|
|
* @param cmisQueryService
|
|
*/
|
|
public void setCMISQueryService(CMISQueryService cmisQueryService)
|
|
{
|
|
this.cmisQueryService = cmisQueryService;
|
|
}
|
|
|
|
/**
|
|
* Gets the supported CMIS Version
|
|
*
|
|
* @return CMIS version
|
|
*/
|
|
public String getVersion()
|
|
{
|
|
return cmisService.getCMISVersion();
|
|
}
|
|
|
|
/**
|
|
* Gets the default root folder path
|
|
*
|
|
* @return default root folder path
|
|
*/
|
|
public String getDefaultRootFolderPath()
|
|
{
|
|
return cmisService.getDefaultRootPath();
|
|
}
|
|
|
|
/**
|
|
* Gets the default root folder
|
|
*
|
|
* @return default root folder
|
|
*/
|
|
public ScriptNode getDefaultRootFolder()
|
|
{
|
|
return new ScriptNode(cmisService.getDefaultRootNodeRef(), services, getScope());
|
|
}
|
|
|
|
/**
|
|
* Finds the arg value from the specified url argument and header
|
|
*
|
|
* NOTE: Url argument takes precedence over header
|
|
*
|
|
* @param argVal url arg value
|
|
* @param headerVal header value
|
|
* @return value (or null)
|
|
*/
|
|
public String findArg(String argVal, String headerVal)
|
|
{
|
|
return (argVal == null) ? headerVal : argVal;
|
|
}
|
|
|
|
/**
|
|
* Finds the arg value from the specified url argument and header
|
|
*
|
|
* NOTE: Url argument takes precedence over header
|
|
*
|
|
* @param argVal url arg value
|
|
* @param headerVal header value
|
|
* @return value (or null)
|
|
*/
|
|
public String[] findArgM(String[] argVal, String[] headerVal)
|
|
{
|
|
return (argVal == null) ? headerVal : argVal;
|
|
}
|
|
|
|
/**
|
|
* Gets the default Types filter
|
|
*
|
|
* @return default types filter
|
|
*/
|
|
public String getDefaultTypesFilter()
|
|
{
|
|
return CMISTypesFilterEnum.FACTORY.defaultLabel();
|
|
}
|
|
|
|
/**
|
|
* Is specified Types filter valid?
|
|
*
|
|
* @param typesFilter types filter
|
|
* @return true => valid
|
|
*/
|
|
public boolean isValidTypesFilter(String typesFilter)
|
|
{
|
|
return CMISTypesFilterEnum.FACTORY.validLabel(typesFilter);
|
|
}
|
|
|
|
/**
|
|
* Resolve to a Types Filter
|
|
*
|
|
* NOTE: If specified types filter is not specified or invalid, the default types
|
|
* filter is returned
|
|
*
|
|
* @param typesFilter types filter
|
|
* @return resolved types filter
|
|
*/
|
|
private CMISTypesFilterEnum resolveTypesFilter(String typesFilter)
|
|
{
|
|
return (CMISTypesFilterEnum)CMISTypesFilterEnum.FACTORY.toEnum(typesFilter);
|
|
}
|
|
|
|
/**
|
|
* Finds a Node with the repository given a reference
|
|
*
|
|
* @param referenceType node, path
|
|
* @param reference node => id, path => path
|
|
* @return node (or null, if not found)
|
|
*/
|
|
public ScriptNode findNode(String referenceType, String[] reference)
|
|
{
|
|
ScriptNode node = null;
|
|
NodeRef nodeRef = repository.findNodeRef(referenceType, reference);
|
|
if (nodeRef != null)
|
|
{
|
|
node = new ScriptNode(nodeRef, services, getScope());
|
|
}
|
|
return node;
|
|
}
|
|
|
|
/**
|
|
* Query for node children
|
|
*
|
|
* @param parent node to query children for
|
|
* @param typesFilter types filter
|
|
* @param page page to query for
|
|
* @return paged result set of children
|
|
*/
|
|
public PagedResults queryChildren(ScriptNode parent, String typesFilter, Page page)
|
|
{
|
|
CMISTypesFilterEnum filter = resolveTypesFilter(typesFilter);
|
|
NodeRef[] children = cmisService.getChildren(parent.getNodeRef(), filter);
|
|
|
|
Cursor cursor = paging.createCursor(children.length, page);
|
|
ScriptNode[] nodes = new ScriptNode[cursor.getRowCount()];
|
|
for (int i = cursor.getStartRow(); i <= cursor.getEndRow(); i++)
|
|
{
|
|
nodes[i - cursor.getStartRow()] = new ScriptNode(children[i], services, getScope());
|
|
}
|
|
|
|
PagedResults results = paging.createPagedResults(nodes, cursor);
|
|
return results;
|
|
}
|
|
|
|
/**
|
|
* Query for items checked-out to user
|
|
*
|
|
* @param username user
|
|
* @param page
|
|
* @return paged result set of checked-out items
|
|
*/
|
|
public PagedResults queryCheckedOut(String username, Page page)
|
|
{
|
|
return queryCheckedOut(username, null, false, page);
|
|
}
|
|
|
|
/**
|
|
* Query for items checked-out to user within folder
|
|
*
|
|
* @param username user
|
|
* @param folder folder
|
|
* @param page
|
|
* @return paged result set of checked-out items
|
|
*/
|
|
public PagedResults queryCheckedOut(String username, ScriptNode folder, Page page)
|
|
{
|
|
return queryCheckedOut(username, folder, false, page);
|
|
}
|
|
|
|
/**
|
|
* Query for items checked-out to user within folder (and possibly descendants)
|
|
*
|
|
* @param username user
|
|
* @param folder folder
|
|
* @param includeDescendants true = include descendants
|
|
* @param page
|
|
* @return paged result set of checked-out items
|
|
*/
|
|
public PagedResults queryCheckedOut(String username, ScriptNode folder, boolean includeDescendants, Page page)
|
|
{
|
|
NodeRef[] checkedout = cmisService.getCheckedOut(username, (folder == null) ? null : folder.getNodeRef(), includeDescendants);
|
|
Cursor cursor = paging.createCursor(checkedout.length, page);
|
|
ScriptNode[] nodes = new ScriptNode[cursor.getRowCount()];
|
|
for (int i = cursor.getStartRow(); i <= cursor.getEndRow(); i++)
|
|
{
|
|
nodes[i - cursor.getStartRow()] = new ScriptNode(checkedout[i], services, getScope());
|
|
}
|
|
|
|
PagedResults results = paging.createPagedResults(nodes, cursor);
|
|
return results;
|
|
}
|
|
|
|
/**
|
|
* Query for all Type Definitions
|
|
*
|
|
* @param page
|
|
* @return paged result set of types
|
|
*/
|
|
public PagedResults queryTypes(Page page)
|
|
{
|
|
Collection<CMISTypeDefinition> typeDefs = cmisDictionaryService.getAllTypes();
|
|
Cursor cursor = paging.createCursor(typeDefs.size(), page);
|
|
|
|
// skip
|
|
Iterator<CMISTypeDefinition> iterTypeDefs = typeDefs.iterator();
|
|
for (int i = 0; i < cursor.getStartRow(); i++)
|
|
{
|
|
iterTypeDefs.next();
|
|
}
|
|
|
|
// get types for page
|
|
CMISTypeDefinition[] types = new CMISTypeDefinition[cursor.getRowCount()];
|
|
for (int i = cursor.getStartRow(); i <= cursor.getEndRow(); i++)
|
|
{
|
|
types[i - cursor.getStartRow()] = iterTypeDefs.next();
|
|
}
|
|
|
|
PagedResults results = paging.createPagedResults(types, cursor);
|
|
return results;
|
|
}
|
|
|
|
/**
|
|
* Query for all Type Definitions in a type hierarchy
|
|
*
|
|
* @param page
|
|
* @return paged result set of types
|
|
*/
|
|
public PagedResults queryTypeHierarchy(CMISTypeDefinition typeDef, boolean descendants, Page page)
|
|
{
|
|
Collection<CMISTypeDefinition> subTypes = typeDef.getSubTypes(descendants);
|
|
Cursor cursor = paging.createCursor(subTypes.size(), page);
|
|
|
|
// skip
|
|
Iterator<CMISTypeDefinition> iterSubTypes = subTypes.iterator();
|
|
for (int i = 0; i < cursor.getStartRow(); i++)
|
|
{
|
|
iterSubTypes.next();
|
|
}
|
|
|
|
// get types for page
|
|
CMISTypeDefinition[] types = new CMISTypeDefinition[cursor.getRowCount()];
|
|
for (int i = cursor.getStartRow(); i <= cursor.getEndRow(); i++)
|
|
{
|
|
types[i - cursor.getStartRow()] = iterSubTypes.next();
|
|
}
|
|
|
|
PagedResults results = paging.createPagedResults(types, cursor);
|
|
return results;
|
|
}
|
|
|
|
/**
|
|
* Query for a Type Definition given a CMIS Type Id
|
|
*
|
|
* @param page
|
|
* @return CMIS Type Definition
|
|
*/
|
|
public CMISTypeDefinition queryType(String typeId)
|
|
{
|
|
try
|
|
{
|
|
CMISTypeId cmisTypeId = cmisDictionaryService.getTypeId(typeId);
|
|
return cmisDictionaryService.getType(cmisTypeId);
|
|
}
|
|
catch(AlfrescoRuntimeException e)
|
|
{
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Query the Type Definition for the given Node
|
|
*
|
|
* @param node
|
|
* @return CMIS Type Definition
|
|
*/
|
|
public CMISTypeDefinition queryType(ScriptNode node)
|
|
{
|
|
try
|
|
{
|
|
QName typeQName = node.getQNameType();
|
|
CMISTypeId cmisTypeId = cmisDictionaryService.getTypeId(typeQName, null);
|
|
return cmisDictionaryService.getType(cmisTypeId);
|
|
}
|
|
catch(AlfrescoRuntimeException e)
|
|
{
|
|
return null;
|
|
}
|
|
}
|
|
|
|
|
|
//
|
|
// Property Support
|
|
//
|
|
|
|
/**
|
|
* Map CMIS Property name to Alfresco property name (only for direct 1 to 1 mappings)
|
|
*
|
|
* @param propertyName CMIS property name
|
|
* @return Alfresco property name (or null, if there's no mapping)
|
|
*/
|
|
public QName mapPropertyName(String propertyName)
|
|
{
|
|
return cmisPropertyService.mapPropertyName(propertyName);
|
|
}
|
|
|
|
|
|
//
|
|
// SQL Query
|
|
//
|
|
|
|
/**
|
|
* Can you query the private working copy of a document.
|
|
*
|
|
* @return
|
|
*/
|
|
public boolean getPwcSearchable()
|
|
{
|
|
return cmisQueryService.getPwcSearchable();
|
|
}
|
|
|
|
/**
|
|
* Can you query non-latest versions of a document.
|
|
*
|
|
* The current latest version is always searchable according to the type definition.
|
|
*
|
|
* @return
|
|
*/
|
|
public boolean getAllVersionsSearchable()
|
|
{
|
|
return cmisQueryService.getAllVersionsSearchable();
|
|
}
|
|
|
|
/**
|
|
* Get the query support level.
|
|
*
|
|
* @return
|
|
*/
|
|
public CMISQueryEnum getQuerySupport()
|
|
{
|
|
return cmisQueryService.getQuerySupport();
|
|
}
|
|
|
|
/**
|
|
* Get the join support level in queries.
|
|
*
|
|
* @return
|
|
*/
|
|
public CMISJoinEnum getJoinSupport()
|
|
{
|
|
return cmisQueryService.getJoinSupport();
|
|
}
|
|
|
|
/**
|
|
* Get the full text search support level in queries.
|
|
*
|
|
* @return
|
|
*/
|
|
public CMISFullTextSearchEnum getFullTextSearchSupport()
|
|
{
|
|
return cmisQueryService.getFullTextSearchSupport();
|
|
}
|
|
|
|
/**
|
|
* Issue query
|
|
*
|
|
* @param statement query statement
|
|
* @param page
|
|
*
|
|
* @return paged result set
|
|
*/
|
|
public PagedResults query(String statement, Page page)
|
|
{
|
|
CMISQueryOptions options = new CMISQueryOptions(statement, cmisService.getDefaultRootStoreRef());
|
|
options.setSkipCount(page.getNumber());
|
|
options.setMaxItems(page.getSize());
|
|
CMISResultSet resultSet = cmisQueryService.query(options);
|
|
Cursor cursor = paging.createCursor(page.getNumber() + resultSet.getLength() + (resultSet.hasMore() ? 1 : 0) , page);
|
|
return paging.createPagedResult(resultSet, cursor);
|
|
}
|
|
|
|
}
|