Index Score
		org.alfresco.repo.jscript
		Alfresco

View: Reasons, Metrics, Source Code

These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.

Metric	Description
DECL_COMMENTS	Comments in declarations
SIZE	Size of the file in bytes
DOC_COMMENT	Number of javadoc comment lines
EXEC_COMMENTS	Comments in executable code
COMMENTS	Comment lines
LINE_COMMENT	Number of line comments
RETURNS	Number of return points from functions
EXITS	Procedure exits
INTERFACE_COMPLEXITY	Interface complexity
LINES	Number of lines in the source file
OPERATORS	Number of operators
FUNCTIONS	Number of function declarations
PROGRAM_LENGTH	Halstead program length
OPERANDS	Number of operands
LOC	Lines of code
UNIQUE_OPERANDS	Number of unique operands
CYCLOMATIC	Cyclomatic complexity
BLOCKS	Number of blocks
PARAMS	Number of formal parameter declarations
LOGICAL_LINES	Number of statements
PROGRAM_VOCAB	Halstead program vocabulary
ELOC	Effective lines of code
JAVA0081	JAVA0081 Boolean literal in comparison
JAVA0075	JAVA0075 Method parameter hides field
COMPARISONS	Number of comparison operators
WHITESPACE	Number of whitespace lines
JAVA0068	JAVA0068 Modifiers not declared in recommended order
JAVA0144	JAVA0144 Line exceeds maximum M characters
JAVA0108	JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0034	JAVA0034 Missing braces in if statement
JAVA0082	JAVA0082 Unnecessary widening cast
JAVA0179	JAVA0179 Local variable hides visible field
JAVA0270	JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0077	JAVA0077 Private field not used in declaring class
JAVA0110	JAVA0110 Incorrect javadoc: no @return tag
JAVA0117	JAVA0117 Missing javadoc: method 'method'
UNIQUE_OPERATORS	Number of unique operators
JAVA0096	JAVA0096 Field in nested class hides outer field
LOOPS	Number of loops
PROGRAM_VOLUME	Halstead program volume
JAVA0136	JAVA0136 N methods defined in class (maximum: M)
JAVA0126	JAVA0126 Method declares unchecked exception in throws
JAVA0109	JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0171	JAVA0171 Unused local variable
JAVA0265	JAVA0265 Use of Throwable.printStackTrace()
JAVA0100	JAVA0100 Class contains N non-final fields (maximum: M)
NEST_DEPTH	Maximum nesting depth
JAVA0145	JAVA0145 Tab character used in source file

