Split of the template node functionality into new interface hierarchy and appropriate base classes impl.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5418 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Kevin Roast 2007-03-23 16:26:09 +00:00
parent 20b62e50ca
commit 1e05a3b0ac
27 changed files with 1316 additions and 1016 deletions

View File

@ -39,13 +39,13 @@ import org.alfresco.repo.action.ParameterDefinitionImpl;
import org.alfresco.repo.template.DateCompareMethod; import org.alfresco.repo.template.DateCompareMethod;
import org.alfresco.repo.template.HasAspectMethod; import org.alfresco.repo.template.HasAspectMethod;
import org.alfresco.repo.template.I18NMessageMethod; import org.alfresco.repo.template.I18NMessageMethod;
import org.alfresco.repo.template.TemplateNode;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.action.Action; import org.alfresco.service.cmr.action.Action;
import org.alfresco.service.cmr.action.ParameterDefinition; import org.alfresco.service.cmr.action.ParameterDefinition;
import org.alfresco.service.cmr.dictionary.DataTypeDefinition; import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.alfresco.service.cmr.repository.TemplateService; import org.alfresco.service.cmr.repository.TemplateService;
import org.alfresco.service.cmr.security.AuthenticationService; import org.alfresco.service.cmr.security.AuthenticationService;
import org.alfresco.service.cmr.security.AuthorityService; import org.alfresco.service.cmr.security.AuthorityService;

View File

@ -31,10 +31,10 @@ import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.alfresco.repo.template.TemplateNode;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.StoreRef; import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter; import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter;
import org.alfresco.service.cmr.repository.datatype.Duration; import org.alfresco.service.cmr.repository.datatype.Duration;
import org.alfresco.service.cmr.search.ResultSet; import org.alfresco.service.cmr.search.ResultSet;

View File

@ -30,11 +30,11 @@ import java.util.Collections;
import java.util.List; import java.util.List;
import org.alfresco.model.ContentModel; import org.alfresco.model.ContentModel;
import org.alfresco.repo.template.TemplateNode;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.ChildAssociationRef; import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.TemplateImageResolver; import org.alfresco.service.cmr.repository.TemplateImageResolver;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.alfresco.service.cmr.search.CategoryService; import org.alfresco.service.cmr.search.CategoryService;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;

View File

@ -40,6 +40,7 @@ import org.alfresco.repo.action.executer.TransformActionExecuter;
import org.alfresco.repo.content.transform.magick.ImageMagickContentTransformer; import org.alfresco.repo.content.transform.magick.ImageMagickContentTransformer;
import org.alfresco.repo.search.QueryParameterDefImpl; import org.alfresco.repo.search.QueryParameterDefImpl;
import org.alfresco.repo.template.FreeMarkerProcessor; import org.alfresco.repo.template.FreeMarkerProcessor;
import org.alfresco.repo.template.TemplateNode;
import org.alfresco.repo.version.VersionModel; import org.alfresco.repo.version.VersionModel;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.dictionary.DataTypeDefinition; import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
@ -56,7 +57,6 @@ import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.StoreRef; import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.repository.TemplateImageResolver; import org.alfresco.service.cmr.repository.TemplateImageResolver;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.alfresco.service.cmr.search.QueryParameterDefinition; import org.alfresco.service.cmr.search.QueryParameterDefinition;
import org.alfresco.service.cmr.security.AccessStatus; import org.alfresco.service.cmr.security.AccessStatus;
import org.alfresco.service.cmr.security.PermissionService; import org.alfresco.service.cmr.security.PermissionService;

View File

