AVMServiceImpl.java
| Index Score | ||
|---|---|---|
 |
 |
org.alfresco.repo.avm |
 |
 |
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 | |
|---|---|---|
| PARAMS | Number of formal parameter declarations |  |
| INTERFACE_COMPLEXITY | Interface complexity | |
| DECL_COMMENTS | Comments in declarations | |
| RETURNS | Number of return points from functions | |
| DOC_COMMENT | Number of javadoc comment lines | |
| CYCLOMATIC | Cyclomatic complexity | |
| SIZE | Size of the file in bytes | |
| COMMENTS | Comment lines | |
| COMPARISONS | Number of comparison operators | |
| FUNCTIONS | Number of function declarations | |
| BLOCKS | Number of blocks | |
| LINES | Number of lines in the source file | |
| EXITS | Procedure exits | |
| LOC | Lines of code | |
| UNIQUE_OPERANDS | Number of unique operands | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| ELOC | Effective lines of code | |
| LOGICAL_LINES | Number of statements | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| PROGRAM_VOLUME | Halstead program volume | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| JAVA0030 | JAVA0030 Private field not used | |
| EXEC_COMMENTS | Comments in executable code | |
| LOOPS | Number of loops | |
| 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.avm;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import org.alfresco.repo.domain.DbAccessControlList;
import org.alfresco.repo.domain.PropertyValue;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
import org.alfresco.repo.security.permissions.ACLCopyMode;
import org.alfresco.service.cmr.avm.AVMBadArgumentException;
import org.alfresco.service.cmr.avm.AVMException;
import org.alfresco.service.cmr.avm.AVMExistsException;
import org.alfresco.service.cmr.avm.AVMNodeDescriptor;
import org.alfresco.service.cmr.avm.AVMNotFoundException;
import org.alfresco.service.cmr.avm.AVMService;
import org.alfresco.service.cmr.avm.AVMStoreDescriptor;
import org.alfresco.service.cmr.avm.AVMWrongTypeException;
import org.alfresco.service.cmr.avm.LayeringDescriptor;
import org.alfresco.service.cmr.avm.VersionDescriptor;
import org.alfresco.service.cmr.repository.ContentData;
import org.alfresco.service.cmr.repository.ContentReader;
import org.alfresco.service.cmr.repository.ContentWriter;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.Pair;
import org.alfresco.util.TempFileProvider;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Implements the AVMService.
* @author britt
*/
public class AVMServiceImpl implements AVMService
{
public static final String SYSTEM = "system";
@SuppressWarnings("unused")
private static Log fgLogger = LogFactory.getLog(AVMServiceImpl.class);
/**
* The AVMRepository for each service thread.
*/
private AVMRepository fAVMRepository;
/**
* Basic constructor for the service.
*/
public AVMServiceImpl()
{
}
/**
* Set the repository reference. For Spring.
* @param avmRepository The repository reference.
*/
public void setAvmRepository(AVMRepository avmRepository)
{
fAVMRepository = avmRepository;
}
/**
* Get an InputStream from a file.
* @param version The version to look under.
* @param path The absolute path.
* @return An InputStream
* @throws AVMNotFoundException When the path is invalid.
*/
public InputStream getFileInputStream(int version, String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path.");
}
return fAVMRepository.getInputStream(version, path);
}
/**
* Get an InputStream from a descriptor.
* @param desc The descriptor.
* @return An InputStream.
* @throws AVMNotFoundException
*/
public InputStream getFileInputStream(AVMNodeDescriptor desc)
{
if (desc == null)
{
throw new AVMBadArgumentException("Illegal Null Argument.");
}
return fAVMRepository.getInputStream(desc);
}
/**
* Get an output stream to a file. Triggers versioning.
*/
public OutputStream getFileOutputStream(String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path.");
}
return fAVMRepository.getOutputStream(path);
}
/**
* Get a content reader from a file node.
* @param version The version of the file.
* @param path The path to the file.
* @return A ContentReader.
*/
public ContentReader getContentReader(int version, String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path.");
}
return fAVMRepository.getContentReader(version, path);
}
/**
* Get a ContentWriter to a file node.
* @param path The path to the file.
* @return A ContentWriter.
*/
public ContentWriter getContentWriter(String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path.");
}
return fAVMRepository.createContentWriter(path);
}
/**
* Get a directory listing.
* @param version The version id to lookup.
* @param path The path to lookup.
*/
public SortedMap<String, AVMNodeDescriptor> getDirectoryListing(int version, String path)
{
return getDirectoryListing(version, path, false);
}
/**
* Get a listing of a Folder by name, with the option of seeing
* Deleted Nodes.
* @param version The version id to look in.
* @param path The simple absolute path to the file node.
* @param includeDeleted Whether to see Deleted Nodes.
* @return A Map of names to descriptors.
* @throws AVMNotFoundException If <code>path</code> is not found.
* @throws AVMWrongTypeException If <code>path</code> contains a non-terminal
* component that is not a directory, or if <code>path</code> is not pointing
* at a directory.
*/
public SortedMap<String, AVMNodeDescriptor> getDirectoryListing(int version, String path,
boolean includeDeleted)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path.");
}
return fAVMRepository.getListing(version, path, includeDeleted);
}
/**
* Get a directory listing as an Array of AVMNodeDescriptors.
* @param version The version to look under.
* @param path The path to the directory to be listed.
* @param includeDeleted Whether to include ghosts.
* @return An array of AVMNodeDescriptors.
*/
public AVMNodeDescriptor [] getDirectoryListingArray(int version, String path,
boolean includeDeleted)
{
Map<String, AVMNodeDescriptor> listing =
getDirectoryListing(version, path, includeDeleted);
AVMNodeDescriptor [] result = new AVMNodeDescriptor[listing.size()];
int off = 0;
for (AVMNodeDescriptor desc : listing.values())
{
result[off++] = desc;
}
return result;
}
/**
* Get a directory listing as an Array of node descriptors.
* @param dir The descriptor pointing at the directory to list.
* @param includeDeleted Whether to show ghosts.
* @return An array of AVMNodeDescriptors.
*/
public AVMNodeDescriptor [] getDirectoryListingArray(AVMNodeDescriptor dir,
boolean includeDeleted)
{
Map<String, AVMNodeDescriptor> listing =
getDirectoryListing(dir, includeDeleted);
AVMNodeDescriptor [] result = new AVMNodeDescriptor[listing.size()];
int off = 0;
for (AVMNodeDescriptor desc : listing.values())
{
result[off++] = desc;
}
return result;
}
/**
* Get a listing of all the directly contained children of a directory.
* @param dir The directory descriptor.
* @param includeDeleted Whether to include deleted children.
* @return A Map of Strings to descriptors.
*/
public SortedMap<String, AVMNodeDescriptor>
getDirectoryListingDirect(AVMNodeDescriptor dir, boolean includeDeleted)
{
if (dir == null)
{
throw new AVMBadArgumentException("Illegal null descriptor.");
}
return fAVMRepository.getListingDirect(dir, includeDeleted);
}
/**
* Get the listing of nodes contained directly in a directory. This is the
* same as getDirectoryListing for PlainDirectories, but returns only those that
* are directly contained in a layered directory.
* @param version The version to look up.
* @param path The full path to get listing for.
* @return A Map of names to descriptors.
* @throws AVMNotFoundException If <code>path</code> does not exist.
* @throws AVMWrongTypeException If <code>path</code> contains any non-directory
* elements.
*/
public SortedMap<String, AVMNodeDescriptor>
getDirectoryListingDirect(int version, String path)
{
return getDirectoryListingDirect(version, path, false);
}
/**
* Get the listing of nodes contained directly in a directory. This is the
* same as getDirectoryListing for PlainDirectories, but returns only those that
* are directly contained in a layered directory. This has the option of
* seeing Deleted Nodes.
* @param version The version to look up.
* @param path The full path to get listing for.
* @param includeDeleted Whether to see Deleted Nodes.
* @return A Map of names to descriptors.
* @throws AVMNotFoundException If <code>path</code> does not exist.
* @throws AVMWrongTypeException If <code>path</code> contains any non-directory
* elements.
*/
public SortedMap<String, AVMNodeDescriptor>
getDirectoryListingDirect(int version, String path, boolean includeDeleted)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path.");
}
return fAVMRepository.getListingDirect(version, path, includeDeleted);
}
/**
* Get a directory listing from a node descriptor.
* @param dir The directory node descriptor.
* @return A Map of names to node descriptors.
*/
public SortedMap<String, AVMNodeDescriptor> getDirectoryListing(AVMNodeDescriptor dir)
{
return getDirectoryListing(dir, false);
}
/**
* Get a directory listing from a node descriptor, with the option of
* seeing deleted nodes.
* @param dir The directory node descriptor.
* @param includeDeleted Whether to see Deleted Nodes.
* @return A Map of names to node descriptors.
* @throws AVMNotFoundException If the descriptor is stale.
* @throws AVMWrongTypeException If the descriptor does not point at a directory.
*/
public SortedMap<String, AVMNodeDescriptor> getDirectoryListing(AVMNodeDescriptor dir,
boolean includeDeleted)
{
if (dir == null)
{
throw new AVMBadArgumentException("Null descriptor.");
}
return fAVMRepository.getListing(dir, includeDeleted);
}
/**
* Get the names of nodes that have been deleted in a directory.
* @param version The version to look under.
* @param path The path of the directory.
* @return A List of names.
* @throws AVMNotFoundException If <code>path</code> does not exist.
* @throws AVMWrongTypeException If <code>path</code> contains any elements
* that are not directories.
*/
public List<String> getDeleted(int version, String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path.");
}
return fAVMRepository.getDeleted(version, path);
}
/**
* Create a new file. The file must not exist.
* @param path The path to the containing directory.
* @param name The name of the file.
* @return An output stream to the file.
*/
public OutputStream createFile(String path, String name)
{
if (path == null || name == null || !FileNameValidator.IsValid(name))
{
throw new AVMBadArgumentException("Illegal argument.");
}
return fAVMRepository.createFile(path, name);
}
/**
* Create a file with content specified by the InputStream.
* Guaranteed to be created atomically.
* @param path The path to the containing directory.
* @param name The name to give the file.
* @param in An InputStream containing data for file.
*/
public void createFile(String path, String name, InputStream in)
{
createFile(path, name, in, null, null);
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.avm.AVMService#createFile(java.lang.String, java.lang.String, java.io.InputStream, java.util.List, java.util.Map)
*/
public void createFile(String path, String name, InputStream in, List<QName> aspects, Map<QName, PropertyValue> properties)
{
if (path == null || name == null || in == null || !FileNameValidator.IsValid(name))
{
throw new AVMBadArgumentException("Illegal argument.");
}
// Save the contents to temp space.
File temp;
try
{
temp = TempFileProvider.createTempFile("alf", "tmp");
OutputStream out = new FileOutputStream(temp);
byte [] buff = new byte[8192];
int read;
while ((read = in.read(buff)) != -1)
{
out.write(buff, 0, read);
}
out.close();
in.close();
}
catch (IOException ie)
{
throw new AVMException("I/O Error.");
}
try
{
fAVMRepository.createFile(path, name, temp, aspects, properties);
}
finally
{
temp.delete();
}
}
/**
* Create a directory. The directory must not exist.
* @param path The path to the containing directory.
* @param name The name of the new directory.
*/
public void createDirectory(String path, String name)
{
createDirectory(path, name, null, null);
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.avm.AVMService#createDirectory(java.lang.String, java.lang.String, java.util.List, java.util.Map)
*/
public void createDirectory(String path, String name, List<QName> aspects, Map<QName, PropertyValue> properties)
{
if (path == null || name == null || !FileNameValidator.IsValid(name))
{
throw new AVMBadArgumentException("Illegal argument.");
}
fAVMRepository.createDirectory(path, name, aspects, properties);
}
/**
* Create a new layered file. It must not exist.
* @param srcPath The src path. Ie the target for the layering.
* @param parent The path to the parent directory.
* @param name The name to give the new file.
*/
public void createLayeredFile(String srcPath, String parent, String name)
{
if (srcPath == null || parent == null || name == null ||
!FileNameValidator.IsValid(name))
{
throw new AVMBadArgumentException("Illegal argument.");
}
fAVMRepository.createLayeredFile(srcPath, parent, name);
}
/**
* Create a new layered directory. It must not exist.
* @param srcPath The src path. Ie the target for layering.
* @param parent The path to the parent directory.
* @param name The name for the new directory.
*/
public void createLayeredDirectory(String srcPath, String parent, String name)
{
if (srcPath == null || parent == null || name == null ||
!FileNameValidator.IsValid(name))
{
throw new AVMBadArgumentException("Illegal argument.");
}
fAVMRepository.createLayeredDirectory(srcPath, parent, name);
}
/**
* Create an AVMStore with the given name. It must not exist.
* @param name The name to give the AVMStore.
*/
public void createStore(String name)
{
if (name == null || !FileNameValidator.IsValid(name))
{
throw new AVMBadArgumentException("Bad Name.");
}
fAVMRepository.createAVMStore(name);
}
/**
* Create a branch.
* @param version The version to branch from.
* @param srcPath The path to the thing to branch from.
* @param dstPath The path to the destination containing directory.
* @param name The name of the new branch.
*/
public void createBranch(int version, String srcPath, String dstPath,
String name)
{
if (srcPath == null || dstPath == null || name == null ||
!FileNameValidator.IsValid(name))
{
throw new AVMBadArgumentException("Illegal argument.");
}
fAVMRepository.createBranch(version, srcPath, dstPath, name);
}
/**
* Remove a node. Beware, the node can be a directory and
* this acts recursively.
* @param parent The path to the parent.
* @param name The name of the node to remove.
*/
public void removeNode(String parent, String name)
{
if (parent == null || name == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
fAVMRepository.remove(parent, name);
}
/**
* Remove a node by full path.
* @param path The full path to the node.
*/
public void removeNode(String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
String [] basePath = AVMNodeConverter.SplitBase(path);
if (basePath[0] == null)
{
throw new AVMBadArgumentException("Cannot remove root node: " + path);
}
fAVMRepository.remove(basePath[0], basePath[1]);
}
/**
* Rename a node.
* @param srcParent The path to the source parent.
* @param srcName The name of the source node.
* @param dstParent The path to the destination parent.
* @param dstName The name to give the renamed node.
*/
public void rename(String srcParent, String srcName, String dstParent,
String dstName)
{
if (srcParent == null || srcName == null || dstParent == null || dstName == null ||
!FileNameValidator.IsValid(dstName))
{
throw new AVMBadArgumentException("Illegal argument.");
}
fAVMRepository.rename(srcParent, srcName, dstParent, dstName);
}
/**
* Uncover a deleted name in a layered directory.
* @param dirPath The path to the layered directory.
* @param name The name to uncover.
*/
public void uncover(String dirPath, String name)
{
if (dirPath == null || name == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
fAVMRepository.uncover(dirPath, name);
}
/**
* Make name in dirPath transparent to what was underneath it. That is, this
* removes the offending node from its layered directory parent's direct ownership.
* @param dirPath The path to the layered directory.
* @param name The name of the item to flatten.
*/
public void makeTransparent(String dirPath, String name)
{
if (dirPath == null || name == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
fAVMRepository.flatten(dirPath, name);
}
/**
* Get the Latest Version ID for an AVMStore.
* @param repName The name of the AVMStore.
* @return The Latest Version ID.
*/
public int getNextVersionID(String repName)
{
if (repName == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
return fAVMRepository.getLatestVersionID(repName);
}
/**
* Get the latest snapshot id of a store.
* @param storeName The store name.
* @return The id of the latest extant version of the store.
* @throws AVMNotFoundException If <code>storeName</code> does not exist.
*/
public int getLatestSnapshotID(String storeName)
{
if (storeName == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
return fAVMRepository.getLatestSnapshotID(storeName);
}
/*
* Snapshot an AVMRepository.
* @param store The name of the AVMStore.
* @param tag The short description.
* @param description The thick description.
* @return Map of implicitly and explicitly snapshotted stores.
*/
public Map<String, Integer> createSnapshot(String store, String tag, String description)
{
if (store == null)
{
throw new AVMBadArgumentException("Store is null.");
}
return fAVMRepository.createSnapshot(store, tag, description);
}
/**
* Look up information about a node.
* @param version The version to look up.
* @param path The path to look up.
* @return A Descriptor.
*/
public AVMNodeDescriptor lookup(int version, String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Illegal null path.");
}
return lookup(version, path, false);
}
/**
* Lookup a node by version ids and path, with the option of
* seeing Deleted Nodes.
* @param version The version id to look under.
* @param path The simple absolute path to the parent directory.
* @param includeDeleted Whether to see Deleted Nodes.
* @return An AVMNodeDescriptor.
* @throws AVMNotFoundException If <code>path</code> does not exist or
* if <code>version</code> does not exist.
* @throws AVMWrongTypeException If <code>path</code> contains a non-terminal
* element that is not a directory.
*/
public AVMNodeDescriptor lookup(int version, String path, boolean includeDeleted)
{
if (path == null)
{
throw new AVMBadArgumentException("Path is null.");
}
try
{
Lookup lookup = fAVMRepository.lookup(version, path, includeDeleted);
if (lookup == null)
{
return null;
}
return lookup.getCurrentNode().getDescriptor(lookup);
}
catch (AVMNotFoundException e)
{
return null;
}
}
/**
* Lookup a node descriptor from a directory node descriptor.
* @param dir The node descriptor of the directory.
* @param name The name to lookup.
* @return The node descriptor of the child.
*/
public AVMNodeDescriptor lookup(AVMNodeDescriptor dir, String name)
{
if (dir == null || name == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
return lookup(dir, name, false);
}
/**
* Lookup a node from a directory node, with the option of seeing
* Deleted Nodes.
* @param dir The descriptor for the directory node.
* @param name The name to lookup.
* @param includeDeleted Whether to see Deleted Nodes.
* @return The descriptor for the child.
* @throws AVMNotFoundException If <code>name</code> does not exist or
* if <code>dir</code> is dangling.
* @throws AVMWrongTypeException If <code>dir</code> does not refer to a directory.
*/
public AVMNodeDescriptor lookup(AVMNodeDescriptor dir, String name, boolean includeDeleted)
{
if (dir == null || name == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
try
{
return fAVMRepository.lookup(dir, name, includeDeleted);
}
catch (AVMNotFoundException e)
{
return null;
}
}
/**
* Get a list of all paths that a given node has.
* @param desc The node descriptor to get paths for.
* @return A List of version, path Pairs.
*/
public List<Pair<Integer, String>> getPaths(AVMNodeDescriptor desc)
{
if (desc == null)
{
throw new AVMBadArgumentException("Descriptor is null.");
}
return fAVMRepository.getPaths(desc);
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.avm.AVMService#getAPath(org.alfresco.service.cmr.avm.AVMNodeDescriptor)
*/
public Pair<Integer, String> getAPath(AVMNodeDescriptor desc)
{
if (desc == null)
{
throw new AVMBadArgumentException("Descriptor is null.");
}
return fAVMRepository.getAPath(desc);
}
/**
* Get all paths that a given node has that are in the head version.
* @param desc The node descriptor to get paths for.
* @return A List of version, path Pairs.
*/
public List<Pair<Integer, String>> getHeadPaths(AVMNodeDescriptor desc)
{
if (desc == null)
{
throw new AVMBadArgumentException("Descriptor is null.");
}
return fAVMRepository.getHeadPaths(desc);
}
/**
* Get all paths to a node starting at the HEAD version of a store.
* @param desc The node descriptor.
* @param store The store.
* @return A List of all paths meeting the criteria.
*/
public List<Pair<Integer, String>> getPathsInStoreHead(AVMNodeDescriptor desc, String store)
{
if (desc == null || store == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
return fAVMRepository.getPathsInStoreHead(desc, store);
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.avm.AVMService#getPathsInStoreVersion(org.alfresco.service.cmr.avm.AVMNodeDescriptor, java.lang.String, int)
*/
public List<String> getPathsInStoreVersion(AVMNodeDescriptor desc, String store, int version)
{
if (desc == null || store == null || version < 1)
{
throw new AVMBadArgumentException("Illegal null argument or invalid version.");
}
return fAVMRepository.getPathsInStoreVersion(desc, store, version);
}
/**
* Purge an AVMStore. Permanently delete everything that
* is only referenced in that AVMStore.
* @param name The name of the AVMStore to purge.
*/
public void purgeStore(String name)
{
if (name == null)
{
throw new AVMBadArgumentException("Name is null.");
}
fAVMRepository.purgeAVMStore(name);
}
/**
* Purge a particular version from a repository.
* @param version The id of the version to purge.
* @param name The name of the repository.
*/
public void purgeVersion(int version, String name)
{
if (name == null)
{
throw new AVMBadArgumentException("Name is null.");
}
fAVMRepository.purgeVersion(name, version);
}
/**
* Get the indirection path of a layered node.
* @param version The version to lookup.
* @param path The path to lookup.
* @return The indirection path (target) of the layered node.
*/
public String getIndirectionPath(int version, String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Path is null.");
}
return fAVMRepository.getIndirectionPath(version, path);
}
/**
* Get the extant version ids for an AVMStore.
* @param name The name of the AVMStore.
* @return A List of VersionDescriptors.
*/
public List<VersionDescriptor> getStoreVersions(String name)
{
if (name == null)
{
throw new AVMBadArgumentException("Name is null.");
}
return fAVMRepository.getAVMStoreVersions(name);
}
/**
* Get version IDs by creation date. From or to may be null but not
* both.
* @param name The name of the AVMStore to search.
* @param from The earliest versions to return.
* @param to The latest versions to return.
* @return The Set of matching version IDs.
*/
public List<VersionDescriptor> getStoreVersions(String name, Date from, Date to)
{
if (name == null || (from == null && to == null))
{
throw new AVMBadArgumentException("Illegal null argument.");
}
return fAVMRepository.getAVMStoreVersions(name, from, to);
}
/**
* Change what a layered directory points to.
* @param path The path to the layered directory.
*/
public void retargetLayeredDirectory(String path, String target)
{
if (path == null || target == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
fAVMRepository.retargetLayeredDirectory(path, target);
}
/**
* Make the indicated directory a primary indirection.
* @param path The absolute path.
*/
public void makePrimary(String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Path is null.");
}
fAVMRepository.makePrimary(path);
}
/**
* Get a list of all AVMStores.
* @return The AVMStores.
*/
public List<AVMStoreDescriptor> getStores()
{
return fAVMRepository.getAVMStores();
}
/**
* Get a reposotory.
* @param name The name of the AVMStore to get.
* @return The AVMStore.
*/
public AVMStoreDescriptor getStore(String name)
{
if (name == null)
{
throw new AVMBadArgumentException("Null Store Name.");
}
try
{
return fAVMRepository.getAVMStore(name);
}
catch (AVMNotFoundException e)
{
return null;
}
}
/**
* Get (and create if necessary) the system store. This store houses things
* like workflow packages.
* @return The descriptor.
*/
public AVMStoreDescriptor getSystemStore()
{
AVMStoreDescriptor store = getStore(SYSTEM);
if (store == null)
{
createStore(SYSTEM);
return getStore(SYSTEM);
}
return store;
}
/**
* Get a descriptor for the specified AVMStore root.
* @param version The version to get.
* @param name The name of the AVMStore.
* @return The root descriptor.
*/
public AVMNodeDescriptor getStoreRoot(int version, String name)
{
if (name == null)
{
throw new AVMBadArgumentException("Name is null.");
}
return fAVMRepository.getAVMStoreRoot(version, name);
}
/**
* Get the history of a node.
* @param desc The node to get history from.
* @param count The number of ancestors to fallow back. -1 means all.
* @return A List of ancestors most recent first.
*/
public List<AVMNodeDescriptor> getHistory(AVMNodeDescriptor desc, int count)
{
if (desc == null)
{
throw new AVMBadArgumentException("Null descriptor.");
}
return fAVMRepository.getHistory(desc, count);
}
/**
* Set the opacity of a layered directory. An opaque layer hides what
* its indirection points to.
* @param path The path to the layered directory.
* @param opacity True is opaque false is not.
*/
public void setOpacity(String path, boolean opacity)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path.");
}
fAVMRepository.setOpacity(path, opacity);
}
/**
* Get layering information about a path.
* @param version The version to look under.
* @param path The full AVM path.
* @return A LayeringDescriptor.
*/
public LayeringDescriptor getLayeringInfo(int version, String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path: " + path);
}
return fAVMRepository.getLayeringInfo(version, path);
}
/**
* Get the common ancestor of two nodes if one exists.
* @param left The first node.
* @param right The second node.
* @return The common ancestor. There are four possible results. Null means
* that there is no common ancestor. Left returned means that left is strictly
* an ancestor of right. Right returned means that right is strictly an
* ancestor of left. Any other non null return is the common ancestor and
* indicates that left and right are in conflict.
*/
public AVMNodeDescriptor getCommonAncestor(AVMNodeDescriptor left,
AVMNodeDescriptor right)
{
if (left == null || right == null)
{
throw new AVMBadArgumentException("Null node descriptor.");
}
return fAVMRepository.getCommonAncestor(left, right);
}
/**
* Set a property on a node.
* @param path The path to the node to set the property on.
* @param name The QName of the property.
* @param value The property to set.
*/
public void setNodeProperty(String path, QName name, PropertyValue value)
{
if (path == null || name == null || value == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
fAVMRepository.setNodeProperty(path, name, value);
}
/**
* Set a collection of properties on a node.
* @param path The path to the node.
* @param properties The Map of properties to set.
*/
public void setNodeProperties(String path, Map<QName, PropertyValue> properties)
{
if (path == null || properties == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
fAVMRepository.setNodeProperties(path, properties);
}
/**
* Get a property of a node by QName.
* @param version The version to look under.
* @param path The path to the node.
* @param name The QName.
* @return The PropertyValue or null if it doesn't exist.
*/
public PropertyValue getNodeProperty(int version, String path, QName name)
{
if (path == null || name == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
return fAVMRepository.getNodeProperty(version, path, name);
}
/**
* Get all the properties associated with a node.
* @param version The version to look under.
* @param path The path to the node.
* @return A List of AVMNodeProperties.
*/
public Map<QName, PropertyValue> getNodeProperties(int version, String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path.");
}
return fAVMRepository.getNodeProperties(version, path);
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.avm.AVMService#getNodeProperties(org.alfresco.service.cmr.avm.AVMNodeDescriptor)
*/
public Map<QName, PropertyValue> getNodeProperties(AVMNodeDescriptor desc)
{
if (desc == null)
{
throw new AVMBadArgumentException("Null descriptor.");
}
return fAVMRepository.getNodeProperties(desc);
}
/**
* Delete a property.
* @param path The path to the node.
* @param name The QName of the property to delete.
*/
public void deleteNodeProperty(String path, QName name)
{
if (path == null || name == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
fAVMRepository.deleteNodeProperty(path, name);
}
/**
* Delete all the properties attached to an AVM node.
* @param path The path to the node.
*/
public void deleteNodeProperties(String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path.");
}
fAVMRepository.deleteNodeProperties(path);
}
/**
* Set a property on a store. If the property exists it will be overwritten.
* @param store The store to set the property on.
* @param name The name of the property.
* @param value The value of the property.
*/
public void setStoreProperty(String store, QName name, PropertyValue value)
{
if (store == null || name == null || value == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
fAVMRepository.setStoreProperty(store, name, value);
}
/**
* Set a group of properties on a store. Existing properties will be overwritten.
* @param store The name of the store.
* @param props A Map of the properties to set.
*/
public void setStoreProperties(String store, Map<QName, PropertyValue> props)
{
if (store == null || props == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
fAVMRepository.setStoreProperties(store, props);
}
/**
* Get a property from a store.
* @param store The name of the store.
* @param name The name of the property.
* @return A PropertyValue or null if non-existent.
*/
public PropertyValue getStoreProperty(String store, QName name)
{
if (store == null || name == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
return fAVMRepository.getStoreProperty(store, name);
}
/**
* Queries a given store for properties with keys that match a given pattern.
* @param store The name of the store.
* @param keyPattern The sql 'like' pattern, inserted into a QName.
* @return A Map of the matching key value pairs.
*/
public Map<QName, PropertyValue> queryStorePropertyKey(String store, QName keyPattern)
{
if (store == null || keyPattern == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
return fAVMRepository.queryStorePropertyKey(store, keyPattern);
}
/**
* Queries all AVM stores for properties with keys that matcha given pattern.
* @param keyPattern The sql 'like' pattern, inserted into a QName.
* @return A List of Pairs of Store name, Map.Entry.
*/
public Map<String, Map<QName, PropertyValue>>
queryStoresPropertyKeys(QName keyPattern)
{
if (keyPattern == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
return fAVMRepository.queryStoresPropertyKeys(keyPattern);
}
/**
* Get all the properties associated with a store.
* @param store The name of the store.
* @return A Map of the stores properties.
*/
public Map<QName, PropertyValue> getStoreProperties(String store)
{
if (store == null)
{
throw new AVMBadArgumentException("Null store name.");
}
return fAVMRepository.getStoreProperties(store);
}
/**
* Delete a property on a store by name.
* @param store The name of the store.
* @param name The name of the property to delete.
*/
public void deleteStoreProperty(String store, QName name)
{
if (store == null || name == null)
{
throw new AVMBadArgumentException("Invalid null argument.");
}
fAVMRepository.deleteStoreProperty(store, name);
}
/**
* Get the ContentData for a node. Only applies to a file.
* @param version The version to look under.
* @param path The path to the node.
* @return The ContentData object.
*/
public ContentData getContentDataForRead(int version, String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null Path.");
}
return fAVMRepository.getContentDataForRead(version, path);
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.avm.AVMService#getContentDataForRead(org.alfresco.service.cmr.avm.AVMNodeDescriptor)
*/
public ContentData getContentDataForRead(AVMNodeDescriptor desc)
{
if (desc == null)
{
throw new AVMBadArgumentException("Null descriptor.");
}
return fAVMRepository.getContentDataForRead(desc);
}
/**
* Get the Content data for writing.
* @param path The path to the node.
* @return The ContentData object.
*/
public ContentData getContentDataForWrite(String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null Path.");
}
return fAVMRepository.getContentDataForWrite(path);
}
/**
* Set the content data on a file.
* @param path The path to the file.
* @param data The ContentData to set.
* @throws AVMNotFoundException If <code>path</code> does not exist.
* @throws AVMWrongTypeException If <code>path</code> does not point
* to a file.
*/
public void setContentData(String path, ContentData data)
{
if (path == null || data == null)
{
throw new AVMBadArgumentException("Null Path.");
}
fAVMRepository.setContentData(path, data);
}
/**
* Set all metadata on a node from another node. Aspects, properties, ACLs.
* @param path The path to the node to set.
* @param from The descriptor for the node to get metadata from.
*/
public void setMetaDataFrom(String path, AVMNodeDescriptor from)
{
if (path == null || from == null)
{
throw new AVMBadArgumentException("Illegal null argument.");
}
fAVMRepository.setMetaDataFrom(path, from);
}
/**
* Add an aspect to an AVM node.
* @param path The path to the node.
* @param aspectName The QName of the aspect.
* @throws AVMNotFoundException If <code>path</code> does not exist.
* @throws AVMExistsException If the aspect already exists.
*/
public void addAspect(String path, QName aspectName)
{
if (path == null || aspectName == null)
{
throw new AVMBadArgumentException("Illegal Null Argument.");
}
fAVMRepository.addAspect(path, aspectName);
}
/**
* Get all the aspects on an AVM node.
* @param version The version to look under.
* @param path The path to the node.
* @return A List of the QNames of the aspects.
*/
public Set<QName> getAspects(int version, String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null path.");
}
return fAVMRepository.getAspects(version, path);
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.avm.AVMService#getAspects(org.alfresco.service.cmr.avm.AVMNodeDescriptor)
*/
public Set<QName> getAspects(AVMNodeDescriptor desc)
{
if (desc == null)
{
throw new AVMBadArgumentException("Null descriptor: " + desc);
}
return fAVMRepository.getAspects(desc);
}
/**
* Remove an aspect and its properties from a node.
* @param path The path to the node.
* @param aspectName The name of the aspect.
*/
public void removeAspect(String path, QName aspectName)
{
if (path == null || aspectName == null)
{
throw new AVMBadArgumentException("Null path.");
}
fAVMRepository.removeAspect(path, aspectName);
}
/**
* Does a node have a particular aspect.
* @param version The version to look under.
* @param path The path to the node.
* @param aspectName The aspect name to check.
* @return Whether the given node has the given aspect.
*/
public boolean hasAspect(int version, String path, QName aspectName)
{
if (path == null || aspectName == null)
{
throw new AVMBadArgumentException("Illegal Null Argument.");
}
return fAVMRepository.hasAspect(version, path, aspectName);
}
/**
* This inserts a node into a parent directly.
* @param parentPath The path to the parent directory.
* @param name The name to give the node.
* @param toLink A descriptor for the node to insert.
*/
public void link(String parentPath, String name, AVMNodeDescriptor toLink)
{
if (parentPath == null || name == null || toLink == null)
{
throw new AVMBadArgumentException("Illegal Null Argument.");
}
fAVMRepository.link(parentPath, name, toLink);
}
/**
* Force copy on write of a path.
* @param path The path to force.
*/
public AVMNodeDescriptor forceCopy(String path)
{
if (path == null)
{
throw new AVMBadArgumentException("Null Path.");
}
return fAVMRepository.forceCopy(path);
}
/**
* Copy (possibly recursively) the source into the destination
* directory.
* @param srcVersion The version of the source.
* @param srcPath The path to the source.
* @param dstPath The destination directory.
* @param name The name to give the copy.
*/
public void copy(int srcVersion, String srcPath, String dstPath, String name)
{
if (srcPath == null || dstPath == null)
{
throw new AVMBadArgumentException("Null Path.");
}
if (srcVersion < 0)
{
String canonicalSrc =
AVMNodeConverter.ToAVMVersionPath(
AVMNodeConverter.ToNodeRef(srcVersion, srcPath)).getSecond();
String canonicalDst =
AVMNodeConverter.ToAVMVersionPath(
AVMNodeConverter.ToNodeRef(-1, dstPath)).getSecond();
if (!canonicalSrc.endsWith("/"))
{
canonicalSrc = canonicalSrc + "/";
}
if (canonicalDst.indexOf(canonicalSrc) == 0)
{
throw new AVMBadArgumentException("Infinite Copy.");
}
}
if (!FileNameValidator.IsValid(name))
{
throw new AVMBadArgumentException("Illegal name.");
}
AVMNodeDescriptor srcDesc = lookup(srcVersion, srcPath);
recursiveCopy(srcVersion, srcDesc, dstPath, name);
}
private DbAccessControlList getAclAsSystem(final int version, final String path)
{
return AuthenticationUtil.runAs(new RunAsWork<DbAccessControlList>(){
public DbAccessControlList doWork() throws Exception
{
return fAVMRepository.getACL(version, path);
}}, AuthenticationUtil.getSystemUserName());
}
private void setAclAsSystem(final String path, final DbAccessControlList acl)
{
AuthenticationUtil.runAs(new RunAsWork<Object>(){
public Object doWork() throws Exception
{
fAVMRepository.setACL(path, acl);
return null;
}}, AuthenticationUtil.getSystemUserName());
}
/**
* Do the actual work of copying.
* @param desc The src descriptor.
* @param path The destination parent path.
* @param name The name to give the copy.
*/
private void recursiveCopy(int version, AVMNodeDescriptor desc, String path, String name)
{
String newPath = path + '/' + name;
AVMNodeDescriptor existing = lookup(-1, newPath);
DbAccessControlList parentAcl = getAclAsSystem(-1, path);
Long parentAclId = null;
if(parentAcl != null)
{
parentAclId = parentAcl.getId();
}
DbAccessControlList acl = getAclAsSystem(version, desc.getPath());
if (desc.isFile())
{
InputStream in = getFileInputStream(version, desc.getPath());
if (existing != null)
{
removeNode(newPath);
}
// Set the acl underneath
createFile(path, name, in);
if (acl != null)
{
setAclAsSystem(newPath, acl.getCopy(parentAclId, ACLCopyMode.COPY));
}
ContentData cd = getContentDataForRead(version, desc.getPath());
setEncoding(newPath, cd.getEncoding());
setMimeType(newPath, cd.getMimetype());
}
else // desc is a directory.
{
if (existing != null && !existing.isDirectory())
{
removeNode(newPath);
existing = null;
}
if (existing == null)
{
createDirectory(path, name);
// Set acl before creating children as acls inherit :-)
if (acl != null)
{
setAclAsSystem(newPath, acl.getCopy(parentAclId, ACLCopyMode.COPY));
}
}
Map<String, AVMNodeDescriptor> listing = getDirectoryListing(desc);
for (Map.Entry<String, AVMNodeDescriptor> entry : listing.entrySet())
{
recursiveCopy(version, entry.getValue(), newPath, entry.getKey());
}
}
// In either case copy properties, aspects, and acls.
Map<QName, PropertyValue> props = getNodeProperties(version, desc.getPath());
setNodeProperties(newPath, props);
Set<QName> aspects = getAspects(version, desc.getPath());
for (QName aspect : aspects)
{
addAspect(newPath, aspect);
}
}
/**
* Rename a store.
* @param sourceName The original name.
* @param destName The new name.
* @throws AVMNotFoundException
* @throws AVMExistsException
*/
public void renameStore(String sourceName, String destName)
{
if (sourceName == null || destName == null)
{
throw new AVMBadArgumentException("Illegal Null Argument.");
}
fAVMRepository.renameStore(sourceName, destName);
}
/**
* Revert a head path to a given version. This works by cloning
* the version to revert to, and then linking that new version into head.
* The reverted version will have the previous head version as ancestor.
* @param path The path to the node to revert.
* @param toRevertTo The descriptor of the version to revert to.
* @throws AVMNotFoundException
*/
public void revert(String path, AVMNodeDescriptor toRevertTo)
{
if (path == null || toRevertTo == null)
{
throw new AVMBadArgumentException("Illegal Null Argument.");
}
String [] baseName = AVMNodeConverter.SplitBase(path);
if (baseName.length != 2)
{
throw new AVMBadArgumentException("Cannot revert store root: " + path);
}
fAVMRepository.revert(baseName[0], baseName[1], toRevertTo);
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.avm.AVMService#setGuid(java.lang.String, java.lang.String)
*/
public void setGuid(String path, String guid)
{
if (path == null || guid == null)
{
throw new AVMBadArgumentException("Illegal Null Argument.");
}
fAVMRepository.setGuid(path, guid);
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.avm.AVMService#setEncoding(java.lang.String, java.lang.String)
*/
public void setEncoding(String path, String encoding)
{
if (path == null || encoding == null)
{
throw new AVMBadArgumentException("Illegal Null Argument.");
}
fAVMRepository.setEncoding(path, encoding);
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.avm.AVMService#setMimeType(java.lang.String, java.lang.String)
*/
public void setMimeType(String path, String mimeType)
{
if (path == null || mimeType == null)
{
throw new AVMBadArgumentException("Illegal Null Argument.");
}
fAVMRepository.setMimeType(path, mimeType);
}
}
The table below shows all metrics for AVMServiceImpl.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 205.00 | Number of blocks | |
| BLOCK_COMMENT | 59.00 | Number of block comment lines | |
| COMMENTS | 562.00 | Comment lines | |
| COMMENT_DENSITY | 1.13 | Comment density | |
| COMPARISONS | 153.00 | Number of comparison operators | |
| CYCLOMATIC | 252.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 94.00 | Comments in declarations | |
| DOC_COMMENT | 499.00 | Number of javadoc comment lines | |
| ELOC | 499.00 | Effective lines of code | |
| EXEC_COMMENTS | 4.00 | Comments in executable code | |
| EXITS | 134.00 | Procedure exits | |
| FUNCTIONS | 95.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 74.34 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 370.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 | 1.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 | 0.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 | 1.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 | 0.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 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.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 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 1.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 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.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 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 3.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 | 1.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.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 | 0.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 | 3.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.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 | 0.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 | 2.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.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 | 0.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 | 0.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 | 0.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 | 1574.00 | Number of lines in the source file | |
| LINE_COMMENT | 4.00 | Number of line comments | |
| LOC | 909.00 | Lines of code | |
| LOGICAL_LINES | 269.00 | Number of statements | |
| LOOPS | 1.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 1685.00 | Number of operands | |
| OPERATORS | 3207.00 | Number of operators | |
| PARAMS | 185.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 4892.00 | Halstead program length | |
| PROGRAM_VOCAB | 592.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 185.00 | Number of return points from functions | |
| SIZE | 54553.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 544.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 48.00 | Number of unique operators | |
| WHITESPACE | 103.00 | Number of whitespace lines | |