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

Merged DEV/SWIFT to HEAD

Browse Source 
27981: SE.S16 Share - Web-tier lightweight data dictionary
          - WIP of web-tier lightweight data dictionary impl
          - WebScript to return JSON representation of basic data dictionary (based on existing DD webscripts)
          - Share tier now retrieves a single DD representation for each Alfresco tenant (on first user request for DD query)
          - DictionaryQuery script object with the start of a DD query API; isSubType, isAspect, hasProperty etc.
          - Clean up and improved templates for some of the existing DD webscripts
   28014: SE.S16 Share - Web-tier lightweight data dictionary:
          - Adding more APIs to web-tier DD; isAspect, isType, hasProperty, hasPropertyResolved, getTitle, getDescription, getParent, isContainer
          - Improvements to remote api json response for dictionary
          - Code cleanup
   28075: SE.S16 Share - Web-tier lightweight data dictionary
          - Get Property and Get Properties APIs
          - Some cleanup
   28120: SE.S16 Share - Web-tier lightweight data dictionary
          - Get Default Aspects, Get Associations and Get Child Associations APIs
          - JavaDoc and code cleanup

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@28160 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Kevin Roast
2011-06-02 11:01:26 +00:00
parent d68118af3a
commit 2300403bb4
9 changed files with 282 additions and 193 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
source/java/org/alfresco/repo/web/scripts/dictionary/DictionaryGet.java Normal file
View File

@@ -0,0 +1,108 @@
/*
* Copyright (C) 2005-2011 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.web.scripts.dictionary;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.alfresco.service.cmr.dictionary.AssociationDefinition;
import org.alfresco.service.cmr.dictionary.ClassDefinition;
import org.alfresco.service.cmr.dictionary.PropertyDefinition;
import org.alfresco.service.namespace.QName;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptRequest;
/**
* WebScript implementation to retrieve a complete dictionary required to implement
* a lightweight remote web-tier dictionary.
*
* @author Kevin Roast
*/
public class DictionaryGet extends DictionaryWebServiceBase
{
private static final String MODEL_CLASS_DEFS = "classdefs";
private static final String MODEL_PROPERTY_DEFS = "propertydefs";
private static final String MODEL_ASSOCIATION_DEFS = "assocdefs";
/** Set of model namespaces to ignore when outputing dictionary classes and aspects */
private Set<String> ignoreNamespaces = Collections.<String>emptySet();
/**
* Set of model namespaces to ignore when outputing dictionary classes and aspects
*
* @param namespaces Set of model namespaces to ignore
*/
public void setIgnoreNamespaces(Set<String> namespaces)
{
this.ignoreNamespaces = namespaces;
}
/**
* Execute the webscript
*
* @param req WebScriptRequest
* @param status Status
*/
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status)
{
List<QName> qnames = new ArrayList<QName>(256);
Set<String> namespaces = new HashSet<String>();
Map<QName, ClassDefinition> classdef = new HashMap<QName, ClassDefinition>();
Map<QName, Collection<PropertyDefinition>> propdef = new HashMap<QName, Collection<PropertyDefinition>>();
Map<QName, Collection<AssociationDefinition>> assocdef = new HashMap<QName, Collection<AssociationDefinition>>();
// check configured list of model namespaces to ignore i.e. wcm
for (String ns : this.namespaceService.getURIs())
{
if (!ignoreNamespaces.contains(ns))
{
namespaces.add(ns);
}
}
// walk the models and extract the aspects and types
for (QName qname : this.dictionaryservice.getAllModels())
{
if (namespaces.contains(qname.getNamespaceURI()))
{
qnames.addAll(this.dictionaryservice.getAspects(qname));
qnames.addAll(this.dictionaryservice.getTypes(qname));
}
}
// get the class definitions and the properties and associations
for (QName qname : qnames)
{
classdef.put(qname, this.dictionaryservice.getClass(qname));
propdef.put(qname, this.dictionaryservice.getClass(qname).getProperties().values());
assocdef.put(qname, this.dictionaryservice.getClass(qname).getAssociations().values());
}
Map<String, Object> model = new HashMap<String, Object>();
model.put(MODEL_CLASS_DEFS, classdef.values());
model.put(MODEL_PROPERTY_DEFS, propdef.values());
model.put(MODEL_ASSOCIATION_DEFS, assocdef.values());
return model;
}
}