/* * 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.jscript; import java.io.InputStream; import java.io.Serializable; import java.text.MessageFormat; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Set; import java.util.StringTokenizer; import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.model.ApplicationModel; import org.alfresco.model.ContentModel; import org.alfresco.repo.action.executer.TransformActionExecuter; import org.alfresco.repo.content.transform.magick.ImageTransformationOptions; import org.alfresco.repo.search.QueryParameterDefImpl; import org.alfresco.repo.tagging.script.TagScope; import org.alfresco.repo.thumbnail.CreateThumbnailActionExecuter; import org.alfresco.repo.thumbnail.ThumbnailDetails; import org.alfresco.repo.thumbnail.ThumbnailRegistry; import org.alfresco.repo.thumbnail.script.ScriptThumbnail; import org.alfresco.repo.version.VersionModel; import org.alfresco.repo.workflow.jscript.JscriptWorkflowInstance; import org.alfresco.scripts.ScriptException; import org.alfresco.service.ServiceRegistry; import org.alfresco.service.cmr.action.Action; import org.alfresco.service.cmr.dictionary.DataTypeDefinition; import org.alfresco.service.cmr.dictionary.DictionaryService; import org.alfresco.service.cmr.lock.LockStatus; import org.alfresco.service.cmr.model.FileExistsException; import org.alfresco.service.cmr.model.FileInfo; import org.alfresco.service.cmr.model.FileNotFoundException; import org.alfresco.service.cmr.repository.AssociationRef; import org.alfresco.service.cmr.repository.ChildAssociationRef; 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.NodeRef; import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.service.cmr.repository.StoreRef; import org.alfresco.service.cmr.repository.TemplateImageResolver; import org.alfresco.service.cmr.search.QueryParameterDefinition; import org.alfresco.service.cmr.security.AccessPermission; import org.alfresco.service.cmr.security.AccessStatus; import org.alfresco.service.cmr.security.PermissionService; import org.alfresco.service.cmr.version.Version; import org.alfresco.service.cmr.version.VersionHistory; import org.alfresco.service.cmr.version.VersionType; import org.alfresco.service.cmr.workflow.WorkflowInstance; import org.alfresco.service.cmr.workflow.WorkflowService; import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.RegexQNamePattern; import org.alfresco.util.Content; import org.alfresco.util.GUID; import org.alfresco.util.ParameterCheck; import org.alfresco.util.URLEncoder; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.json.JSONException; import org.json.JSONObject; import org.mozilla.javascript.Context; import org.mozilla.javascript.Scriptable; import org.mozilla.javascript.ScriptableObject; import org.mozilla.javascript.UniqueTag; import org.mozilla.javascript.Wrapper; /** * Node class implementation, specific for use by ScriptService as part of the object model. * <p> * The class exposes Node properties, children and assocs as dynamically populated maps and lists. The various collection classes are mirrored as JavaScript properties. So can be * accessed using standard JavaScript property syntax, such as <code>node.children[0].properties.name</code>. * <p> * Various helper methods are provided to access common and useful node variables such as the content url and type information. * * @author Kevin Roast */ public class ScriptNode implements Serializable, Scopeable { private static final long serialVersionUID = -3378946227712939600L; private static Log logger = LogFactory.getLog(ScriptNode.class); private final static String NAMESPACE_BEGIN = "" + QName.NAMESPACE_BEGIN; private final static String CONTENT_DEFAULT_URL = "/d/d/{0}/{1}/{2}/{3}"; private final static String CONTENT_DOWNLOAD_URL = "/d/a/{0}/{1}/{2}/{3}"; private final static String CONTENT_PROP_URL = "/d/d/{0}/{1}/{2}/{3}?property={4}"; private final static String CONTENT_DOWNLOAD_PROP_URL = "/d/a/{0}/{1}/{2}/{3}?property={4}"; private final static String FOLDER_BROWSE_URL = "/n/browse/{0}/{1}/{2}"; /** Root scope for this object */ protected Scriptable scope; /** Node Value Converter */ protected NodeValueConverter converter = null; /** Cached values */ protected NodeRef nodeRef; private String name; private QName type; protected String id; /** The aspects applied to this node */ protected Set<QName> aspects = null; /** The target associations from this node */ private ScriptableQNameMap<String, Object> targetAssocs = null; /** The source associations to this node */ private ScriptableQNameMap<String, Object> sourceAssocs = null; /** The child associations for this node */ private ScriptableQNameMap<String, Object> childAssocs = null; /** The children of this node */ private Scriptable children = null; /** The properties of this node */ private ScriptableQNameMap<String, Serializable> properties = null; /** The versions of this node */ private Scriptable versions = null; /** The active workflows acting on this node */ private Scriptable activeWorkflows = null; protected ServiceRegistry services = null; private NodeService nodeService = null; private Boolean isDocument = null; private Boolean isContainer = null; private Boolean isLinkToDocument = null; private Boolean isLinkToContainer = null; private String displayPath = null; protected TemplateImageResolver imageResolver = null; protected ScriptNode parent = null; private ChildAssociationRef primaryParentAssoc = null; // NOTE: see the reset() method when adding new cached members! // ------------------------------------------------------------------------------ // Construction /** * Constructor * * @param nodeRef The NodeRef this Node wrapper represents * @param services The ServiceRegistry the Node can use to access services * @param resolver Image resolver to use to retrieve icons */ public ScriptNode(NodeRef nodeRef, ServiceRegistry services) { this(nodeRef, services, null); } /** * Constructor * * @param nodeRef The NodeRef this Node wrapper represents * @param services The ServiceRegistry the Node can use to access services * @param resolver Image resolver to use to retrieve icons * @param scope Root scope for this Node */ public ScriptNode(NodeRef nodeRef, ServiceRegistry services, Scriptable scope) { if (nodeRef == null) { throw new IllegalArgumentException("NodeRef must be supplied."); } if (services == null) { throw new IllegalArgumentException("The ServiceRegistry must be supplied."); } this.nodeRef = nodeRef; this.id = nodeRef.getId(); this.services = services; this.nodeService = services.getNodeService(); this.scope = scope; } @Override public int hashCode() { final int PRIME = 31; int result = 1; result = PRIME * result + ((nodeRef == null) ? 0 : nodeRef.hashCode()); return result; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (getClass() != obj.getClass()) return false; if (!nodeRef.equals(((ScriptNode)obj).nodeRef)) return false; return true; } /** * Factory method */ public ScriptNode newInstance(NodeRef nodeRef, ServiceRegistry services, Scriptable scope) { return new ScriptNode(nodeRef, services, scope); } /** * @see org.alfresco.repo.jscript.Scopeable#setScope(org.mozilla.javascript.Scriptable) */ public void setScope(Scriptable scope) { this.scope = scope; } // ------------------------------------------------------------------------------ // Node Wrapper API /** * @return The GUID for the node */ public String getId() { return this.id; } /** * @return the store type for the node */ public String getStoreType() { return this.nodeRef.getStoreRef().getProtocol(); } /** * @return the store id for the node */ public String getStoreId() { return this.nodeRef.getStoreRef().getIdentifier(); } /** * @return Returns the NodeRef this Node object represents */ public NodeRef getNodeRef() { return this.nodeRef; } /** * @return Returns the QName type. */ public QName getQNameType() { if (this.type == null) { this.type = this.nodeService.getType(this.nodeRef); } return type; } /** * @return Returns the type. */ public String getType() { return getQNameType().toString(); } /** * @return Helper to return the 'name' property for the node */ public String getName() { if (this.name == null) { // try and get the name from the properties first this.name = (String) getProperties().get("cm:name"); // if we didn't find it as a property get the name from the association name if (this.name == null) { ChildAssociationRef parentRef = this.nodeService.getPrimaryParent(this.nodeRef); if (parentRef != null && parentRef.getQName() != null) { this.name = parentRef.getQName().getLocalName(); } else { this.name = ""; } } } return this.name; } /** * Helper to set the 'name' property for the node. * * @param name Name to set */ public void setName(String name) { if (name != null) { QName typeQName = getQNameType(); if ((services.getDictionaryService().isSubClass(typeQName, ContentModel.TYPE_FOLDER) && !services.getDictionaryService().isSubClass(typeQName, ContentModel.TYPE_SYSTEM_FOLDER)) || services.getDictionaryService().isSubClass(typeQName, ContentModel.TYPE_CONTENT)) { try { this.services.getFileFolderService().rename(this.nodeRef, name); } catch (FileExistsException e) { throw new AlfrescoRuntimeException("Failed to rename node " + nodeRef + " to " + name, e); } catch (FileNotFoundException e) { throw new AlfrescoRuntimeException("Failed to rename node " + nodeRef + " to " + name, e); } } this.getProperties().put(ContentModel.PROP_NAME.toString(), name.toString()); } } /** * @return The children of this Node as JavaScript array of Node object wrappers */ public Scriptable getChildren() { if (this.children == null) { List<ChildAssociationRef> childRefs = this.nodeService.getChildAssocs(this.nodeRef); Object[] children = new Object[childRefs.size()]; for (int i = 0; i < childRefs.size(); i++) { // create our Node representation from the NodeRef children[i] = newInstance(childRefs.get(i).getChildRef(), this.services, this.scope); } this.children = Context.getCurrentContext().newArray(this.scope, children); } return this.children; } /** * @return Returns the Node at the specified 'cm:name' based Path walking the children of this Node. * So a valid call might be: * <code>mynode.childByNamePath("/QA/Testing/Docs");</code> */ public ScriptNode childByNamePath(String path) { // convert the name based path to a valid XPath query StringBuilder xpath = new StringBuilder(path.length() << 1); StringTokenizer t = new StringTokenizer(path, "/"); int count = 0; QueryParameterDefinition[] params = new QueryParameterDefinition[t.countTokens()]; DataTypeDefinition ddText = this.services.getDictionaryService().getDataType(DataTypeDefinition.TEXT); NamespaceService ns = this.services.getNamespaceService(); while (t.hasMoreTokens()) { if (xpath.length() != 0) { xpath.append('/'); } String strCount = Integer.toString(count); xpath.append("*[@cm:name=$cm:name") .append(strCount) .append(']'); params[count++] = new QueryParameterDefImpl( QName.createQName(NamespaceService.CONTENT_MODEL_PREFIX, "name" + strCount, ns), ddText, true, t.nextToken()); } Object[] nodes = getChildrenByXPath(xpath.toString(), params, true); return (nodes.length != 0) ? (ScriptNode)nodes[0] : null; } /** * @return Returns a JavaScript array of Nodes at the specified XPath starting at this Node. * So a valid call might be <code>mynode.childrenByXPath("*[@cm:name='Testing']/*");</code> */ public Scriptable childrenByXPath(String xpath) { return Context.getCurrentContext().newArray(this.scope, getChildrenByXPath(xpath, null, false)); } /** * Return the target associations from this Node. As a Map of assoc name to a JavaScript array of Nodes. * The Map returned implements the Scriptable interface to allow access to the assoc arrays via JavaScript * associative array access. This means associations of this node can be access thus: * <code>node.assocs["translations"][0]</code> * * @return target associations as a Map of assoc name to a JavaScript array of Nodes. */ @SuppressWarnings("unchecked") public Map<String, Object> getAssocs() { if (this.targetAssocs == null) { // this Map implements the Scriptable interface for native JS syntax property access this.targetAssocs = new ScriptableQNameMap<String, Object>(this.services.getNamespaceService()); // get the list of target nodes for each association type List<AssociationRef> refs = this.nodeService.getTargetAssocs(this.nodeRef, RegexQNamePattern.MATCH_ALL); for (AssociationRef ref : refs) { String qname = ref.getTypeQName().toString(); List<ScriptNode> nodes = (List<ScriptNode>)this.targetAssocs.get(qname); if (nodes == null) { // first access of the list for this qname nodes = new ArrayList<ScriptNode>(4); this.targetAssocs.put(ref.getTypeQName().toString(), nodes); } nodes.add(newInstance(ref.getTargetRef(), this.services, this.scope)); } // convert each Node list into a JavaScript array object for (String qname : this.targetAssocs.keySet()) { List<ScriptNode> nodes = (List<ScriptNode>)this.targetAssocs.get(qname); Object[] objs = nodes.toArray(new Object[nodes.size()]); this.targetAssocs.put(qname, Context.getCurrentContext().newArray(this.scope, objs)); } } return this.targetAssocs; } public Map<String, Object> getAssociations() { return getAssocs(); } /** * Return the source associations to this Node. As a Map of assoc name to a JavaScript array of Nodes. * The Map returned implements the Scriptable interface to allow access to the assoc arrays via JavaScript * associative array access. This means source associations to this node can be access thus: * <code>node.sourceAssocs["translations"][0]</code> * * @return source associations as a Map of assoc name to a JavaScript array of Nodes. */ @SuppressWarnings("unchecked") public Map<String, Object> getSourceAssocs() { if (this.sourceAssocs == null) { // this Map implements the Scriptable interface for native JS syntax property access this.sourceAssocs = new ScriptableQNameMap<String, Object>(this.services.getNamespaceService()); // get the list of source nodes for each association type List<AssociationRef> refs = this.nodeService.getSourceAssocs(this.nodeRef, RegexQNamePattern.MATCH_ALL); for (AssociationRef ref : refs) { String qname = ref.getTypeQName().toString(); List<ScriptNode> nodes = (List<ScriptNode>)this.sourceAssocs.get(qname); if (nodes == null) { // first access of the list for this qname nodes = new ArrayList<ScriptNode>(4); this.sourceAssocs.put(ref.getTypeQName().toString(), nodes); } nodes.add(newInstance(ref.getSourceRef(), this.services, this.scope)); } // convert each Node list into a JavaScript array object for (String qname : this.sourceAssocs.keySet()) { List<ScriptNode> nodes = (List<ScriptNode>)this.sourceAssocs.get(qname); Object[] objs = nodes.toArray(new Object[nodes.size()]); this.sourceAssocs.put(qname, Context.getCurrentContext().newArray(this.scope, objs)); } } return this.sourceAssocs; } public Map<String, Object> getSourceAssociations() { return getSourceAssocs(); } /** * Return the child associations from this Node. As a Map of assoc name to a JavaScript array of Nodes. * The Map returned implements the Scriptable interface to allow access to the assoc arrays via JavaScript * associative array access. This means associations of this node can be access thus: * <code>node.childAssocs["contains"][0]</code> * * @return child associations as a Map of assoc name to a JavaScript array of Nodes. */ @SuppressWarnings("unchecked") public Map<String, Object> getChildAssocs() { if (this.childAssocs == null) { // this Map implements the Scriptable interface for native JS syntax property access this.childAssocs = new ScriptableQNameMap<String, Object>(this.services.getNamespaceService()); // get the list of child assoc nodes for each association type List<ChildAssociationRef> refs = this.nodeService.getChildAssocs(nodeRef); for (ChildAssociationRef ref : refs) { String qname = ref.getTypeQName().toString(); List<ScriptNode> nodes = (List<ScriptNode>)this.childAssocs.get(qname); if (nodes == null) { // first access of the list for this qname nodes = new ArrayList<ScriptNode>(4); this.childAssocs.put(ref.getTypeQName().toString(), nodes); } nodes.add(newInstance(ref.getChildRef(), this.services, this.scope)); } // convert each Node list into a JavaScript array object for (String qname : this.childAssocs.keySet()) { List<ScriptNode> nodes = (List<ScriptNode>)this.childAssocs.get(qname); Object[] objs = nodes.toArray(new Object[nodes.size()]); this.childAssocs.put(qname, Context.getCurrentContext().newArray(this.scope, objs)); } } return this.childAssocs; } public Map<String, Object> getChildAssociations() { return getChildAssocs(); } /** * Return all the properties known about this node. The Map returned implements the Scriptable interface to * allow access to the properties via JavaScript associative array access. This means properties of a node can * be access thus: <code>node.properties["name"]</code> * * @return Map of properties for this Node. */ @SuppressWarnings("unchecked") public Map<String, Object> getProperties() { if (this.properties == null) { // this Map implements the Scriptable interface for native JS syntax property access // this impl of the QNameMap is capable of creating ScriptContentData on demand for 'cm:content' // properties that have not been initialised - see AR-1673. this.properties = new ContentAwareScriptableQNameMap<String, Serializable>(this, this.services); Map<QName, Serializable> props = this.nodeService.getProperties(this.nodeRef); for (QName qname : props.keySet()) { Serializable propValue = props.get(qname); // perform the conversion to a script safe value and store this.properties.put(qname.toString(), getValueConverter().convertValueForScript(qname, propValue)); } } return this.properties; } /** * @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(getQNameType(), ContentModel.TYPE_FOLDER) == true && dd.isSubClass(getQNameType(), 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(getQNameType(), ContentModel.TYPE_CONTENT)); } return isDocument.booleanValue(); } /** * @return true if this Node is a Link to a Container (i.e. a folderlink) */ public boolean getIsLinkToContainer() { if (isLinkToContainer == null) { DictionaryService dd = this.services.getDictionaryService(); isLinkToContainer = Boolean.valueOf(dd.isSubClass(getQNameType(), ApplicationModel.TYPE_FOLDERLINK)); } return isLinkToContainer.booleanValue(); } /** * @return true if this Node is a Link to a Document (i.e. a filelink) */ public boolean getIsLinkToDocument() { if (isLinkToDocument == null) { DictionaryService dd = this.services.getDictionaryService(); isLinkToDocument = Boolean.valueOf(dd.isSubClass(getQNameType(), ApplicationModel.TYPE_FILELINK)); } return isLinkToDocument.booleanValue(); } /** * @return true if the Node is a Category */ public boolean getIsCategory() { // this valid is overriden by the CategoryNode sub-class return false; } /** * @return The list of aspects applied to this node */ public Set<QName> getAspectsSet() { if (this.aspects == null) { this.aspects = this.nodeService.getAspects(this.nodeRef); } return this.aspects; } /** * @return The array of aspects applied to this node */ public Scriptable getAspects() { Set<QName> aspects = getAspectsSet(); String[] result = new String[aspects.size()]; int count = 0; for (QName qname : aspects) { result[count++] = qname.toString(); } return Context.getCurrentContext().newArray(this.scope, result); } /** * @param aspect The aspect name to test for (full qualified or short-name form) * @return true if the node has the aspect false otherwise */ public boolean hasAspect(String aspect) { return getAspectsSet().contains(createQName(aspect)); } /** * @return QName path to this node. This can be used for Lucene PATH: style queries */ public String getQnamePath() { return this.services.getNodeService().getPath(getNodeRef()).toPrefixString(this.services.getNamespaceService()); } /** * @return Display path to this node */ public String getDisplayPath() { if (displayPath == null) { displayPath = this.nodeService.getPath(this.nodeRef).toDisplayPath( this.nodeService, this.services.getPermissionService()); } return displayPath; } /** * @return the small icon image for this node */ public String getIcon16() { return "/images/filetypes/_default.gif"; } /** * @return the large icon image for this node */ public String getIcon32() { return "/images/filetypes32/_default.gif"; } /** * @return true if the node is currently locked */ public boolean getIsLocked() { boolean locked = false; if (getAspectsSet().contains(ContentModel.ASPECT_LOCKABLE)) { LockStatus lockStatus = this.services.getLockService().getLockStatus(this.nodeRef); if (lockStatus == LockStatus.LOCKED || lockStatus == LockStatus.LOCK_OWNER) { locked = true; } } return locked; } /** * @return the parent node */ public ScriptNode getParent() { if (parent == null) { NodeRef parentRef = getPrimaryParentAssoc().getParentRef(); // handle root node (no parent!) if (parentRef != null) { parent = newInstance(parentRef, this.services, this.scope); } } return parent; } /** * @return the primary parent association so we can get at the association QName and the association type QName. */ public ChildAssociationRef getPrimaryParentAssoc() { if (primaryParentAssoc == null) { primaryParentAssoc = this.nodeService.getPrimaryParent(nodeRef); } return primaryParentAssoc; } // ------------------------------------------------------------------------------ // Content API /** * @return the content String for this node from the default content property (@see ContentModel.PROP_CONTENT) */ public String getContent() { String content = ""; ScriptContentData contentData = (ScriptContentData)getProperties().get(ContentModel.PROP_CONTENT); if (contentData != null) { content = contentData.getContent(); } return content; } /** * Set the content for this node * * @param content Content string to set */ public void setContent(String content) { ScriptContentData contentData = (ScriptContentData)getProperties().get(ContentModel.PROP_CONTENT); if (contentData != null) { contentData.setContent(content); } } /** * @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) { return MessageFormat.format(CONTENT_DEFAULT_URL, new Object[] { nodeRef.getStoreRef().getProtocol(), nodeRef.getStoreRef().getIdentifier(), nodeRef.getId(), URLEncoder.encode(getName())}); } else { return MessageFormat.format(FOLDER_BROWSE_URL, new Object[] { nodeRef.getStoreRef().getProtocol(), nodeRef.getStoreRef().getIdentifier(), nodeRef.getId() }); } } /** * @return For a content document, this method returns the download URL to the content for * the default content property (@see ContentModel.PROP_CONTENT) * <p> * For a container node, this method returns an empty string */ public String getDownloadUrl() { if (getIsDocument() == true) { return MessageFormat.format(CONTENT_DOWNLOAD_URL, new Object[] { nodeRef.getStoreRef().getProtocol(), nodeRef.getStoreRef().getIdentifier(), nodeRef.getId(), URLEncoder.encode(getName()) }); } else { return ""; } } public String jsGet_downloadUrl() { return getDownloadUrl(); } /** * @return The WebDav cm:name based path to the content for the default content property * (@see ContentModel.PROP_CONTENT) */ public String getWebdavUrl() { try { List<FileInfo> paths = this.services.getFileFolderService().getNamePath(null, getNodeRef()); // build up the webdav url StringBuilder path = new StringBuilder(128); path.append("/webdav"); // build up the path skipping the first path as it is the root folder for (int i=1; i<paths.size(); i++) { path.append("/") .append(URLEncoder.encode(paths.get(i).getName())); } return path.toString(); } catch (FileNotFoundException nodeErr) { // cannot build path if file no longer exists return ""; } } /** * @return The mimetype encoding for content attached to the node from the default content property * (@see ContentModel.PROP_CONTENT) */ public String getMimetype() { String mimetype = null; ScriptContentData content = (ScriptContentData) this.getProperties().get(ContentModel.PROP_CONTENT); if (content != null) { mimetype = content.getMimetype(); } return mimetype; } /** * Set the mimetype encoding for the content attached to the node from the default content property * (@see ContentModel.PROP_CONTENT) * * @param mimetype Mimetype to set */ public void setMimetype(String mimetype) { ScriptContentData content = (ScriptContentData) this.getProperties().get(ContentModel.PROP_CONTENT); if (content != null) { content.setMimetype(mimetype); } } /** * @return The size in bytes of the content attached to the node from the default content property * (@see ContentModel.PROP_CONTENT) */ public long getSize() { long size = 0; ScriptContentData content = (ScriptContentData) this.getProperties().get(ContentModel.PROP_CONTENT); if (content != null) { size = content.getSize(); } return size; } // ------------------------------------------------------------------------------ // Security API /** * Return true if the user has the specified permission on the node. * <p> * The default permissions are found in <code>org.alfresco.service.cmr.security.PermissionService</code>. * Most commonly used are "Write", "Delete" and "AddChildren". * * @param permission as found in <code>org.alfresco.service.cmr.security.PermissionService</code> * @return true if the user has the specified permission on the node. */ public boolean hasPermission(String permission) { ParameterCheck.mandatory("Permission Name", permission); boolean allowed = false; if (permission != null && permission.length() != 0) { AccessStatus status = this.services.getPermissionService().hasPermission(this.nodeRef, permission); allowed = (AccessStatus.ALLOWED == status); } return allowed; } /** * @return Array 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 Scriptable getPermissions() { String userName = this.services.getAuthenticationService().getCurrentUserName(); Set<AccessPermission> acls = this.services.getPermissionService().getAllSetPermissions(getNodeRef()); Object[] permissions = new Object[acls.size()]; int count = 0; for (AccessPermission permission : acls) { StringBuilder buf = new StringBuilder(64); buf.append(permission.getAccessStatus()) .append(';') .append(permission.getAuthority()) .append(';') .append(permission.getPermission()); permissions[count++] = buf.toString(); } return Context.getCurrentContext().newArray(this.scope, permissions); } /** * @return true if the node inherits permissions from the parent node, false otherwise */ public boolean inheritsPermissions() { return this.services.getPermissionService().getInheritParentPermissions(this.nodeRef); } /** * Set whether this node should inherit permissions from the parent node. * * @param inherit True to inherit parent permissions, false otherwise. */ public void setInheritsPermissions(boolean inherit) { this.services.getPermissionService().setInheritParentPermissions(this.nodeRef, inherit); } /** * Apply a permission for ALL users to the node. * * @param permission Permission to apply * @see org.alfresco.service.cmr.security.PermissionService */ public void setPermission(String permission) { ParameterCheck.mandatoryString("Permission Name", permission); this.services.getPermissionService().setPermission( this.nodeRef, PermissionService.ALL_AUTHORITIES, permission, true); } /** * Apply a permission for the specified authority (e.g. username or group) to the node. * * @param permission Permission to apply @see org.alfresco.service.cmr.security.PermissionService * @param authority Authority (generally a username or group name) to apply the permission for */ public void setPermission(String permission, String authority) { ParameterCheck.mandatoryString("Permission Name", permission); ParameterCheck.mandatoryString("Authority", authority); this.services.getPermissionService().setPermission( this.nodeRef, authority, permission, true); } /** * Remove a permission for ALL user from the node. * * @param permission Permission to remove @see org.alfresco.service.cmr.security.PermissionService */ public void removePermission(String permission) { ParameterCheck.mandatoryString("Permission Name", permission); this.services.getPermissionService().deletePermission( this.nodeRef, PermissionService.ALL_AUTHORITIES, permission); } /** * Remove a permission for the specified authority (e.g. username or group) from the node. * * @param permission Permission to remove @see org.alfresco.service.cmr.security.PermissionService * @param authority Authority (generally a username or group name) to apply the permission for */ public void removePermission(String permission, String authority) { ParameterCheck.mandatoryString("Permission Name", permission); ParameterCheck.mandatoryString("Authority", authority); this.services.getPermissionService().deletePermission( this.nodeRef, authority, permission); } // ------------------------------------------------------------------------------ // Ownership API /** * Set the owner of the node */ public void setOwner(String userId) { this.services.getOwnableService().setOwner(this.nodeRef, userId); } /** * Take ownership of the node. */ public void takeOwnership() { this.services.getOwnableService().takeOwnership(this.nodeRef); } /** * Get the owner of the node. * * @return */ public String getOwner() { return this.services.getOwnableService().getOwner(this.nodeRef); } // ------------------------------------------------------------------------------ // Create and Modify API /** * Persist the modified properties of this Node. */ public void save() { // persist properties back to the node in the DB Map<QName, Serializable> props = new HashMap<QName, Serializable>(getProperties().size()); for (String key : this.properties.keySet()) { Serializable value = (Serializable) this.properties.get(key); // perform the conversion from script wrapper object to repo serializable values value = getValueConverter().convertValueForRepo(value); props.put(createQName(key), value); } this.nodeService.setProperties(this.nodeRef, props); } /** * Re-sets the type of the node. Can be called in order specialise a node to a sub-type. This should be used * with caution since calling it changes the type of the node and thus* implies a different set of aspects, * properties and associations. It is the responsibility of the caller to ensure that the node is in a * approriate state after changing the type. * * @param type Type to specialize the node * * @return true if successful, false otherwise */ public boolean specializeType(String type) { ParameterCheck.mandatoryString("Type", type); QName qnameType = createQName(type); // Ensure that we are performing a specialise if (getQNameType().equals(qnameType) == false && this.services.getDictionaryService().isSubClass(qnameType, getQNameType()) == true) { // Specialise the type of the node this.nodeService.setType(this.nodeRef, qnameType); this.type = qnameType; return true; } return false; } /** * Create a new File (cm:content) node as a child of this node. * <p> * Once created the file should have content set using the <code>content</code> property. * * @param name Name of the file to create * * @return Newly created Node or null if failed to create. */ public ScriptNode createFile(String name) { ParameterCheck.mandatoryString("Node Name", name); FileInfo fileInfo = this.services.getFileFolderService().create( this.nodeRef, name, ContentModel.TYPE_CONTENT); reset(); ScriptNode file = newInstance(fileInfo.getNodeRef(), this.services, this.scope); file.setMimetype(this.services.getMimetypeService().guessMimetype(name)); return file; } /** * Create a new folder (cm:folder) node as a child of this node. * * @param name Name of the folder to create * * @return Newly created Node or null if failed to create. */ public ScriptNode createFolder(String name) { ParameterCheck.mandatoryString("Node Name", name); FileInfo fileInfo = this.services.getFileFolderService().create( this.nodeRef, name, ContentModel.TYPE_FOLDER); reset(); return newInstance(fileInfo.getNodeRef(), this.services, this.scope); } /** * Create a new Node of the specified type as a child of this node. * * @param name Name of the node to create (can be null for a node without a 'cm:name' property) * @param type QName type (fully qualified or short form such as 'cm:content') * * @return Newly created Node or null if failed to create. */ public ScriptNode createNode(String name, String type) { return createNode(name, type, null, ContentModel.ASSOC_CONTAINS.toString()); } /** * Create a new Node of the specified type as a child of this node. * * @param name Name of the node to create (can be null for a node without a 'cm:name' property) * @param type QName type (fully qualified or short form such as 'cm:content') * @param assocType QName of the child association type (fully qualified or short form e.g. 'cm:contains') * * @return Newly created Node or null if failed to create. */ public ScriptNode createNode(String name, String type, String assocType) { return createNode(name, type, null, assocType); } /** * Create a new Node of the specified type as a child of this node. * * @param name Name of the node to create (can be null for a node without a 'cm:name' property) * @param type QName type (fully qualified or short form such as 'cm:content') * @param properties Associative array of the default properties for the node. * * @return Newly created Node or null if failed to create. */ public ScriptNode createNode(String name, String type, Object properties) { return createNode(name, type, properties, ContentModel.ASSOC_CONTAINS.toString()); } /** * Create a new Node of the specified type as a child of this node. * * @param name Name of the node to create (can be null for a node without a 'cm:name' property) * @param type QName type (fully qualified or short form such as 'cm:content') * @param properties Associative array of the default properties for the node. * @param assocType QName of the child association type (fully qualified or short form e.g. 'cm:contains') * * @return Newly created Node or null if failed to create. */ public ScriptNode createNode(String name, String type, Object properties, String assocType) { return createNode(name, type, properties, assocType, null); } /** * Create a new Node of the specified type as a child of this node. * * @param name Name of the node to create (can be null for a node without a 'cm:name' property) * @param type QName type (fully qualified or short form such as 'cm:content') * @param properties Associative array of the default properties for the node. * @param assocType QName of the child association type (fully qualified or short form e.g. 'cm:contains') * @param assocName QName of the child association name (fully qualified or short form e.g. 'fm:discussion') * * @return Newly created Node or null if failed to create. */ public ScriptNode createNode(String name, String type, Object properties, String assocType, String assocName) { ParameterCheck.mandatoryString("Node Type", type); ParameterCheck.mandatoryString("Association Type", assocType); Map<QName, Serializable> props = null; if (properties instanceof ScriptableObject) { props = new HashMap<QName, Serializable>(4, 1.0f); extractScriptableProperties((ScriptableObject)properties, props); } if (name != null) { if (props == null) props = new HashMap<QName, Serializable>(1, 1.0f); props.put(ContentModel.PROP_NAME, name); } else { // set name for the assoc local name name = GUID.generate(); } ChildAssociationRef childAssocRef = this.nodeService.createNode( this.nodeRef, createQName(assocType), assocName == null ? QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, QName.createValidLocalName(name)) : createQName(assocName), createQName(type), props); reset(); return newInstance(childAssocRef.getChildRef(), this.services, this.scope); } /** * Add an existing node as a child of this node. * * @param node node to add as a child of this node */ public void addNode(ScriptNode node) { ParameterCheck.mandatory("node", node); ChildAssociationRef childAssocRef = this.nodeService.getPrimaryParent(node.nodeRef); nodeService.addChild(this.nodeRef, node.nodeRef, ContentModel.ASSOC_CONTAINS, childAssocRef.getQName()); reset(); } /** * Remove an existing child node of this node. * * Severs all parent-child relationships between two nodes. * <p> * The child node will be cascade deleted if one of the associations was the * primary association, i.e. the one with which the child node was created. * * @param node child node to remove */ public void removeNode(ScriptNode node) { ParameterCheck.mandatory("node", node); nodeService.removeChild(this.nodeRef, node.nodeRef); reset(); } /** * Create an association between this node and the specified target node. * * @param target Destination node for the association * @param assocType Association type qname (short form or fully qualified) */ public void createAssociation(ScriptNode target, String assocType) { ParameterCheck.mandatory("Target", target); ParameterCheck.mandatoryString("Association Type Name", assocType); this.nodeService.createAssociation(this.nodeRef, target.nodeRef, createQName(assocType)); reset(); } /** * Remove an association between this node and the specified target node. * * @param target Destination node on the end of the association * @param assocType Association type qname (short form or fully qualified) */ public void removeAssociation(ScriptNode target, String assocType) { ParameterCheck.mandatory("Target", target); ParameterCheck.mandatoryString("Association Type Name", assocType); this.nodeService.removeAssociation(this.nodeRef, target.nodeRef, createQName(assocType)); reset(); } /** * Remove this node. Any references to this Node or its NodeRef should be discarded! */ public boolean remove() { boolean success = false; if (nodeService.exists(this.nodeRef)) { this.nodeService.deleteNode(this.nodeRef); success = true; } reset(); return success; } /** * Copy this Node to a new parent destination. Note that children of the source Node are not copied. * * @param destination Node * * @return The newly copied Node instance or null if failed to copy. */ public ScriptNode copy(ScriptNode destination) { return copy(destination, false); } /** * Copy this Node and potentially all child nodes to a new parent destination. * * @param destination Node * @param deepCopy True for a deep copy, false otherwise. * * @return The newly copied Node instance or null if failed to copy. */ public ScriptNode copy(ScriptNode destination, boolean deepCopy) { ParameterCheck.mandatory("Destination Node", destination); ScriptNode copy = null; if (destination.getNodeRef().getStoreRef().getProtocol().equals(StoreRef.PROTOCOL_WORKSPACE)) { NodeRef copyRef = this.services.getCopyService().copyAndRename(this.nodeRef, destination.getNodeRef(), ContentModel.ASSOC_CONTAINS, getPrimaryParentAssoc().getQName(), deepCopy); copy = newInstance(copyRef, this.services, this.scope); } else { // NOTE: the deepCopy flag is not respected for this copy mechanism copy = getCrossRepositoryCopyHelper().copy(this, destination, getName()); } return copy; } /** * Move this Node to a new parent destination. * * @param destination Node * * @return true on successful move, false on failure to move. */ public boolean move(ScriptNode destination) { ParameterCheck.mandatory("Destination Node", destination); this.primaryParentAssoc = this.nodeService.moveNode(this.nodeRef, destination.getNodeRef(), ContentModel.ASSOC_CONTAINS, getPrimaryParentAssoc().getQName()); // reset cached values reset(); return true; } /** * Add an aspect to the Node. As no properties are provided in this call, it can only be used to add aspects that do not require any mandatory properties. * * @param type Type name of the aspect to add * * @return true if the aspect was added successfully, false if an error occured. */ public boolean addAspect(String type) { return addAspect(type, null); } /** * Add an aspect to the Node. * * @param type Type name of the aspect to add * @param props ScriptableObject (generally an assocative array) providing the named properties for the aspect * - any mandatory properties for the aspect must be provided! * * @return true if the aspect was added successfully, false if an error occured. */ public boolean addAspect(String type, Object props) { ParameterCheck.mandatoryString("Aspect Type", type); Map<QName, Serializable> aspectProps = null; if (props instanceof ScriptableObject) { aspectProps = new HashMap<QName, Serializable>(4, 1.0f); extractScriptableProperties((ScriptableObject)props, aspectProps); } QName aspectQName = createQName(type); this.nodeService.addAspect(this.nodeRef, aspectQName, aspectProps); // reset the relevant cached node members reset(); return true; } /** * Extract a map of properties from a scriptable object (generally an associative array) * * @param scriptable The scriptable object to extract name/value pairs from. * @param map The map to add the converted name/value pairs to. */ private void extractScriptableProperties(ScriptableObject scriptable, Map<QName, Serializable> map) { // we need to get all the keys to the properties provided // and convert them to a Map of QName to Serializable objects Object[] propIds = scriptable.getIds(); for (int i = 0; i < propIds.length; i++) { // work on each key in turn Object propId = propIds[i]; // we are only interested in keys that are formed of Strings i.e. QName.toString() if (propId instanceof String) { // get the value out for the specified key - it must be Serializable String key = (String)propId; Object value = scriptable.get(key, scriptable); if (value instanceof Serializable) { value = getValueConverter().convertValueForRepo((Serializable)value); map.put(createQName(key), (Serializable)value); } } } } /** * Remove aspect from the node. * * @param type the aspect type * * @return true if successful, false otherwise */ public boolean removeAspect(String type) { ParameterCheck.mandatoryString("Aspect Type", type); QName aspectQName = createQName(type); this.nodeService.removeAspect(this.nodeRef, aspectQName); // reset the relevant cached node members reset(); return true; } // ------------------------------------------------------------------------------ // Checkout/Checkin Services /** * Create a version of this document. Note: this will add the cm:versionable aspect. * * @param history Version history note * @param majorVersion True to save as a major version increment, false for minor version. */ public ScriptVersion createVersion(String history, boolean majorVersion) { Map<String, Serializable> props = new HashMap<String, Serializable>(2, 1.0f); props.put(Version.PROP_DESCRIPTION, history); props.put(VersionModel.PROP_VERSION_TYPE, majorVersion ? VersionType.MAJOR : VersionType.MINOR); ScriptVersion version = new ScriptVersion(this.services.getVersionService().createVersion(this.nodeRef, props), this.services, this.scope); this.versions = null; return version; } /** * Determines if this node is versioned * * @return true => is versioned */ public boolean getIsVersioned() { return this.nodeService.hasAspect(this.nodeRef, ContentModel.ASPECT_VERSIONABLE); } /** * Gets the version history * * @return version history */ public Scriptable getVersionHistory() { if (this.versions == null && getIsVersioned()) { VersionHistory history = this.services.getVersionService().getVersionHistory(this.nodeRef); if (history != null) { Collection<Version> allVersions = history.getAllVersions(); Object[] versions = new Object[allVersions.size()]; int i = 0; for (Version version : allVersions) { versions[i++] = new ScriptVersion(version, this.services, this.scope); } this.versions = Context.getCurrentContext().newArray(this.scope, versions); } } return this.versions; } /** * Gets the version of this node specified by version label * * @param versionLabel version label * @return version of node, or null if node is not versioned, or label does not exist */ public ScriptVersion getVersion(String versionLabel) { if (!getIsVersioned()) { return null; } VersionHistory history = this.services.getVersionService().getVersionHistory(this.nodeRef); Version version = history.getVersion(versionLabel); if (version == null) { return null; } return new ScriptVersion(version, this.services, this.scope); } /** * Perform a check-out of this document into the current parent space. * * @return the working copy Node for the checked out document */ public ScriptNode checkout() { NodeRef workingCopyRef = this.services.getCheckOutCheckInService().checkout(this.nodeRef); ScriptNode workingCopy = newInstance(workingCopyRef, this.services, this.scope); // reset the aspect and properties as checking out a document causes changes this.properties = null; this.aspects = null; return workingCopy; } /** * Perform a check-out of this document into the specified destination space. * * @param destination * Destination for the checked out document working copy Node. * @return the working copy Node for the checked out document */ public ScriptNode checkout(ScriptNode destination) { ParameterCheck.mandatory("Destination Node", destination); ChildAssociationRef childAssocRef = this.nodeService.getPrimaryParent(destination.getNodeRef()); NodeRef workingCopyRef = this.services.getCheckOutCheckInService().checkout(this.nodeRef, destination.getNodeRef(), ContentModel.ASSOC_CONTAINS, childAssocRef.getQName()); ScriptNode workingCopy = newInstance(workingCopyRef, this.services, this.scope); // reset the aspect and properties as checking out a document causes changes this.properties = null; this.aspects = null; return workingCopy; } /** * Check-in a working copy document. The current state of the working copy is copied to the original node, * this will include any content updated in the working node. Note that this method can only be called on a * working copy Node. * * @return the original Node that was checked out. */ public ScriptNode checkin() { return checkin("", false); } /** * Check-in a working copy document. The current state of the working copy is copied to the original node, * this will include any content updated in the working node. Note that this method can only be called on a * working copy Node. * * @param history Version history note * * @return the original Node that was checked out. */ public ScriptNode checkin(String history) { return checkin(history, false); } /** * Check-in a working copy document. The current state of the working copy is copied to the original node, * this will include any content updated in the working node. Note that this method can only be called on a * working copy Node. * * @param history Version history note * @param majorVersion True to save as a major version increment, false for minor version. * * @return the original Node that was checked out. */ public ScriptNode checkin(String history, boolean majorVersion) { Map<String, Serializable> props = new HashMap<String, Serializable>(2, 1.0f); props.put(Version.PROP_DESCRIPTION, history); props.put(VersionModel.PROP_VERSION_TYPE, majorVersion ? VersionType.MAJOR : VersionType.MINOR); NodeRef original = this.services.getCheckOutCheckInService().checkin(this.nodeRef, props); this.versions = null; return newInstance(original, this.services, this.scope); } /** * Cancel the check-out of a working copy document. The working copy will be deleted and any changes made to it * are lost. Note that this method can only be called on a working copy Node. The reference to this working copy * Node should be discarded. * * @return the original Node that was checked out. */ public ScriptNode cancelCheckout() { NodeRef original = this.services.getCheckOutCheckInService().cancelCheckout(this.nodeRef); return newInstance(original, this.services, this.scope); } // ------------------------------------------------------------------------------ // Transformation and Rendering API /** * Transform a document to a new document mimetype format. A copy of the document is made and the extension * changed to match the new mimetype, then the transformation isapplied. * * @param mimetype Mimetype destination for the transformation * * @return Node representing the newly transformed document. */ public ScriptNode transformDocument(String mimetype) { return transformDocument(mimetype, getPrimaryParentAssoc().getParentRef()); } /** * Transform a document to a new document mimetype format. A copy of the document is made in the specified * destination folder and the extension changed to match the new mimetype, then then transformation is applied. * * @param mimetype Mimetype destination for the transformation * @param destination Destination folder location * * @return Node representing the newly transformed document. */ public ScriptNode transformDocument(String mimetype, ScriptNode destination) { return transformDocument(mimetype, destination.getNodeRef()); } private ScriptNode transformDocument(String mimetype, NodeRef destination) { ParameterCheck.mandatoryString("Mimetype", mimetype); ParameterCheck.mandatory("Destination Node", destination); // the delegate definition for transforming a document Transformer transformer = new Transformer() { public ScriptNode transform(ContentService contentService, NodeRef nodeRef, ContentReader reader, ContentWriter writer) { ScriptNode transformedNode = null; if (contentService.isTransformable(reader, writer)) { contentService.transform(reader, writer); transformedNode = newInstance(nodeRef, services, scope); } return transformedNode; } }; return transformNode(transformer, mimetype, destination); } /** * Generic method to transform Node content from one mimetype to another. * * @param transformer The Transformer delegate supplying the transformation logic * @param mimetype Mimetype of the destination content * @param destination Destination folder location for the resulting document * * @return Node representing the transformed content - or null if the transform failed */ private ScriptNode transformNode(Transformer transformer, String mimetype, NodeRef destination) { ScriptNode transformedNode = null; // get the content reader ContentService contentService = this.services.getContentService(); ContentReader reader = contentService.getReader(this.nodeRef, ContentModel.PROP_CONTENT); // only perform the transformation if some content is available if (reader != null) { // Copy the content node to a new node String copyName = TransformActionExecuter.transformName(this.services.getMimetypeService(), getName(), mimetype, true); NodeRef copyNodeRef = this.services.getCopyService().copy(this.nodeRef, destination, ContentModel.ASSOC_CONTAINS, QName.createQName(ContentModel.PROP_CONTENT.getNamespaceURI(), QName.createValidLocalName(copyName)), false); // modify the name of the copy to reflect the new mimetype this.nodeService.setProperty(copyNodeRef, ContentModel.PROP_NAME, copyName); // get the writer and set it up ContentWriter writer = contentService.getWriter(copyNodeRef, ContentModel.PROP_CONTENT, true); writer.setMimetype(mimetype); // new mimetype writer.setEncoding(reader.getEncoding()); // original encoding // Try and transform the content using the supplied delegate transformedNode = transformer.transform(contentService, copyNodeRef, reader, writer); } return transformedNode; } /** * Transform an image to a new image format. A copy of the image document is made and the extension changed to * match the new mimetype, then the transformation is applied. * * @param mimetype Mimetype destination for the transformation * * @return Node representing the newly transformed image. */ public ScriptNode transformImage(String mimetype) { return transformImage(mimetype, null, getPrimaryParentAssoc().getParentRef()); } /** * Transform an image to a new image format. A copy of the image document is made and the extension changed to * match the new mimetype, then the transformation is applied. * * @param mimetype Mimetype destination for the transformation * @param options Image convert command options * * @return Node representing the newly transformed image. */ public ScriptNode transformImage(String mimetype, String options) { return transformImage(mimetype, options, getPrimaryParentAssoc().getParentRef()); } /** * Transform an image to a new image mimetype format. A copy of the image document is made in the specified * destination folder and the extension changed to match the newmimetype, then then transformation is applied. * * @param mimetype Mimetype destination for the transformation * @param destination Destination folder location * * @return Node representing the newly transformed image. */ public ScriptNode transformImage(String mimetype, ScriptNode destination) { ParameterCheck.mandatory("Destination Node", destination); return transformImage(mimetype, null, destination.getNodeRef()); } /** * Transform an image to a new image mimetype format. A copy of the image document is made in the specified * destination folder and the extension changed to match the new * mimetype, then then transformation is applied. * * @param mimetype Mimetype destination for the transformation * @param options Image convert command options * @param destination Destination folder location * * @return Node representing the newly transformed image. */ public ScriptNode transformImage(String mimetype, String options, ScriptNode destination) { ParameterCheck.mandatory("Destination Node", destination); return transformImage(mimetype, options, destination.getNodeRef()); } private ScriptNode transformImage(String mimetype, final String options, NodeRef destination) { ParameterCheck.mandatoryString("Mimetype", mimetype); // the delegate definition for transforming an image Transformer transformer = new Transformer() { public ScriptNode transform(ContentService contentService, NodeRef nodeRef, ContentReader reader, ContentWriter writer) { ImageTransformationOptions imageOptions = new ImageTransformationOptions(); if (options != null) { imageOptions.setCommandOptions(options); } contentService.getImageTransformer().transform(reader, writer, imageOptions); return newInstance(nodeRef, services, scope); } }; return transformNode(transformer, mimetype, destination); } /** * Process a FreeMarker Template against the current node. * * @param template Node of the template to execute * * @return output of the template execution */ public String processTemplate(ScriptNode template) { ParameterCheck.mandatory("Template Node", template); return processTemplate(template.getContent(), null, null); } /** * Process a FreeMarker Template against the current node. * * @param template Node of the template to execute * @param args Scriptable object (generally an associative array) containing the name/value pairs of * arguments to be passed to the template * * @return output of the template execution */ public String processTemplate(ScriptNode template, Object args) { ParameterCheck.mandatory("Template Node", template); return processTemplate(template.getContent(), null, (ScriptableObject)args); } /** * Process a FreeMarker Template against the current node. * * @param template The template to execute * * @return output of the template execution */ public String processTemplate(String template) { ParameterCheck.mandatoryString("Template", template); return processTemplate(template, null, null); } /** * Process a FreeMarker Template against the current node. * * @param template The template to execute * @param args Scriptable object (generally an associative array) containing the name/value pairs of * arguments to be passed to the template * * @return output of the template execution */ public String processTemplate(String template, Object args) { ParameterCheck.mandatoryString("Template", template); return processTemplate(template, null, (ScriptableObject)args); } private String processTemplate(String template, NodeRef templateRef, ScriptableObject args) { Object person = (Object)scope.get("person", scope); Object companyhome = (Object)scope.get("companyhome", scope); Object userhome = (Object)scope.get("userhome", scope); // build default model for the template processing Map<String, Object> model = this.services.getTemplateService().buildDefaultModel( (person.equals(UniqueTag.NOT_FOUND)) ? null : ((ScriptNode)((Wrapper)person).unwrap()).getNodeRef(), (companyhome.equals(UniqueTag.NOT_FOUND)) ? null : ((ScriptNode)((Wrapper)companyhome).unwrap()).getNodeRef(), (userhome.equals(UniqueTag.NOT_FOUND)) ? null : ((ScriptNode)((Wrapper)userhome).unwrap()).getNodeRef(), templateRef, null); // add the current node as either the document/space as appropriate if (this.getIsDocument()) { model.put("document", this.nodeRef); model.put("space", getPrimaryParentAssoc().getParentRef()); } else { model.put("space", this.nodeRef); } // add the supplied args to the 'args' root object if (args != null) { // we need to get all the keys to the properties provided // and convert them to a Map of QName to Serializable objects Object[] propIds = args.getIds(); Map<String, String> templateArgs = new HashMap<String, String>(propIds.length); for (int i = 0; i < propIds.length; i++) { // work on each key in turn Object propId = propIds[i]; // we are only interested in keys that are formed of Strings i.e. QName.toString() if (propId instanceof String) { // get the value out for the specified key - make sure it is Serializable Object value = args.get((String) propId, args); value = getValueConverter().convertValueForRepo((Serializable)value); if (value != null) { templateArgs.put((String) propId, value.toString()); } } } // add the args to the model as the 'args' root object model.put("args", templateArgs); } // execute template! // TODO: check that script modified nodes are reflected... return this.services.getTemplateService().processTemplateString(null, template, model); } // ------------------------------------------------------------------------------ // Thumbnail Methods /** * Creates a thumbnail for the content property of the node. * * The thumbnail name correspionds to pre-set thumbnail details stored in the * repository. * * @param thumbnailName the name of the thumbnail * @return ScriptThumbnail the newly create thumbnail node */ public ScriptThumbnail createThumbnail(String thumbnailName) { return createThumbnail(thumbnailName, false); } /** * Creates a thumbnail for the content property of the node. * * The thumbnail name correspionds to pre-set thumbnail details stored in the * repository. * * If the thumbnail is created asynchronously then the result will be null and creation * of the thumbnail will occure at some point in the background. * * @param thumbnailName the name of the thumbnail * @param async indicates whether the thumbnail is create asynchronously or not * @return ScriptThumbnail the newly create thumbnail node or null if async creation occures */ public ScriptThumbnail createThumbnail(String thumbnailName, boolean async) { ScriptThumbnail result = null; // Use the thumbnail registy to get the details of the thumbail ThumbnailRegistry registry = this.services.getThumbnailService().getThumbnailRegistry(); ThumbnailDetails details = registry.getThumbnailDetails(thumbnailName); if (details == null) { // Throw exception throw new ScriptException("The thumbnail name '" + thumbnailName + "' is not registered"); } if (async == false) { // Create the thumbnail NodeRef thumbnailNodeRef = this.services.getThumbnailService().createThumbnail( this.nodeRef, ContentModel.PROP_CONTENT, details.getMimetype(), details.getTransformationOptions(), details.getName()); // Create the thumbnail script object result = new ScriptThumbnail(thumbnailNodeRef, this.services, this.scope); } else { // Queue async creation of thumbnail Action action = this.services.getActionService().createAction(CreateThumbnailActionExecuter.NAME); action.setParameterValue(CreateThumbnailActionExecuter.PARAM_THUMBANIL_NAME, thumbnailName); this.services.getActionService().executeAction(action, this.nodeRef, false, true); } return result; } /** * Get the given thumbnail for the content property * * @param thumbnailName the thumbnail name * @return ScriptThumbnail the thumbnail */ public ScriptThumbnail getThumbnail(String thumbnailName) { ScriptThumbnail result = null; NodeRef thumbnailNodeRef = this.services.getThumbnailService().getThumbnailByName( this.nodeRef, ContentModel.PROP_CONTENT, thumbnailName); if (thumbnailNodeRef != null) { result = new ScriptThumbnail(thumbnailNodeRef, this.services, this.scope); } return result; } /** * Get the all the thumbnails for a given node's content property. * * @return Scriptable list of thumbnails, empty if none available */ public ScriptThumbnail[] getThumbnails() { List<NodeRef> thumbnails = this.services.getThumbnailService().getThumbnails( this.nodeRef, ContentModel.PROP_CONTENT, null, null); List<ScriptThumbnail> result = new ArrayList<ScriptThumbnail>(thumbnails.size()); for (NodeRef thumbnail : thumbnails) { ScriptThumbnail scriptThumbnail = new ScriptThumbnail(thumbnail, this.services, this.scope); result.add(scriptThumbnail); } return (ScriptThumbnail[])result.toArray(new ScriptThumbnail[result.size()]); } // ------------------------------------------------------------------------------ // Tag methods /** * Clear the node's tags */ public void clearTags() { this.services.getTaggingService().clearTags(this.nodeRef); updateTagProperty(); } /** * Adds a tag to the node * * @param tag tag name */ public void addTag(String tag) { this.services.getTaggingService().addTag(this.nodeRef, tag); updateTagProperty(); } /** * Adds all the tags to the node * * @param tags array of tag names */ public void addTags(String[] tags) { this.services.getTaggingService().addTags(this.nodeRef, Arrays.asList(tags)); updateTagProperty(); } /** * Removes a tag from the node * * @param tag tag name */ public void removeTag(String tag) { this.services.getTaggingService().removeTag(this.nodeRef, tag); updateTagProperty(); } /** * Removes all the tags from the node * * @param tags array of tag names */ public void removeTags(String[] tags) { this.services.getTaggingService().removeTags(this.nodeRef, Arrays.asList(tags)); updateTagProperty(); } /** * Get all the tags applied to this node * * @return String[] array containing all the tag applied to this node */ public String[] getTags() { String[] result = null; List<String> tags = this.services.getTaggingService().getTags(this.nodeRef); if (tags.isEmpty() == true) { result = new String[0]; } else { result = (String[])tags.toArray(new String[tags.size()]); } return result; } /** * Set the tags applied to this node. This overwirtes the list of tags currently applied to the * node. * * @param tags array of tags */ public void setTags(String[] tags) { this.services.getTaggingService().setTags(this.nodeRef, Arrays.asList(tags)); updateTagProperty(); } private void updateTagProperty() { Serializable tags = this.services.getNodeService().getProperty(this.nodeRef, ContentModel.PROP_TAGS); if (this.properties != null) { this.properties.put(ContentModel.PROP_TAGS.toString(), getValueConverter().convertValueForScript(ContentModel.PROP_TAGS, tags)); } } /** * Sets whether this node is a tag scope or not * * @param value true if this node is a tag scope, false otherwise */ public void setIsTagScope(boolean value) { boolean currentValue = this.services.getTaggingService().isTagScope(this.nodeRef); if (currentValue != value) { if (value == true) { // Add the tag scope this.services.getTaggingService().addTagScope(this.nodeRef); } else { // Remove the tag scope this.services.getTaggingService().removeTagScope(this.nodeRef); } } } /** * Gets whether this node is a tag scope * * @return boolean true if this node is a tag scope, false otherwise */ public boolean getIsTagScope() { return this.services.getTaggingService().isTagScope(this.nodeRef); } /** * Gets the 'nearest' tag scope to this node by travesing up the parent hierarchy untill one is found. * <p> * If none is found, null is returned. * * @return TagScope the 'nearest' tag scope */ public TagScope getTagScope() { TagScope tagScope = null; org.alfresco.service.cmr.tagging.TagScope tagScopeImpl = this.services.getTaggingService().findTagScope(this.nodeRef); if (tagScopeImpl != null) { tagScope = new TagScope(this.services.getTaggingService(), tagScopeImpl); } return tagScope; } /** * Gets all (deep) children of this node that have the tag specified. * * @param tag tag name * @return ScriptNode[] nodes that are deep children of the node with the tag */ public ScriptNode[] childrenByTags(String tag) { List<NodeRef> nodeRefs = this.services.getTaggingService().findTaggedNodes(this.nodeRef.getStoreRef(), tag, this.nodeRef); ScriptNode[] nodes = new ScriptNode[nodeRefs.size()]; int index = 0; for (NodeRef node : nodeRefs) { nodes[index] = new ScriptNode(node, this.services, this.scope); index ++; } return nodes; } // ------------------------------------------------------------------------------ // Workflow methods /** * Get active workflow instances this node belongs to * * @return the active workflow instances this node belongs to */ public Scriptable getActiveWorkflows() { if (this.activeWorkflows == null) { WorkflowService workflowService = this.services.getWorkflowService(); List<WorkflowInstance> workflowInstances = workflowService.getWorkflowsForContent(this.nodeRef, true); Object[] jsWorkflowInstances = new Object[workflowInstances.size()]; int index = 0; for (WorkflowInstance workflowInstance : workflowInstances) { jsWorkflowInstances[index++] = new JscriptWorkflowInstance(workflowInstance, this.services, this.scope); } this.activeWorkflows = Context.getCurrentContext().newArray(this.scope, jsWorkflowInstances); } return this.activeWorkflows; } // ------------------------------------------------------------------------------ // Helper methods /** * Override Object.toString() to provide useful debug output */ public String toString() { if (this.nodeService.exists(nodeRef)) { if (this.services.getPermissionService().hasPermission(nodeRef, PermissionService.READ_PROPERTIES) == AccessStatus.ALLOWED) { // TODO: DC: Allow debug output of property values - for now it's disabled as this could potentially // follow a large network of nodes. Unfortunately, JBPM issues unprotected debug statements // where node.toString is used - will request this is fixed in next release of JBPM. return "Node Type: " + getType() + ", Node Aspects: " + getAspectsSet().toString(); } else { return "Access denied to node " + nodeRef; } } else { return "Node no longer exists: " + nodeRef; } } /** * Returns the JSON representation of this node. * * NOTE: This is a temporary method to support the /api/metadata web script * * @return The JSON representation of this node */ public String toJSON() { String jsonStr = "{}"; if (this.nodeService.exists(nodeRef)) { if (this.services.getPermissionService().hasPermission(nodeRef, PermissionService.READ_PROPERTIES) == AccessStatus.ALLOWED) { JSONObject json = new JSONObject(); try { // add type info json.put("nodeRef", this.getNodeRef().toString()); json.put("type", this.getType()); json.put("mimetype", this.getMimetype()); // add properties json.put("properties", this.nodeService.getProperties(this.nodeRef)); // add aspects as an array json.put("aspects", this.nodeService.getAspects(this.nodeRef)); } catch (JSONException error) { error.printStackTrace(); } jsonStr = json.toString(); } } return jsonStr; } /** * Helper to create a QName from either a fully qualified or short-name QName string * * @param s Fully qualified or short-name QName string * * @return QName */ private QName createQName(String s) { QName qname; if (s.indexOf(NAMESPACE_BEGIN) != -1) { qname = QName.createQName(s); } else { qname = QName.createQName(s, this.services.getNamespaceService()); } return qname; } /** * Reset the Node cached state */ public void reset() { this.name = null; this.type = null; this.properties = null; this.aspects = null; this.targetAssocs = null; this.sourceAssocs = null; this.childAssocs = null; this.children = null; this.displayPath = null; this.isDocument = null; this.isContainer = null; this.parent = null; this.primaryParentAssoc = null; this.activeWorkflows = null; } /** * @return helper object to perform cross repository copy of JavaScript Node objects */ protected CrossRepositoryCopy getCrossRepositoryCopyHelper() { return (CrossRepositoryCopy)this.services.getService( QName.createQName("", CrossRepositoryCopy.BEAN_NAME)); } /** * Return a list or a single Node from executing an xpath against the parent Node. * * @param xpath XPath to execute * @param firstOnly True to return the first result only * * @return Object[] can be empty but never null */ private Object[] getChildrenByXPath(String xpath, QueryParameterDefinition[] params, boolean firstOnly) { Object[] result = null; if (xpath.length() != 0) { if (logger.isDebugEnabled()) { logger.debug("Executing xpath: " + xpath); if (params != null) { for (int i=0; i<params.length; i++) { logger.debug(" [" + params[i].getQName() + "]=" + params[i].getDefault()); } } } List<NodeRef> nodes = this.services.getSearchService().selectNodes(this.nodeRef, xpath, params, this.services.getNamespaceService(), false); // see if we only want the first result if (firstOnly == true) { if (nodes.size() != 0) { result = new Object[1]; result[0] = newInstance(nodes.get(0), this.services, this.scope); } } // or all the results else { result = new Object[nodes.size()]; for (int i = 0; i < nodes.size(); i++) { NodeRef ref = nodes.get(i); result[i] = newInstance(ref, this.services, this.scope); } } } return result != null ? result : new Object[0]; } /** * Helper to return true if the supplied property value is a ScriptContentData object * * @param o Object to test * * @return true if instanceof ScriptContentData, false otherwise */ public boolean isScriptContent(Object o) { return (o instanceof ScriptContentData); } // ------------------------------------------------------------------------------ // Value Conversion /** * Gets the node value converter * * @return the node value converter */ protected NodeValueConverter getValueConverter() { if (converter == null) { converter = createValueConverter(); } return converter; } /** * Constructs the node value converter * * @return the node value converter */ protected NodeValueConverter createValueConverter() { return new NodeValueConverter(); } // Set support /** * Value converter with knowledge of Node specific value types */ public class NodeValueConverter extends ValueConverter { /** * Convert an object from any repository serialized value to a valid script object. This includes converting * Collection multi-value properties into JavaScript Array objects. * * @param qname QName of the property value for conversion * @param value Property value * * @return Value safe for scripting usage */ public Serializable convertValueForScript(QName qname, Serializable value) { return convertValueForScript(services, scope, qname, value); } /* * (non-Javadoc) * * @see org.alfresco.repo.jscript.ValueConverter#convertValueForScript(org.alfresco.service.ServiceRegistry, * org.mozilla.javascript.Scriptable, org.alfresco.service.namespace.QName, java.io.Serializable) */ @Override public Serializable convertValueForScript(ServiceRegistry services, Scriptable scope, QName qname, Serializable value) { if (value instanceof ContentData) { // ContentData object properties are converted to ScriptContentData objects // so the content and other properties of those objects can be accessed value = new ScriptContentData((ContentData) value, qname); } else { value = super.convertValueForScript(services, scope, qname, value); } return value; } /* * (non-Javadoc) * * @see org.alfresco.repo.jscript.ValueConverter#convertValueForRepo(java.io.Serializable) */ @Override public Serializable convertValueForRepo(Serializable value) { if (value instanceof ScriptContentData) { // convert back to ContentData value = ((ScriptContentData) value).contentData; } else { value = super.convertValueForRepo(value); } return value; } } // ------------------------------------------------------------------------------ // Inner Classes /** * Inner class wrapping and providing access to a ContentData property */ public class ScriptContentData implements Content, Serializable { private static final long serialVersionUID = -7819328543933312278L; /** * Constructor * * @param contentData The ContentData object this object wraps * @param property The property the ContentData is attached too */ public ScriptContentData(ContentData contentData, QName property) { this.contentData = contentData; this.property = property; } /* (non-Javadoc) * @see org.alfresco.repo.jscript.ScriptNode.ScriptContent#getContent() */ public String getContent() { ContentService contentService = services.getContentService(); ContentReader reader = contentService.getReader(nodeRef, property); return (reader != null && reader.exists()) ? reader.getContentString() : ""; } public InputStream getInputStream() { ContentService contentService = services.getContentService(); ContentReader reader = contentService.getReader(nodeRef, property); return (reader != null && reader.exists()) ? reader.getContentInputStream() : null; } /** * Set the content stream * * @param content Content string to set */ public void setContent(String content) { ContentService contentService = services.getContentService(); ContentWriter writer = contentService.getWriter(nodeRef, this.property, true); writer.setMimetype(getMimetype()); // use existing mimetype value writer.putContent(content); // update cached variables after putContent() this.contentData = (ContentData) services.getNodeService().getProperty(nodeRef, this.property); } /** * Set the content stream from another content object * * @param content ScriptContent to set */ public void write(Content content) { ContentService contentService = services.getContentService(); ContentWriter writer = contentService.getWriter(nodeRef, this.property, true); writer.setMimetype(content.getMimetype()); writer.setEncoding(content.getEncoding()); writer.putContent(content.getInputStream()); // update cached variables after putContent() this.contentData = (ContentData) services.getNodeService().getProperty(nodeRef, this.property); } /** * @return download URL to the content */ public String getUrl() { return MessageFormat.format(CONTENT_PROP_URL, new Object[] { nodeRef.getStoreRef().getProtocol(), nodeRef.getStoreRef().getIdentifier(), nodeRef.getId(), URLEncoder.encode(getName()), URLEncoder.encode(property.toString()) }); } /** * @return download URL to the content for a document item only */ public String getDownloadUrl() { if (getIsDocument() == true) { return MessageFormat.format(CONTENT_DOWNLOAD_PROP_URL, new Object[] { nodeRef.getStoreRef().getProtocol(), nodeRef.getStoreRef().getIdentifier(), nodeRef.getId(), URLEncoder.encode(getName()), URLEncoder.encode(property.toString()) }); } else { return ""; } } public long getSize() { return contentData.getSize(); } public String getMimetype() { return contentData.getMimetype(); } public String getEncoding() { return contentData.getEncoding(); } public void setEncoding(String encoding) { this.contentData = ContentData.setEncoding(this.contentData, encoding); services.getNodeService().setProperty(nodeRef, this.property, this.contentData); // update cached variables after putContent() this.contentData = (ContentData) services.getNodeService().getProperty(nodeRef, this.property); } public void setMimetype(String mimetype) { this.contentData = ContentData.setMimetype(this.contentData, mimetype); services.getNodeService().setProperty(nodeRef, this.property, this.contentData); // update cached variables after putContent() this.contentData = (ContentData) services.getNodeService().getProperty(nodeRef, this.property); } public void guessMimetype(String filename) { setMimetype(services.getMimetypeService().guessMimetype(filename)); } private ContentData contentData; private QName property; } /** * Interface contract for simple anonymous classes that implement document transformations */ private interface Transformer { /** * Transform the reader to the specified writer * * @param contentService ContentService * @param noderef NodeRef of the destination for the transform * @param reader Source reader * @param writer Destination writer * * @return Node representing the transformed entity */ ScriptNode transform(ContentService contentService, NodeRef noderef, ContentReader reader, ContentWriter writer); } }

The table below shows all metrics for ScriptNode.java.

Metric	Value	Description
BLOCKS	270.00	Number of blocks
BLOCK_COMMENT	38.00	Number of block comment lines
COMMENTS	913.00	Comment lines
COMMENT_DENSITY	0.93	Comment density
COMPARISONS	117.00	Number of comparison operators
CYCLOMATIC	264.00	Cyclomatic complexity
DECL_COMMENTS	162.00	Comments in declarations
DOC_COMMENT	763.00	Number of javadoc comment lines
ELOC	979.00	Effective lines of code
EXEC_COMMENTS	74.00	Comments in executable code
EXITS	271.00	Procedure exits
FUNCTIONS	149.00	Number of function declarations
HALSTEAD_DIFFICULTY	99.98	Halstead difficulty
HALSTEAD_EFFORT	0.00	Halstead effort
INTERFACE_COMPLEXITY	382.00	Interface complexity
JAVA0001	0.00	JAVA0001 Package name does not contain only lower case letters
JAVA0002	0.00	JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003	0.00	JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004	0.00	JAVA0004 Unnecessary import from java.lang
JAVA0005	0.00	JAVA0005 Imports not in specified order
JAVA0006	0.00	JAVA0006 Empty finally block
JAVA0007	0.00	JAVA0007 Should not declare public field
JAVA0008	0.00	JAVA0008 Empty catch block
JAVA0009	0.00	JAVA0009 Protected member in final class
JAVA0010	0.00	JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011	0.00	JAVA0011 Abstract class does not contain an abstract method
JAVA0012	0.00	JAVA0012 Non-constructor method with same name as declaring class
JAVA0013	0.00	JAVA0013 Non-blank final field is not static
JAVA0014	0.00	JAVA0014 Class with only static members has non-private constructor
JAVA0015	0.00	JAVA0015 Package class contains public nested type
JAVA0016	0.00	JAVA0016 Abstract class contains public constructor
JAVA0017	0.00	JAVA0017 Class name does not have required form
JAVA0018	0.00	JAVA0018 Method name does not have required form
JAVA0019	0.00	JAVA0019 Interface name does not have required form
JAVA0020	0.00	JAVA0020 Field name does not have required form
JAVA0021	0.00	JAVA0021 Interface method name does not have required form
JAVA0022	0.00	JAVA0022 Static final field name does not have required form
JAVA0023	0.00	JAVA0023 Empty finalize method
JAVA0024	0.00	JAVA0024 Empty class
JAVA0025	0.00	JAVA0025 Method override is empty
JAVA0026	0.00	JAVA0026 Finalize method with parameters
JAVA0029	0.00	JAVA0029 Private method not used
JAVA0030	0.00	JAVA0030 Private field not used
JAVA0031	0.00	JAVA0031 Case statement not properly closed
JAVA0032	0.00	JAVA0032 Switch statement missing default
JAVA0033	0.00	JAVA0033 default: not last case in switch statement
JAVA0034	5.00	JAVA0034 Missing braces in if statement
JAVA0035	0.00	JAVA0035 Missing braces in for statement
JAVA0036	0.00	JAVA0036 Missing braces in while statement
JAVA0038	0.00	JAVA0038 Non-case label in switch statement
JAVA0039	0.00	JAVA0039 Break statement with label
JAVA0040	0.00	JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041	0.00	JAVA0041 Nested synchronized block
JAVA0042	0.00	JAVA0042 Empty synchronized statement
JAVA0043	0.00	JAVA0043 Inner class does not use outer class
JAVA0044	0.00	JAVA0044 Serializable class with no instance variables
JAVA0045	0.00	JAVA0045 Serializable class with only transient fields
JAVA0046	0.00	JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047	0.00	JAVA0047 Serializable class derives from invalid base class
JAVA0048	0.00	JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049	0.00	JAVA0049 Nested block at depth N (maximum: M)
JAVA0050	0.00	JAVA0050 Class derives from java.lang.Error
JAVA0051	0.00	JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052	0.00	JAVA0052 Class derives from java.lang.Throwable
JAVA0053	0.00	JAVA0053 Unused label
JAVA0054	0.00	JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055	0.00	JAVA0055 Class should be interface
JAVA0056	0.00	JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057	0.00	JAVA0057 Unnecessary default constructor
JAVA0058	0.00	JAVA0058 Constructor calls super()
JAVA0059	0.00	JAVA0059 Method override only calls super()
JAVA0061	0.00	JAVA0061 Inaccessible member in anonymous class
JAVA0062	0.00	JAVA0062 Public class missing public member or protected constructor
JAVA0063	0.00	JAVA0063 Identifier name should not contain '$'
JAVA0064	0.00	JAVA0064 N variations of identifier name (maximum: M)
JAVA0065	0.00	JAVA0065 Unnecessary final modifier for method in final class
JAVA0066	0.00	JAVA0066 Unnecessary modifier for interface nested type
JAVA0067	0.00	JAVA0067 Array descriptor on identifier name
JAVA0068	6.00	JAVA0068 Modifiers not declared in recommended order
JAVA0071	0.00	JAVA0071 Strings compared with ==
JAVA0073	0.00	JAVA0073 Integer division in floating-point context
JAVA0074	0.00	JAVA0074 Use of Object.notify()
JAVA0075	26.00	JAVA0075 Method parameter hides field
JAVA0076	0.00	JAVA0076 Use of magic number
JAVA0077	2.00	JAVA0077 Private field not used in declaring class
JAVA0078	0.00	JAVA0078 Floating point values compared with ==
JAVA0079	0.00	JAVA0079 Use of instance to reference static member
JAVA0080	0.00	JAVA0080 Import declaration not used
JAVA0081	11.00	JAVA0081 Boolean literal in comparison
JAVA0082	5.00	JAVA0082 Unnecessary widening cast
JAVA0083	0.00	JAVA0083 Unnecessary instanceof test
JAVA0084	0.00	JAVA0084 Should use compound assignment operator
JAVA0085	0.00	JAVA0085 Use of sun.* class
JAVA0087	0.00	JAVA0087 Use of Thread.sleep()
JAVA0089	0.00	JAVA0089 Use of restricted package
JAVA0092	0.00	JAVA0092 Use of restricted type
JAVA0093	0.00	JAVA0093 Redundant assignment
JAVA0094	0.00	JAVA0094 Field hides a superclass field
JAVA0095	0.00	JAVA0095 Uninitialized private field
JAVA0096	1.00	JAVA0096 Field in nested class hides outer field
JAVA0098	0.00	JAVA0098 Minimize use of implicit field initializers
JAVA0100	1.00	JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101	0.00	JAVA0101 Unnecessary modifier for field in interface
JAVA0102	0.00	JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103	0.00	JAVA0103 Explicit call to finalize()
JAVA0104	0.00	JAVA0104 finalize() only calls super.finalize()
JAVA0105	0.00	JAVA0105 Duplicate import declaration
JAVA0106	0.00	JAVA0106 Unnecessary import from current package
JAVA0108	7.00	JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109	2.00	JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110	4.00	JAVA0110 Incorrect javadoc: no @return tag
JAVA0111	0.00	JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112	0.00	JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113	0.00	JAVA0113 Incorrect javadoc: no @author tag
JAVA0114	1.00	JAVA0114 Incorrect javadoc: no @version tag
JAVA0115	0.00	JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116	0.00	JAVA0116 Missing javadoc: field 'field'
JAVA0117	7.00	JAVA0117 Missing javadoc: method 'method'
JAVA0118	0.00	JAVA0118 Missing javadoc: type 'type'
JAVA0119	0.00	JAVA0119 Control variable changed within body of for loop
JAVA0123	0.00	JAVA0123 Use all three components of for loop
JAVA0125	0.00	JAVA0125 Continue statement with label
JAVA0126	0.00	JAVA0126 Method declares unchecked exception in throws
JAVA0128	0.00	JAVA0128 Public constructor in non-public class
JAVA0130	0.00	JAVA0130 Non-static method does not use instance fields
JAVA0131	0.00	JAVA0131 Compatible method does not override base
JAVA0132	1.00	JAVA0132 Method overload with compatible signature
JAVA0133	0.00	JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135	0.00	JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136	1.00	JAVA0136 N methods defined in class (maximum: M)
JAVA0137	0.00	JAVA0137 Non-abstract class missing constructor
JAVA0138	0.00	JAVA0138 N parameters defined for method (maximum: M)
JAVA0139	0.00	JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141	0.00	JAVA0141 Unnecessary modifier for method in interface
JAVA0143	0.00	JAVA0143 Synchronized method
JAVA0144	6.00	JAVA0144 Line exceeds maximum M characters
JAVA0145	49.00	JAVA0145 Tab character used in source file
JAVA0150	0.00	JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153	0.00	JAVA0153 Inefficient conversion of integer to string
JAVA0159	0.00	JAVA0159 Inefficient conversion of string to integer
JAVA0160	0.00	JAVA0160 Method does not throw specified exception
JAVA0161	0.00	JAVA0161 Conditional wait() not in loop
JAVA0163	0.00	JAVA0163 Empty statement
JAVA0165	0.00	JAVA0165 Conflicting return statement in finally block
JAVA0166	0.00	JAVA0166 Generic exception caught
JAVA0167	0.00	JAVA0167 ThreadDeath not rethrown
JAVA0169	0.00	JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170	0.00	JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171	1.00	JAVA0171 Unused local variable
JAVA0173	0.00	JAVA0173 Unused method parameter
JAVA0174	0.00	JAVA0174 Assigned local variable never used
JAVA0175	0.00	JAVA0175 Successive assignment to variable
JAVA0176	0.00	JAVA0176 Local variable name does not have required form
JAVA0177	1.00	JAVA0177 Variable declaration missing initializer
JAVA0179	3.00	JAVA0179 Local variable hides visible field
JAVA0233	0.00	JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234	0.00	JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235	0.00	JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236	0.00	JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237	0.00	JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238	0.00	JAVA0238 Clone method does not call super.clone()
JAVA0239	0.00	JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240	0.00	JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241	0.00	JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242	0.00	JAVA0242 Transient field in non-Serializable class
JAVA0243	0.00	JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244	0.00	JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245	0.00	JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246	0.00	JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247	0.00	JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248	0.00	JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249	0.00	JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250	0.00	JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251	0.00	JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252	0.00	JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253	0.00	JAVA0253 Not all enum constants consumed in switch statement
JAVA0254	0.00	JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255	0.00	JAVA0255 Result of method invocation not used
JAVA0256	0.00	JAVA0256 Assignment of external collection/array to field
JAVA0257	0.00	JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258	0.00	JAVA0258 Implement Iterable for foreach compatibility
JAVA0259	1.00	JAVA0259 Return of collection/array field
JAVA0260	0.00	JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261	0.00	JAVA0261 Use specialized Enum collection types
JAVA0262	0.00	JAVA0262 Use of char in integer context
JAVA0263	0.00	JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264	0.00	JAVA0264 Integer math in long context - check for overflow
JAVA0265	1.00	JAVA0265 Use of Throwable.printStackTrace()
JAVA0266	0.00	JAVA0266 Use of System.out
JAVA0267	0.00	JAVA0267 Use of System.err
JAVA0269	0.00	JAVA0269 Contents of StringBuffer never used
JAVA0270	3.00	JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271	0.00	JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272	0.00	JAVA0272 Thread.run() called
JAVA0273	0.00	JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274	0.00	JAVA0274 Serializable class has a synchronized readObject()
JAVA0275	0.00	JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276	0.00	JAVA0276 Unnecessary use of String constructor
JAVA0277	0.00	JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278	0.00	JAVA0278 Unnecessary use of Boolean constructor
JAVA0279	0.00	JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280	0.00	JAVA0280 IllegalMonitorStateException caught
JAVA0281	0.00	JAVA0281 Iterator.next() not called in loop
JAVA0282	0.00	JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283	0.00	JAVA0283 Control variable not updated in loop body
JAVA0284	0.00	JAVA0284 Explicit garbage collection
JAVA0285	0.00	JAVA0285 Dereference of potentially null variable
JAVA0286	0.00	JAVA0286 Dereference of null variable
JAVA0287	0.00	JAVA0287 Unnecessary null check
JAVA0288	0.00	JAVA0288 Inconsistent null check
LINES	2754.00	Number of lines in the source file
LINE_COMMENT	112.00	Number of line comments
LOC	1528.00	Lines of code
LOGICAL_LINES	632.00	Number of statements
LOOPS	7.00	Number of loops
NEST_DEPTH	5.00	Maximum nesting depth
OPERANDS	3523.00	Number of operands
OPERATORS	6888.00	Number of operators
PARAMS	138.00	Number of formal parameter declarations
PROGRAM_LENGTH	10411.00	Halstead program length
PROGRAM_VOCAB	1024.00	Halstead program vocabulary
PROGRAM_VOLUME	0.00	Halstead program volume
RETURNS	244.00	Number of return points from functions
SIZE	99667.00	Size of the file in bytes
UNIQUE_OPERANDS	969.00	Number of unique operands
UNIQUE_OPERATORS	55.00	Number of unique operators
WHITESPACE	313.00	Number of whitespace lines