@ -332,6 +332,20 @@ public class FileFolderServiceImpl implements FileFolderService
return childNodeRef; return childNodeRef;
} }
public NodeRef searchSimple(NodeRef contextNodeRef, String name, QName assocName)
{
NodeRef childNodeRef = nodeService.getChildByName(contextNodeRef, assocName, name);
if (logger.isDebugEnabled())
{
logger.debug(
"Simple name search results: \n" +
" parent: " + contextNodeRef + "\n" +
" name: " + name + "\n" +
" result: " + childNodeRef);
}
return childNodeRef;
}
/** /**
* @see #search(NodeRef, String, boolean, boolean, boolean) * @see #search(NodeRef, String, boolean, boolean, boolean)
*/ */
@ -822,12 +836,21 @@ public class FileFolderServiceImpl implements FileFolderService
} }
// walk the folder tree first // walk the folder tree first
NodeRef parentNodeRef = rootNodeRef; NodeRef parentNodeRef = rootNodeRef;
StringBuilder currentPath = new StringBuilder(pathElements.size() * 20); StringBuilder currentPath = new StringBuilder(pathElements.size() << 4);
int folderCount = pathElements.size() - 1; int folderCount = pathElements.size() - 1;
for (int i = 0; i < folderCount; i++) for (int i = 0; i < folderCount; i++)
{ {
String pathElement = pathElements.get(i); String pathElement = pathElements.get(i);
NodeRef folderNodeRef = searchSimple(parentNodeRef, pathElement); NodeRef folderNodeRef;
if (i == 0 && rootNodeRef.equals(nodeService.getRootNode(rootNodeRef.getStoreRef())))
{
// store root nodes use a different assoc name to the immediate children
folderNodeRef = searchSimple(parentNodeRef, pathElement, ContentModel.ASSOC_CHILDREN);
}
else
{
folderNodeRef = searchSimple(parentNodeRef, pathElement);
}
if (folderNodeRef == null) if (folderNodeRef == null)
{ {
StringBuilder sb = new StringBuilder(128); StringBuilder sb = new StringBuilder(128);

View File

@ -0,0 +1,292 @@
/*
* Copyright (C) 2005-2007 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.template;
import java.io.Serializable;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.text.MessageFormat;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.repository.ContentData;
import org.alfresco.service.cmr.repository.ContentReader;
import org.alfresco.service.cmr.repository.ContentService;
import org.alfresco.service.cmr.repository.ContentWriter;
import org.alfresco.service.cmr.repository.TemplateException;
import org.alfresco.service.namespace.QName;
import org.springframework.util.StringUtils;
/**
* @author Kevin Roast
*/
public abstract class BaseContentNode implements TemplateContent
{
protected final static String CONTENT_DEFAULT_URL = "/download/direct/{0}/{1}/{2}/{3}";
protected final static String CONTENT_PROP_URL = "/download/direct/{0}/{1}/{2}/{3}?property={4}";
protected final static String FOLDER_BROWSE_URL = "/navigate/browse/{0}/{1}/{2}";
protected ServiceRegistry services = null;
private Boolean isDocument = null;
private Boolean isContainer = null;
/**
* @return true if this Node is a container (i.e. a folder)
*/
public boolean getIsContainer()
{
if (isContainer == null)
{
DictionaryService dd = this.services.getDictionaryService();
isContainer = Boolean.valueOf( (dd.isSubClass(getType(), ContentModel.TYPE_FOLDER) == true &&
dd.isSubClass(getType(), ContentModel.TYPE_SYSTEM_FOLDER) == false) );
}
return isContainer.booleanValue();
}
/**
* @return true if this Node is a Document (i.e. with content)
*/
public boolean getIsDocument()
{
if (isDocument == null)
{
DictionaryService dd = this.services.getDictionaryService();
isDocument = Boolean.valueOf(dd.isSubClass(getType(), ContentModel.TYPE_CONTENT));
}
return isDocument.booleanValue();
}
/**
* Override Object.toString() to provide useful debug output
*/
public String toString()
{
if (this.services.getNodeService().exists(getNodeRef()))
{
return "Node Type: " + getType() +
"\tNode Ref: " + getNodeRef().toString();
}
else
{
return "Node no longer exists: " + getNodeRef();
}
}
// ------------------------------------------------------------------------------
// Content API
/**
* @return the content String for this node from the default content property
* (@see ContentModel.PROP_CONTENT)
*/
public String getContent()
{
TemplateContentData content = (TemplateContentData)this.getProperties().get(ContentModel.PROP_CONTENT);
return content != null ? content.getContent() : "";
}
/**
* @return For a content document, this method returns the URL to the content stream for
* the default content property (@see ContentModel.PROP_CONTENT)
* <p>
* For a container node, this method return the URL to browse to the folder in the web-client
*/
public String getUrl()
{
if (getIsDocument() == true)
{
try
{
return MessageFormat.format(CONTENT_DEFAULT_URL, new Object[] {
getNodeRef().getStoreRef().getProtocol(),
getNodeRef().getStoreRef().getIdentifier(),
getNodeRef().getId(),
StringUtils.replace(URLEncoder.encode(getName(), "UTF-8"), "+", "%20") } );
}
catch (UnsupportedEncodingException err)
{
throw new TemplateException("Failed to encode content URL for node: " + getNodeRef(), err);
}
}
else
{
return MessageFormat.format(FOLDER_BROWSE_URL, new Object[] {
getNodeRef().getStoreRef().getProtocol(),
getNodeRef().getStoreRef().getIdentifier(),
getNodeRef().getId() } );
}
}
/**
* @return The mimetype encoding for content attached to the node from the default content property
* (@see ContentModel.PROP_CONTENT)
*/
public String getMimetype()
{
TemplateContentData content = (TemplateContentData)this.getProperties().get(ContentModel.PROP_CONTENT);
return (content != null ? content.getMimetype() : null);
}
/**
* @return The size in bytes of the content attached to the node from the default content property
* (@see ContentModel.PROP_CONTENT)
*/
public long getSize()
{
TemplateContentData content = (TemplateContentData)this.getProperties().get(ContentModel.PROP_CONTENT);
return (content != null ? content.getSize() : 0L);
}
// ------------------------------------------------------------------------------
// Inner classes
/**
* Inner class wrapping and providing access to a ContentData property
*/
public class TemplateContentData implements Serializable
{
/**
* Constructor
*
* @param contentData The ContentData object this object wraps
* @param property The property the ContentData is attached too
*/
public TemplateContentData(ContentData contentData, QName property)
{
this.contentData = contentData;
this.property = property;
}
/**
* @return the content stream
*/
public String getContent()
{
ContentService contentService = services.getContentService();
ContentReader reader = contentService.getReader(getNodeRef(), property);
return (reader != null && reader.exists()) ? reader.getContentString() : "";
}
/**
* @return the content stream to the specified maximum length in characters
*/
public String getContent(int length)
{
ContentService contentService = services.getContentService();
ContentReader reader = contentService.getReader(getNodeRef(), property);
return (reader != null && reader.exists()) ? reader.getContentString(length) : "";
}
/**
* @param length Length of the character stream to return, or -1 for all
*
* @return the binary content stream converted to text using any available transformer
* if fails to convert then null will be returned
*/
public String getContentAsText(int length)
{
String result = null;
if (MimetypeMap.MIMETYPE_TEXT_PLAIN.equals(getMimetype()))
{
result = getContent(length);
}
else
{
// get the content reader
ContentService contentService = services.getContentService();
ContentReader reader = contentService.getReader(getNodeRef(), property);
// get the writer and set it up for text convert
ContentWriter writer = contentService.getWriter(null, ContentModel.PROP_CONTENT, true);
writer.setMimetype("text/plain");
writer.setEncoding(reader.getEncoding());
// try and transform the content
if (contentService.isTransformable(reader, writer))
{
contentService.transform(reader, writer);
ContentReader resultReader = writer.getReader();
if (resultReader != null && reader.exists())
{
if (length != -1)
{
result = resultReader.getContentString(length);
}
else
{
result = resultReader.getContentString();
}
}
}
}
return result;
}
/**
* @return
*/
public String getUrl()
{
try
{
return MessageFormat.format(CONTENT_PROP_URL, new Object[] {
getNodeRef().getStoreRef().getProtocol(),
getNodeRef().getStoreRef().getIdentifier(),
getNodeRef().getId(),
StringUtils.replace(URLEncoder.encode(getName(), "UTF-8"), "+", "%20"),
StringUtils.replace(URLEncoder.encode(property.toString(), "UTF-8"), "+", "%20") } );
}
catch (UnsupportedEncodingException err)
{
throw new TemplateException("Failed to encode content URL for node: " + getNodeRef(), err);
}
}
public long getSize()
{
return contentData.getSize();
}
public String getMimetype()
{
return contentData.getMimetype();
}
private ContentData contentData;
private QName property;
}
}

View File

@ -30,7 +30,6 @@ import java.util.List;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.alfresco.service.cmr.search.QueryParameterDefinition; import org.alfresco.service.cmr.search.QueryParameterDefinition;
import org.apache.commons.logging.Log; import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory; import org.apache.commons.logging.LogFactory;

View File

@ -0,0 +1,87 @@
/*
* Copyright (C) 2005-2007 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.template;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import org.alfresco.service.cmr.security.AccessPermission;
import org.alfresco.service.cmr.security.AccessStatus;
/**
* @author Kevin Roast
*/
public abstract class BasePermissionsNode extends BaseContentNode implements TemplatePermissions
{
private List<String> permissions = null;
// ------------------------------------------------------------------------------
// Security API
/**
* @return List of permissions applied to this Node.
* Strings returned are of the format [ALLOWED|DENIED];[USERNAME|GROUPNAME];PERMISSION for example
* ALLOWED;kevinr;Consumer so can be easily tokenized on the ';' character.
*/
public List<String> getPermissions()
{
if (this.permissions == null)
{
String userName = this.services.getAuthenticationService().getCurrentUserName();
this.permissions = new ArrayList<String>(4);
Set<AccessPermission> acls = this.services.getPermissionService().getAllSetPermissions(getNodeRef());
for (AccessPermission permission : acls)
{
StringBuilder buf = new StringBuilder(64);
buf.append(permission.getAccessStatus())
.append(';')
.append(permission.getAuthority())
.append(';')
.append(permission.getPermission());
this.permissions.add(buf.toString());
}
}
return this.permissions;
}
/**
* @return true if this node inherits permissions from its parent node, false otherwise.
*/
public boolean getInheritsPermissions()
{
return this.services.getPermissionService().getInheritParentPermissions(getNodeRef());
}
/**
* @param permission Permission name to test
*
* @return true if the current user is granted the specified permission on the node
*/
public boolean hasPermission(String permission)
{
return (this.services.getPermissionService().hasPermission(getNodeRef(), permission) == AccessStatus.ALLOWED);
}
}

View File

@ -32,7 +32,6 @@ import java.util.List;
import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.alfresco.service.cmr.search.ResultSet; import org.alfresco.service.cmr.search.ResultSet;
import org.alfresco.service.cmr.search.ResultSetRow; import org.alfresco.service.cmr.search.ResultSetRow;
import org.alfresco.service.cmr.search.SearchService; import org.alfresco.service.cmr.search.SearchService;

View File

@ -1,18 +1,26 @@
/* /*
* Copyright (C) 2005 Alfresco, Inc. * Copyright (C) 2005-2007 Alfresco Software Limited.
* *
* Licensed under the Mozilla Public License version 1.1 * This program is free software; you can redistribute it and/or
* with a permitted attribution clause. You may obtain a * modify it under the terms of the GNU General Public License
* copy of the License at * as published by the Free Software Foundation; either version 2
* * of the License, or (at your option) any later version.
* http://www.alfresco.org/legal/license.txt
* * This program is distributed in the hope that it will be useful,
* Unless required by applicable law or agreed to in writing, * but WITHOUT ANY WARRANTY; without even the implied warranty of
* software distributed under the License is distributed on an * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, * GNU General Public License for more details.
* either express or implied. See the License for the specific
* language governing permissions and limitations under the * You should have received a copy of the GNU General Public License
* 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.template; package org.alfresco.repo.template;

View File

@ -27,7 +27,6 @@ package org.alfresco.repo.template;
import java.util.HashMap; import java.util.HashMap;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.TemplateNode;
/** /**
* An abstract Map class that can be used process the parent Node as part of the get() * An abstract Map class that can be used process the parent Node as part of the get()

View File

@ -26,9 +26,7 @@ package org.alfresco.repo.template;
import java.util.List; import java.util.List;
import org.alfresco.model.ContentModel; import org.alfresco.repo.template.BaseContentNode.TemplateContentData;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.alfresco.service.cmr.repository.TemplateNode.TemplateContentData;
import freemarker.ext.beans.BeanModel; import freemarker.ext.beans.BeanModel;
import freemarker.template.TemplateMethodModelEx; import freemarker.template.TemplateMethodModelEx;

View File

@ -37,7 +37,6 @@ import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.TemplateException; import org.alfresco.service.cmr.repository.TemplateException;
import org.alfresco.service.cmr.repository.TemplateExtensionImplementation; import org.alfresco.service.cmr.repository.TemplateExtensionImplementation;
import org.alfresco.service.cmr.repository.TemplateImageResolver; import org.alfresco.service.cmr.repository.TemplateImageResolver;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.alfresco.service.cmr.repository.TemplateProcessor; import org.alfresco.service.cmr.repository.TemplateProcessor;
import org.apache.log4j.Logger; import org.apache.log4j.Logger;

View File

@ -26,7 +26,6 @@ package org.alfresco.repo.template;
import java.util.List; import java.util.List;
import org.alfresco.service.cmr.repository.TemplateNode;
import freemarker.ext.beans.BeanModel; import freemarker.ext.beans.BeanModel;
import freemarker.template.TemplateMethodModelEx; import freemarker.template.TemplateMethodModelEx;

View File

@ -26,7 +26,6 @@ package org.alfresco.repo.template;
import java.util.List; import java.util.List;
import org.alfresco.service.cmr.repository.TemplateNode;
import freemarker.ext.beans.BeanModel; import freemarker.ext.beans.BeanModel;
import freemarker.template.TemplateMethodModelEx; import freemarker.template.TemplateMethodModelEx;

View File

@ -31,7 +31,6 @@ import org.alfresco.model.ContentModel;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.ContentReader; import org.alfresco.service.cmr.repository.ContentReader;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.dom4j.Document; import org.dom4j.Document;
import org.dom4j.Element; import org.dom4j.Element;
import org.dom4j.io.SAXReader; import org.dom4j.io.SAXReader;

View File

@ -30,7 +30,6 @@ import java.util.StringTokenizer;
import org.alfresco.repo.search.QueryParameterDefImpl; import org.alfresco.repo.search.QueryParameterDefImpl;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.dictionary.DataTypeDefinition; import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.alfresco.service.cmr.search.QueryParameterDefinition; import org.alfresco.service.cmr.search.QueryParameterDefinition;
import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;

View File

@ -28,7 +28,6 @@ import java.util.List;
import org.alfresco.repo.search.impl.lucene.LuceneQueryParser; import org.alfresco.repo.search.impl.lucene.LuceneQueryParser;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.TemplateNode;
/** /**
* Provides functionality to execute a Lucene search for a single node by NodeRef. * Provides functionality to execute a Lucene search for a single node by NodeRef.

View File

@ -31,7 +31,6 @@ import org.alfresco.model.ContentModel;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.ContentReader; import org.alfresco.service.cmr.repository.ContentReader;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.dom4j.Document; import org.dom4j.Document;
import org.dom4j.Element; import org.dom4j.Element;
import org.dom4j.io.SAXReader; import org.dom4j.io.SAXReader;

View File

@ -0,0 +1,58 @@
/*
* Copyright (C) 2005-2007 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.template;
/**
* @author Kevin Roast
*/
public interface TemplateContent extends TemplateProperties
{
/**
* @return the content String for this node from the default content property
* (@see ContentModel.PROP_CONTENT)
*/
public String getContent();
/**
* @return For a content document, this method returns the URL to the content stream for
* the default content property (@see ContentModel.PROP_CONTENT)
* <p>
* For a container node, this method return the URL to browse to the folder in the web-client
*/
public String getUrl();
/**
* @return The mimetype encoding for content attached to the node from the default content property
* (@see ContentModel.PROP_CONTENT)
*/
public String getMimetype();
/**
* @return The size in bytes of the content attached to the node from the default content property
* (@see ContentModel.PROP_CONTENT)
*/
public long getSize();
}

View File

@ -22,13 +22,10 @@
* the FLOSS exception, and it is also available here: * the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing" * http://www.alfresco.com/legal/licensing"
*/ */
package org.alfresco.service.cmr.repository; package org.alfresco.repo.template;
import java.io.Serializable; import java.io.Serializable;
import java.io.StringReader; import java.io.StringReader;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.text.MessageFormat;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections; import java.util.Collections;
import java.util.List; import java.util.List;
@ -36,20 +33,16 @@ import java.util.Map;
import java.util.Set; import java.util.Set;
import org.alfresco.model.ContentModel; import org.alfresco.model.ContentModel;
import org.alfresco.repo.action.executer.TransformActionExecuter;
import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.repo.security.permissions.AccessDeniedException; import org.alfresco.repo.security.permissions.AccessDeniedException;
import org.alfresco.repo.template.LuceneSearchResultsMap;
import org.alfresco.repo.template.NamePathResultsMap;
import org.alfresco.repo.template.NodeSearchResultsMap;
import org.alfresco.repo.template.SavedSearchResultsMap;
import org.alfresco.repo.template.XPathResultsMap;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.audit.AuditInfo; import org.alfresco.service.cmr.audit.AuditInfo;
import org.alfresco.service.cmr.dictionary.DictionaryService; import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.lock.LockStatus; import org.alfresco.service.cmr.lock.LockStatus;
import org.alfresco.service.cmr.security.AccessPermission; import org.alfresco.service.cmr.repository.AssociationRef;
import org.alfresco.service.cmr.security.AccessStatus; import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.ContentData;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.TemplateImageResolver;
import org.alfresco.service.cmr.version.Version; import org.alfresco.service.cmr.version.Version;
import org.alfresco.service.cmr.version.VersionHistory; import org.alfresco.service.cmr.version.VersionHistory;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@ -57,7 +50,6 @@ import org.alfresco.service.namespace.QNameMap;
import org.alfresco.service.namespace.RegexQNamePattern; import org.alfresco.service.namespace.RegexQNamePattern;
import org.apache.commons.logging.Log; import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory; import org.apache.commons.logging.LogFactory;
import org.springframework.util.StringUtils;
import org.xml.sax.InputSource; import org.xml.sax.InputSource;
import freemarker.ext.dom.NodeModel; import freemarker.ext.dom.NodeModel;
@ -74,19 +66,16 @@ import freemarker.ext.dom.NodeModel;
* *
* @author Kevin Roast * @author Kevin Roast
*/ */
public class TemplateNode implements Serializable public class TemplateNode extends BasePermissionsNode
{ {
private static final long serialVersionUID = 1234390333739034171L; private static final long serialVersionUID = 1234390333739034171L;
private static Log logger = LogFactory.getLog(TemplateNode.class); private static Log logger = LogFactory.getLog(TemplateNode.class);
protected final static String NAMESPACE_BEGIN = "" + QName.NAMESPACE_BEGIN; protected final static String NAMESPACE_BEGIN = "" + QName.NAMESPACE_BEGIN;
protected final static String CONTENT_DEFAULT_URL = "/download/direct/{0}/{1}/{2}/{3}";
private final static String CONTENT_PROP_URL = "/download/direct/{0}/{1}/{2}/{3}?property={4}";
private final static String FOLDER_BROWSE_URL = "/navigate/browse/{0}/{1}/{2}";
/** The children of this node */ /** The children of this node */
private List<TemplateNode> children = null; private List<TemplateProperties> children = null;
/** The target associations from this node */ /** The target associations from this node */
private Map<String, List<TemplateNode>> targetAssocs = null; private Map<String, List<TemplateNode>> targetAssocs = null;
@ -105,14 +94,8 @@ public class TemplateNode implements Serializable
private String id; private String id;
private Set<QName> aspects = null; private Set<QName> aspects = null;
private QNameMap<String, Serializable> properties; private QNameMap<String, Serializable> properties;
private List<String> permissions = null;
private boolean propsRetrieved = false; private boolean propsRetrieved = false;
protected ServiceRegistry services = null;
private Boolean isDocument = null;
private Boolean isContainer = null;
private String displayPath = null; private String displayPath = null;
private String mimetype = null;
private Long size = null;
protected TemplateImageResolver imageResolver = null; protected TemplateImageResolver imageResolver = null;
private TemplateNode parent = null; private TemplateNode parent = null;
private ChildAssociationRef primaryParentAssoc = null; private ChildAssociationRef primaryParentAssoc = null;
@ -151,7 +134,7 @@ public class TemplateNode implements Serializable
// ------------------------------------------------------------------------------ // ------------------------------------------------------------------------------
// Node API // TemplateNodeRef contract implementation
/** /**
* @return The GUID for the node * @return The GUID for the node
@ -210,15 +193,19 @@ public class TemplateNode implements Serializable
return this.name; return this.name;
} }
// ------------------------------------------------------------------------------
// TemplateProperties contract implementation
/** /**
* @return The children of this Node as TemplateNode wrappers * @return The children of this Node as objects that support the TemplateProperties contract.
*/ */
public List<TemplateNode> getChildren() public List<TemplateProperties> getChildren()
{ {
if (this.children == null) if (this.children == null)
{ {
List<ChildAssociationRef> childRefs = this.services.getNodeService().getChildAssocs(this.nodeRef); List<ChildAssociationRef> childRefs = this.services.getNodeService().getChildAssocs(this.nodeRef);
this.children = new ArrayList<TemplateNode>(childRefs.size()); this.children = new ArrayList<TemplateProperties>(childRefs.size());
for (ChildAssociationRef ref : childRefs) for (ChildAssociationRef ref : childRefs)
{ {
// create our Node representation from the NodeRef // create our Node representation from the NodeRef
@ -230,6 +217,87 @@ public class TemplateNode implements Serializable
return this.children; return this.children;
} }
/**
* @return All the properties known about this node.
*/
public Map<String, Serializable> getProperties()
{
if (this.propsRetrieved == false)
{
Map<QName, Serializable> props = this.services.getNodeService().getProperties(this.nodeRef);
for (QName qname : props.keySet())
{
Serializable propValue = props.get(qname);
if (propValue instanceof NodeRef)
{
// NodeRef object properties are converted to new TemplateNode objects
// so they can be used as objects within a template
propValue = new TemplateNode(((NodeRef)propValue), this.services, this.imageResolver);
}
else if (propValue instanceof ContentData)
{
// ContentData object properties are converted to TemplateContentData objects
// so the content and other properties of those objects can be accessed
propValue = new TemplateContentData((ContentData)propValue, qname);
}
this.properties.put(qname.toString(), propValue);
}
this.propsRetrieved = true;
}
return this.properties;
}
/**
* @return The list of aspects applied to this node
*/
public Set<QName> getAspects()
{
if (this.aspects == null)
{
this.aspects = this.services.getNodeService().getAspects(this.nodeRef);
}
return this.aspects;
}
/**
* @param aspect The aspect name to test for
*
* @return true if the node has the aspect false otherwise
*/
public boolean hasAspect(String aspect)
{
if (this.aspects == null)
{
this.aspects = this.services.getNodeService().getAspects(this.nodeRef);
}
if (aspect.startsWith(NAMESPACE_BEGIN))
{
return aspects.contains((QName.createQName(aspect)));
}
else
{
boolean found = false;
for (QName qname : this.aspects)
{
if (qname.toPrefixString(this.services.getNamespaceService()).equals(aspect))
{
found = true;
break;
}
}
return found;
}
}
// ------------------------------------------------------------------------------
// Repository Node API
/** /**
* @return The child associations for this Node. As a Map of assoc name to a List of TemplateNodes. * @return The child associations for this Node. As a Map of assoc name to a List of TemplateNodes.
*/ */
@ -296,140 +364,6 @@ public class TemplateNode implements Serializable
return this.assocs; return this.assocs;
} }
/**
* @return All the properties known about this node.
*/
public Map<String, Serializable> getProperties()
{
if (this.propsRetrieved == false)
{
Map<QName, Serializable> props = this.services.getNodeService().getProperties(this.nodeRef);
for (QName qname : props.keySet())
{
Serializable propValue = props.get(qname);
if (propValue instanceof NodeRef)
{
// NodeRef object properties are converted to new TemplateNode objects
// so they can be used as objects within a template
propValue = new TemplateNode(((NodeRef)propValue), this.services, this.imageResolver);
}
else if (propValue instanceof ContentData)
{
// ContentData object properties are converted to TemplateContentData objects
// so the content and other properties of those objects can be accessed
propValue = new TemplateContentData((ContentData)propValue, qname);
}
this.properties.put(qname.toString(), propValue);
}
this.propsRetrieved = true;
}
return this.properties;
}
/**
* @return a list of objects representing the version history of this node.
* @see VersionHistoryNode
*/
public List<VersionHistoryNode> getVersionHistory()
{
List<VersionHistoryNode> records = Collections.<VersionHistoryNode>emptyList();
if (this.getAspects().contains(ContentModel.ASPECT_VERSIONABLE))
{
VersionHistory history = this.services.getVersionService().getVersionHistory(this.nodeRef);
if (history != null)
{
records = new ArrayList<VersionHistoryNode>(8);
for (Version version : history.getAllVersions())
{
// create a wrapper for the version information
VersionHistoryNode record = new VersionHistoryNode(version, this);
// add the client side version to the list
records.add(record);
}
}
}
return records;
}
/**
* @return true if this Node is a container (i.e. a folder)
*/
public boolean getIsContainer()
{
if (isContainer == null)
{
DictionaryService dd = this.services.getDictionaryService();
isContainer = Boolean.valueOf( (dd.isSubClass(getType(), ContentModel.TYPE_FOLDER) == true &&
dd.isSubClass(getType(), ContentModel.TYPE_SYSTEM_FOLDER) == false) );
}
return isContainer.booleanValue();
}
/**
* @return true if this Node is a Document (i.e. with content)
*/
public boolean getIsDocument()
{
if (isDocument == null)
{
DictionaryService dd = this.services.getDictionaryService();
isDocument = Boolean.valueOf(dd.isSubClass(getType(), ContentModel.TYPE_CONTENT));
}
return isDocument.booleanValue();
}
/**
* @return The list of aspects applied to this node
*/
public Set<QName> getAspects()
{
if (this.aspects == null)
{
this.aspects = this.services.getNodeService().getAspects(this.nodeRef);
}
return this.aspects;
}
/**
* @param aspect The aspect name to test for
*
* @return true if the node has the aspect false otherwise
*/
public boolean hasAspect(String aspect)
{
if (this.aspects == null)
{
this.aspects = this.services.getNodeService().getAspects(this.nodeRef);
}
if (aspect.startsWith(NAMESPACE_BEGIN))
{
return aspects.contains((QName.createQName(aspect)));
}
else
{
boolean found = false;
for (QName qname : this.aspects)
{
if (qname.toPrefixString(this.services.getNamespaceService()).equals(aspect))
{
found = true;
break;
}
}
return found;
}
}
/** /**
* @return true if the node is currently locked * @return true if the node is currently locked
*/ */
@ -493,86 +427,32 @@ public class TemplateNode implements Serializable
return primaryParentAssoc; return primaryParentAssoc;
} }
// ------------------------------------------------------------------------------
// Content API
/** /**
* @return the content String for this node from the default content property * @return a list of objects representing the version history of this node.
* (@see ContentModel.PROP_CONTENT) * @see VersionHistoryNode
*/ */
public String getContent() public List<VersionHistoryNode> getVersionHistory()
{ {
TemplateContentData content = (TemplateContentData)this.getProperties().get(ContentModel.PROP_CONTENT); List<VersionHistoryNode> records = Collections.<VersionHistoryNode>emptyList();
return content != null ? content.getContent() : "";
}
/** if (this.getAspects().contains(ContentModel.ASPECT_VERSIONABLE))
* @return For a content document, this method returns the URL to the content stream for
* the default content property (@see ContentModel.PROP_CONTENT)
* <p>
* For a container node, this method return the URL to browse to the folder in the web-client
*/
public String getUrl()
{
if (getIsDocument() == true)
{ {
try VersionHistory history = this.services.getVersionService().getVersionHistory(this.nodeRef);
if (history != null)
{ {
return MessageFormat.format(CONTENT_DEFAULT_URL, new Object[] { records = new ArrayList<VersionHistoryNode>(8);
nodeRef.getStoreRef().getProtocol(), for (Version version : history.getAllVersions())
nodeRef.getStoreRef().getIdentifier(), {
nodeRef.getId(), // create a wrapper for the version information
StringUtils.replace(URLEncoder.encode(getName(), "UTF-8"), "+", "%20") } ); VersionHistoryNode record = new VersionHistoryNode(version, this, this.services);
}
catch (UnsupportedEncodingException err)
{
throw new TemplateException("Failed to encode content URL for node: " + nodeRef, err);
}
}
else
{
return MessageFormat.format(FOLDER_BROWSE_URL, new Object[] {
nodeRef.getStoreRef().getProtocol(),
nodeRef.getStoreRef().getIdentifier(),
nodeRef.getId() } );
}
}
/** // add the client side version to the list
* @return The mimetype encoding for content attached to the node from the default content property records.add(record);
* (@see ContentModel.PROP_CONTENT) }
*/
public String getMimetype()
{
if (mimetype == null)
{
TemplateContentData content = (TemplateContentData)this.getProperties().get(ContentModel.PROP_CONTENT);
if (content != null)
{
mimetype = content.getMimetype();
} }
} }
return mimetype; return records;
}
/**
* @return The size in bytes of the content attached to the node from the default content property
* (@see ContentModel.PROP_CONTENT)
*/
public long getSize()
{
if (size == null)
{
TemplateContentData content = (TemplateContentData)this.getProperties().get(ContentModel.PROP_CONTENT);
if (content != null)
{
size = content.getSize();
}
}
return size != null ? size.longValue() : 0L;
} }
@ -686,54 +566,6 @@ public class TemplateNode implements Serializable
} }
// ------------------------------------------------------------------------------
// Security API
/**
* @return List of permissions applied to this Node.
* Strings returned are of the format [ALLOWED|DENIED];[USERNAME|GROUPNAME];PERMISSION for example
* ALLOWED;kevinr;Consumer so can be easily tokenized on the ';' character.
*/
public List<String> getPermissions()
{
if (this.permissions == null)
{
String userName = this.services.getAuthenticationService().getCurrentUserName();
this.permissions = new ArrayList<String>(4);
Set<AccessPermission> acls = this.services.getPermissionService().getAllSetPermissions(this.nodeRef);
for (AccessPermission permission : acls)
{
StringBuilder buf = new StringBuilder(64);
buf.append(permission.getAccessStatus())
.append(';')
.append(permission.getAuthority())
.append(';')
.append(permission.getPermission());
this.permissions.add(buf.toString());
}
}
return this.permissions;
}
/**
* @return true if this node inherits permissions from its parent node, false otherwise.
*/
public boolean getInheritsPermissions()
{
return this.services.getPermissionService().getInheritParentPermissions(this.nodeRef);
}
/**
* @param permission Permission name to test
*
* @return true if the current user is granted the specified permission on the node
*/
public boolean hasPermission(String permission)
{
return (this.services.getPermissionService().hasPermission(this.nodeRef, permission) == AccessStatus.ALLOWED);
}
// ------------------------------------------------------------------------------ // ------------------------------------------------------------------------------
// Search API // Search API
@ -803,144 +635,4 @@ public class TemplateNode implements Serializable
{ {
return this.imageResolver; return this.imageResolver;
} }
/**
* Override Object.toString() to provide useful debug output
*/
public String toString()
{
if (this.services.getNodeService().exists(nodeRef))
{
return "Node Type: " + getType() +
"\tNode Ref: " + this.nodeRef.toString();
}
else
{
return "Node no longer exists: " + nodeRef;
}
}
// ------------------------------------------------------------------------------
// Inner classes
/**
* Inner class wrapping and providing access to a ContentData property
*/
public class TemplateContentData implements Serializable
{
/**
* Constructor
*
* @param contentData The ContentData object this object wraps
* @param property The property the ContentData is attached too
*/
public TemplateContentData(ContentData contentData, QName property)
{
this.contentData = contentData;
this.property = property;
}
/**
* @return the content stream
*/
public String getContent()
{
ContentService contentService = services.getContentService();
ContentReader reader = contentService.getReader(nodeRef, property);
return (reader != null && reader.exists()) ? reader.getContentString() : "";
}
/**
* @return the content stream to the specified maximum length in characters
*/
public String getContent(int length)
{
ContentService contentService = services.getContentService();
ContentReader reader = contentService.getReader(nodeRef, property);
return (reader != null && reader.exists()) ? reader.getContentString(length) : "";
}
/**
* @param length Length of the character stream to return, or -1 for all
*
* @return the binary content stream converted to text using any available transformer
* if fails to convert then null will be returned
*/
public String getContentAsText(int length)
{
String result = null;
if (MimetypeMap.MIMETYPE_TEXT_PLAIN.equals(mimetype))
{
result = getContent(length);
}
else
{
// get the content reader
ContentService contentService = services.getContentService();
ContentReader reader = contentService.getReader(nodeRef, property);
// get the writer and set it up for text convert
ContentWriter writer = contentService.getWriter(null, ContentModel.PROP_CONTENT, true);
writer.setMimetype("text/plain");
writer.setEncoding(reader.getEncoding());
// try and transform the content
if (contentService.isTransformable(reader, writer))
{
contentService.transform(reader, writer);
ContentReader resultReader = writer.getReader();
if (resultReader != null && reader.exists())
{
if (length != -1)
{
result = resultReader.getContentString(length);
}
else
{
result = resultReader.getContentString();
}
}
}
}
return result;
}
/**
* @return
*/
public String getUrl()
{
try
{
return MessageFormat.format(CONTENT_PROP_URL, new Object[] {
nodeRef.getStoreRef().getProtocol(),
nodeRef.getStoreRef().getIdentifier(),
nodeRef.getId(),
StringUtils.replace(URLEncoder.encode(getName(), "UTF-8"), "+", "%20"),
StringUtils.replace(URLEncoder.encode(property.toString(), "UTF-8"), "+", "%20") } );
}
catch (UnsupportedEncodingException err)
{
throw new TemplateException("Failed to encode content URL for node: " + nodeRef, err);
}
}
public long getSize()
{
return contentData.getSize();
}
public String getMimetype()
{
return contentData.getMimetype();
}
private ContentData contentData;
private QName property;
}
} }

View File

@ -0,0 +1,56 @@
/*
* Copyright (C) 2005-2007 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.template;
import java.io.Serializable;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName;
/**
* @author Kevin Roast
*/
public interface TemplateNodeRef extends Serializable
{
/**
* @return The GUID for the node
*/
public String getId();
/**
* @return Returns the NodeRef this Node object represents
*/
public NodeRef getNodeRef();
/**
* @return Returns the type.
*/
public QName getType();
/**
* @return The display name for the node
*/
public String getName();
}

View File

@ -0,0 +1,52 @@
/*
* Copyright (C) 2005-2007 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.template;
import java.util.List;
/**
* @author Kevin Roast
*/
public interface TemplatePermissions extends TemplateNodeRef
{
/**
* @return List of permissions applied to this Node.
* Strings returned are of the format [ALLOWED|DENIED];[USERNAME|GROUPNAME];PERMISSION for example
* ALLOWED;kevinr;Consumer so can be easily tokenized on the ';' character.
*/
public List<String> getPermissions();
/**
* @return true if this node inherits permissions from its parent node, false otherwise.
*/
public boolean getInheritsPermissions();
/**
* @param permission Permission name to test
*
* @return true if the current user is granted the specified permission on the node
*/
public boolean hasPermission(String permission);
}

View File

@ -0,0 +1,60 @@
/*
* Copyright (C) 2005-2007 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.template;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.alfresco.service.namespace.QName;
/**
* @author Kevin Roast
*/
public interface TemplateProperties extends TemplateNodeRef
{
/**
* @return The properties available on this node.
*/
public Map<String, Serializable> getProperties();
/**
* @return The list of aspects applied to this node
*/
public Set<QName> getAspects();
/**
* @param aspect The aspect name to test for
*
* @return true if the node has the aspect false otherwise
*/
public boolean hasAspect(String aspect);
/**
* @return The children of this Node as TemplateNode wrappers
*/
public List<TemplateProperties> getChildren();
}

View File

@ -42,7 +42,6 @@ import org.alfresco.service.cmr.repository.ContentService;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.StoreRef; import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.repository.TemplateNode;
import org.alfresco.service.cmr.repository.TemplateService; import org.alfresco.service.cmr.repository.TemplateService;
import org.alfresco.service.transaction.TransactionService; import org.alfresco.service.transaction.TransactionService;
import org.alfresco.util.ApplicationContextHelper; import org.alfresco.util.ApplicationContextHelper;

View File

@ -22,18 +22,22 @@
* the FLOSS exception, and it is also available here: * the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing" * http://www.alfresco.com/legal/licensing"
*/ */
package org.alfresco.service.cmr.repository; package org.alfresco.repo.template;
import java.io.Serializable; import java.io.Serializable;
import java.io.UnsupportedEncodingException; import java.io.UnsupportedEncodingException;
import java.net.URLEncoder; import java.net.URLEncoder;
import java.text.MessageFormat; import java.text.MessageFormat;
import java.util.Date; import java.util.Date;
import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import org.alfresco.model.ContentModel; import org.alfresco.model.ContentModel;
import org.alfresco.service.cmr.repository.TemplateNode.TemplateContentData; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.ContentData;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.TemplateException;
import org.alfresco.service.cmr.version.Version; import org.alfresco.service.cmr.version.Version;
import org.alfresco.service.cmr.version.VersionType; import org.alfresco.service.cmr.version.VersionType;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@ -46,7 +50,7 @@ import org.springframework.util.StringUtils;
* *
* @author Kevin Roast * @author Kevin Roast
*/ */
public class VersionHistoryNode implements Serializable public class VersionHistoryNode extends BaseContentNode
{ {
private QNameMap<String, Serializable> properties; private QNameMap<String, Serializable> properties;
private boolean propsRetrieved = false; private boolean propsRetrieved = false;
@ -59,7 +63,7 @@ public class VersionHistoryNode implements Serializable
* *
* @param version Descriptor of the node version information * @param version Descriptor of the node version information
*/ */
public VersionHistoryNode(Version version, TemplateNode parent) public VersionHistoryNode(Version version, TemplateNode parent, ServiceRegistry services)
{ {
if (version == null) if (version == null)
{ {
@ -69,8 +73,13 @@ public class VersionHistoryNode implements Serializable
{ {
throw new IllegalArgumentException("Parent TemplateNode is mandatory."); throw new IllegalArgumentException("Parent TemplateNode is mandatory.");
} }
if (services == null)
{
throw new IllegalArgumentException("The ServiceRegistry must be supplied.");
}
this.version = version; this.version = version;
this.parent = parent; this.parent = parent;
this.services = services;
this.properties = new QNameMap<String, Serializable>(parent.services.getNamespaceService()); this.properties = new QNameMap<String, Serializable>(parent.services.getNamespaceService());
} }
@ -238,26 +247,23 @@ public class VersionHistoryNode implements Serializable
} }
} }
/**
* @see org.alfresco.repo.template.TemplateProperties#getChildren()
*/
public List<TemplateProperties> getChildren()
{
return null;
}
// ------------------------------------------------------------------------------ // ------------------------------------------------------------------------------
// Content API // Content API
/** /**
* @return the content String for this node from the default content property * @return Returns the URL to the content stream for the frozen state of the node from
* (@see ContentModel.PROP_CONTENT)
*/
public String getContent()
{
TemplateContentData content = (TemplateContentData)this.getProperties().get(ContentModel.PROP_CONTENT);
return content != null ? content.getContent() : "";
}
/**
* @return For a content document, this method returns the URL to the content stream for
* the default content property (@see ContentModel.PROP_CONTENT) * the default content property (@see ContentModel.PROP_CONTENT)
* <p>
* For a container node, this method return the URL to browse to the folder in the web-client
*/ */
@Override
public String getUrl() public String getUrl()
{ {
NodeRef nodeRef = this.version.getFrozenStateNodeRef(); NodeRef nodeRef = this.version.getFrozenStateNodeRef();
@ -274,24 +280,4 @@ public class VersionHistoryNode implements Serializable
throw new TemplateException("Failed to encode content URL for node: " + nodeRef, err); throw new TemplateException("Failed to encode content URL for node: " + nodeRef, err);
} }
} }
/**
* @return The mimetype encoding for content attached to the node from the default content property
* (@see ContentModel.PROP_CONTENT)
*/
public String getMimetype()
{
TemplateContentData content = (TemplateContentData)this.getProperties().get(ContentModel.PROP_CONTENT);
return (content != null ? content.getMimetype() : null);
}
/**
* @return The size in bytes of the content attached to the node from the default content property
* (@see ContentModel.PROP_CONTENT)
*/
public long getSize()
{
TemplateContentData content = (TemplateContentData)this.getProperties().get(ContentModel.PROP_CONTENT);
return (content != null ? content.getSize() : 0L);
}
} }

View File

@ -25,7 +25,6 @@
package org.alfresco.repo.template; package org.alfresco.repo.template;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.TemplateNode;
/** /**
* A special Map that executes an XPath against the parent Node as part of the get() * A special Map that executes an XPath against the parent Node as part of the get()