101
source/java/org/alfresco/repo/web/scripts/dictionary/DictionaryWebServiceBase.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
* Copyright (C) 2005-2011 Alfresco Software Limited.
*
* This file is part of Alfresco
*
@@ -30,14 +30,14 @@ import org.springframework.extensions.webscripts.DeclarativeWebScript;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
/*
/**
* Base class for Dictionary web scripts
*
* @author Saravanan Sellathurai
*/
public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
{
private static final String NAME_DELIMITER = "_";
private static final String NAME_DELIMITER = "_";
private Map<String, String> prefixesAndUrlsMap;
private Map<String, String> urlsAndPrefixesMap;
@@ -56,6 +56,7 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
private static final String ASSOCIATION_FILTER_OPTION_TYPE2 = "general";
private static final String ASSOCIATION_FILTER_OPTION_TYPE3 = "child";
/**
* Set the namespaceService property.
*
@@ -63,7 +64,7 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
*/
public void setNamespaceService(NamespaceService namespaceservice)
{
this.namespaceService = namespaceservice;
this.namespaceService = namespaceservice;
}
/**
@@ -117,17 +118,15 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
/**
*
* @param qname
* @return the namespaceuri from a qname
*/
public String getNamespaceURIfromQname(QName qname)
{
return qname.getNamespaceURI();
}
}
/**
*
* @param className the class name as cm_person
* @return String the full name in the following format {namespaceuri}shorname
*/
@@ -142,14 +141,13 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
result = "{" + url + "}"+ name;
return result;
}
catch(Exception e)
catch (Exception e)
{
throw new WebScriptException(Status.STATUS_NOT_FOUND, "The exact classname - " + classname + " parameter has not been provided in the URL");
}
}
/**
*
* @param classname - checks whether the classname is valid , gets the classname as input e.g cm_person
* @return true - if the class is valid , false - if the class is invalid
*/
@@ -159,13 +157,9 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
try
{
qname = QName.createQName(this.getFullNamespaceURI(classname));
if (//(isValidPrefix(getPrefix(classname)) == true) &&
dictionaryservice.getClass(qname) != null)
{
return true;
}
return (dictionaryservice.getClass(qname) != null);
}
catch(InvalidQNameException e)
catch (InvalidQNameException e)
{
//just ignore
}
@@ -173,26 +167,6 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
}
/**
*
* @param prefix - checks whether the prefix is a valid one
* @return true if the prefix is valid or false
*/
// public boolean isValidPrefix(String prefix)
// {
// this.namespaceservice.
//
// if(this.prefixes.contains(prefix) == true)
// {
// return true;
// }
// else
// {
// return false;
// }
// }
/**
*
* @param namespaceprefix - gets a valid namespaceprefix as input
* @return modelname from namespaceprefix - returns null if invalid namespaceprefix is given
*/
@@ -212,20 +186,12 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
public boolean isValidAssociationFilter(String af)
{
if(af.equalsIgnoreCase(ASSOCIATION_FILTER_OPTION_TYPE1) ||
af.equalsIgnoreCase(ASSOCIATION_FILTER_OPTION_TYPE2) ||
af.equalsIgnoreCase(ASSOCIATION_FILTER_OPTION_TYPE3))
{
return true;
}
else
{
return false;
}
return (af.equalsIgnoreCase(ASSOCIATION_FILTER_OPTION_TYPE1) ||
af.equalsIgnoreCase(ASSOCIATION_FILTER_OPTION_TYPE2) ||
af.equalsIgnoreCase(ASSOCIATION_FILTER_OPTION_TYPE3));
}
/**
*
* @param classname as the input
* @return true if it is a aspect or false if it is a Type
*/
@@ -234,34 +200,26 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
try
{
QName qname = QName.createQName(this.getFullNamespaceURI(classname));
if( (this.dictionaryservice.getClass(qname)!=null) &&
(this.dictionaryservice.getClass(qname).isAspect() == true))
{
return true;
}
else
{
return false;
}
return ((this.dictionaryservice.getClass(qname) != null) &&
(this.dictionaryservice.getClass(qname).isAspect()));
}
catch(InvalidQNameException e)
catch (InvalidQNameException e)
{
//ignore
// ignore
}
return false;
}
/**
*
* @param modelname - gets the modelname as the input (modelname is without prefix ie. cm:contentmodel => where modelname = contentmodel)
* @return true if valid or false
*/
public boolean isValidModelName(String modelname)
{
boolean value = false;
for(QName qnameObj:this.dictionaryservice.getAllModels())
for (QName qnameObj:this.dictionaryservice.getAllModels())
{
if(qnameObj.getLocalName().equalsIgnoreCase(modelname))
if (qnameObj.getLocalName().equalsIgnoreCase(modelname))
{
value = true;
break;
@@ -269,8 +227,8 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
}
return value;
}
/**
*
* @param classname - returns the prefix from the classname of the format namespaceprefix:name eg. cm_person
* @return prefix - returns the prefix of the classname
*/
@@ -303,12 +261,11 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
/**
* @param input -gets a string input and validates it
*
* @return null if invalid or the string itself if its valid
*/
public String getValidInput(String input)
{
if((input != null) && (input.length() > 0))
if ((input != null) && (input.length() != 0))
{
return input;
}
@@ -319,26 +276,17 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
}
/**
*
* @param classfilter =>valid class filters are all,apect or type
* @return true if valid or false if invalid
*/
public boolean isValidClassFilter(String classfilter)
{
if(classfilter.equals(CLASS_FILTER_OPTION_TYPE1) ||
classfilter.equals(CLASS_FILTER_OPTION_TYPE2) ||
classfilter.equals(CLASS_FILTER_OPTION_TYPE3))
{
return true;
}
else
{
return false;
}
return (classfilter.equals(CLASS_FILTER_OPTION_TYPE1) ||
classfilter.equals(CLASS_FILTER_OPTION_TYPE2) ||
classfilter.equals(CLASS_FILTER_OPTION_TYPE3));
}
/**
* @param
* @return a string map or prefixes and urls - with prefix as the key
*/
public Map<String, String> getPrefixesAndUrlsMap()
@@ -347,8 +295,7 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript
}
/**
*
* @return- a string map of urls and prefixes - with url as the key
* @return a string map of urls and prefixes - with url as the key
*/
public Map<String, String> getUrlsAndPrefixesMap()
{