AbstractStore.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.slide.store |
 |
 |
Jakarta Slide |
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 |  |
| RETURNS | Number of return points from functions | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| BLOCKS | Number of blocks | |
| JAVA0170 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0150 | JAVA0150 java.lang.Error (or subclass) thrown | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| SIZE | Size of the file in bytes | |
| CYCLOMATIC | Cyclomatic complexity | |
| ELOC | Effective lines of code | |
| LINES | Number of lines in the source file | |
| DOC_COMMENT | Number of javadoc comment lines | |
| LOGICAL_LINES | Number of statements | |
| EXEC_COMMENTS | Comments in executable code | |
| LOC | Lines of code | |
| COMMENTS | Comment lines | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| OPERATORS | Number of operators | |
| LINE_COMMENT | Number of line comments | |
| PARAMS | Number of formal parameter declarations | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
| FUNCTIONS | Number of function declarations | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| EXITS | Procedure exits | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LOOPS | Number of loops | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| COMPARISONS | Number of comparison operators | |
| JAVA0067 | JAVA0067 Array descriptor on identifier name | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0087 | JAVA0087 Use of Thread.sleep() | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* $Header$
* $Revision: 232268 $
* $Date: 2005-08-12 07:06:27 -0400 (Fri, 12 Aug 2005) $
*
* ====================================================================
*
* Copyright 1999-2002 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.slide.store;
import java.util.Enumeration;
import java.util.Hashtable;
import javax.transaction.Transaction;
import javax.transaction.xa.XAException;
import javax.transaction.xa.Xid;
import org.apache.slide.authenticate.CredentialsToken;
import org.apache.slide.common.AbstractSimpleService;
import org.apache.slide.common.Namespace;
import org.apache.slide.common.NamespaceAccessToken;
import org.apache.slide.common.Scope;
import org.apache.slide.common.Service;
import org.apache.slide.common.ServiceAccessException;
import org.apache.slide.common.ServiceConnectionFailedException;
import org.apache.slide.common.ServiceDisconnectionFailedException;
import org.apache.slide.common.ServiceInitializationFailedException;
import org.apache.slide.common.ServiceParameterErrorException;
import org.apache.slide.common.ServiceParameterMissingException;
import org.apache.slide.common.ServiceResetFailedException;
import org.apache.slide.common.SlideToken;
import org.apache.slide.common.Uri;
import org.apache.slide.content.NodeRevisionContent;
import org.apache.slide.content.NodeRevisionDescriptor;
import org.apache.slide.content.NodeRevisionDescriptors;
import org.apache.slide.content.NodeRevisionNumber;
import org.apache.slide.content.RevisionAlreadyExistException;
import org.apache.slide.content.RevisionDescriptorNotFoundException;
import org.apache.slide.content.RevisionNotFoundException;
import org.apache.slide.lock.LockTokenNotFoundException;
import org.apache.slide.lock.NodeLock;
import org.apache.slide.search.IndexException;
import org.apache.slide.security.NodePermission;
import org.apache.slide.structure.ObjectAlreadyExistsException;
import org.apache.slide.structure.ObjectNode;
import org.apache.slide.structure.ObjectNotFoundException;
import org.apache.slide.util.Messages;
import org.apache.slide.util.logger.Logger;
/**
* Abstract implementation of a store. Handles all caching operations.
*
* @version $Revision: 232268 $
*/
public abstract class AbstractStore extends AbstractSimpleService
implements Store {
// ----------------------------------------------------------- Constructors
// ----------------------------------------------------- Instance Variables
/**
* Node store.
*/
protected NodeStore nodeStore;
/**
* Security store.
*/
protected SecurityStore securityStore;
/**
* Lock store.
*/
protected LockStore lockStore;
/**
* Revision descriptors store.
*/
protected RevisionDescriptorsStore revisionDescriptorsStore;
/**
* Revision descriptor store.
*/
protected RevisionDescriptorStore revisionDescriptorStore;
/**
* Content store.
*/
protected ContentStore contentStore;
/**
* DescriptorIndex store
*/
protected IndexStore propertiesIndexer;
/**
* ContentIndex store
*/
protected IndexStore contentIndexer;
/**
* Sequence store
*/
protected SequenceStore sequenceStore = null;
/**
* Macro store
*/
protected MacroStore macroStore = null;
/**
* Active resource manager list.
*/
protected Service resourceManagers[] = new Service[0];
// the name of this store as specified in domain.xml
private String name;
/**
* Set the name of the store as specified in domain.xml.
*/
public void setName(String name) {
this.name = name;
}
/**
* Return the name of the store as specified in domain.xml.
*/
public String getName() {
return this.name;
}
/**
* Set the scope of the store as specified in domain.xml.
*/
public void setScope(Scope scope) {
super.setScope(scope);
for (int i = 0; i < resourceManagers.length; i++) {
resourceManagers[i].setScope(scope);
}
}
// ---------------------------------------------------- ServiceImpl Methods
/**
* Namespace setter.
*/
public void setNamespace(Namespace namespace) {
super.setNamespace(namespace);
for (int i = 0; i < resourceManagers.length; i++) {
resourceManagers[i].setNamespace(namespace);
}
}
protected Hashtable parameters = null;
/**
* Remeber the store parameters to initialise the default child stores on request
*
* @param parameters Hashtable containing the parameters' name
* and associated value
* @exception ServiceParameterErrorException Incorrect service parameter
* @exception ServiceParameterMissingException Service parameter missing
*/
public void setParameters(Hashtable parameters)
throws ServiceParameterErrorException,
ServiceParameterMissingException {
this.parameters = new Hashtable(parameters);
}
public Object getParameter (Object key) {
return parameters.get (key);
}
/**
* Connects to descriptors store.
*
* @exception DataException
*/
public void connect(CredentialsToken crdtoken)
throws ServiceConnectionFailedException {
for (int i = 0; i < resourceManagers.length; i++) {
resourceManagers[i].connect(crdtoken);
}
}
/**
* Connects to descriptors store.
*
* @exception DataException
*/
public void connect()
throws ServiceConnectionFailedException {
for (int i = 0; i < resourceManagers.length; i++) {
resourceManagers[i].connect();
}
}
/**
* Disconnects from descriptors store.
*
* @exception ServiceDisconnectionFailedException
*/
public void disconnect()
throws ServiceDisconnectionFailedException {
for (int i = 0; i < resourceManagers.length; i++) {
resourceManagers[i].disconnect();
}
}
/**
* Initializes descriptors store.
*
* @exception ServiceInitializationFailedException Throws an exception
* if the descriptors store has already been initialized before
*/
public void initialize(NamespaceAccessToken token)
throws ServiceInitializationFailedException {
super.initialize(token);
for (int i = 0; i < resourceManagers.length; i++) {
resourceManagers[i].initialize(token);
}
}
/**
* Deletes descriptors store. Should remove stored data if possible.
*
* @exception ServiceResetFailedException Reset failed
*/
public void reset()
throws ServiceResetFailedException {
for (int i = 0; i < resourceManagers.length; i++) {
resourceManagers[i].reset();
}
}
/**
* This function tells whether or not the descriptors store is connected.
*
* @return boolean true if we are connected
* @exception ServiceAccessException Service access error
*/
public boolean isConnected()
throws ServiceAccessException {
for (int i = 0; i < resourceManagers.length; i++) {
if (!resourceManagers[i].isConnected())
return false;
}
return true;
}
// ----------------------------------------------------- XAResource Methods
/**
* Commit the global transaction specified by xid.
*
* @param xid A global transaction identifier
* @param onePhase If true, the resource manager should use a one-phase
* commit protocol to commit the work done on behalf of xid.
* @exception XAException An error has occurred. Possible XAExceptions
* are XA_HEURHAZ, XA_HEURCOM, XA_HEURRB, XA_HEURMIX, XAER_RMERR,
* XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO. If the resource
* manager did not commit the transaction and the paramether onePhase is
* set to true, the resource manager may throw one of the XA_RB*
* exceptions. Upon return, the resource manager has rolled back the
* branch's work and has released all held resources.
*/
public void commit(Xid xid, boolean onePhase)
throws XAException {
super.commit(xid, onePhase);
}
/**
* Ends the work performed on behalf of a transaction branch.
*
* @param xid A global transaction identifier that is the same as what
* was used previously in the start method.
* @param flags One of TMSUCCESS, TMFAIL, or TMSUSPEND
* @exception XAException An error has occurred. Possible XAException
* values are XAER_RMERR, XAER_RMFAILED, XAER_NOTA, XAER_INVAL,
* XAER_PROTO, or XA_RB*.
*/
public void end(Xid xid, int flags)
throws XAException {
super.end(xid, flags);
}
/**
* Tell the resource manager to forget about a heuristically completed
* transaction branch.
*
* @param xid A global transaction identifier
* @exception XAException An error has occurred. Possible exception values
* are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.
*/
public void forget(Xid xid)
throws XAException {
super.forget(xid);
}
/**
* Ask the resource manager to prepare for a transaction commit of the
* transaction specified in xid.
*
* @param xid A global transaction identifier
* @return A value indicating the resource manager's vote on the outcome
* of the transaction. The possible values are: XA_RDONLY or XA_OK. If
* the resource manager wants to roll back the transaction, it should do
* so by raising an appropriate XAException in the prepare method.
* @exception XAException An error has occurred. Possible exception
* values are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL,
* or XAER_PROTO.
*/
public int prepare(Xid xid)
throws XAException {
return super.prepare(xid);
}
/**
* Inform the resource manager to roll back work done on behalf of a
* transaction branch.
*
* @param xid A global transaction identifier
* @exception XAException An error has occurred
*/
public void rollback(Xid xid)
throws XAException {
super.rollback(xid);
}
/**
* Start work on behalf of a transaction branch specified in xid.
*
* @param xid A global transaction identifier to be associated with the
* resource
* @param flags One of TMNOFLAGS, TMJOIN, or TMRESUME
* @exception XAException An error has occurred. Possible exceptions are
* XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_DUPID, XAER_OUTSIDE, XAER_NOTA,
* XAER_INVAL, or XAER_PROTO.
*/
public void start(Xid xid, int flags)
throws XAException {
super.start(xid, flags);
}
// ---------------------------------------------------------- Store Methods
/**
* Set the node store associated with this store.
*/
public void setNodeStore(NodeStore nodeStore) {
if (nodeStore == null) {
throw new IllegalArgumentException("Nodestore must not be null");
}
this.nodeStore = nodeStore;
addResourceManager(this.nodeStore);
}
/**
* Set the security store associated with this store.
*/
public void setSecurityStore(SecurityStore securityStore) {
if (securityStore == null) {
throw new IllegalArgumentException("Securitystore must not be null");
}
this.securityStore = securityStore;
addResourceManager(this.securityStore);
}
/**
* Set the lock store associated with this store.
*/
public void setLockStore(LockStore lockStore) {
if (lockStore == null) {
throw new IllegalArgumentException("Lockstore must not be null");
}
this.lockStore = lockStore;
addResourceManager(this.lockStore);
}
/**
* Set the revision descriptors store associated with this store.
*/
public void setRevisionDescriptorsStore
(RevisionDescriptorsStore revisionDescriptorsStore) {
if (revisionDescriptorsStore == null) {
throw new IllegalArgumentException("Revisiondescriptorsstore must not be null");
}
this.revisionDescriptorsStore = revisionDescriptorsStore;
addResourceManager(this.revisionDescriptorsStore);
}
/**
* Set the revision descriptor store associated with this store.
*/
public void setRevisionDescriptorStore
(RevisionDescriptorStore revisionDescriptorStore) {
if (revisionDescriptorStore == null) {
throw new IllegalArgumentException("Revisiondescriptorstore must not be null");
}
this.revisionDescriptorStore = revisionDescriptorStore;
addResourceManager(this.revisionDescriptorStore);
}
/**
* Set the content store associated with this store.
*/
public void setContentStore(ContentStore contentStore) {
if (contentStore == null) {
}
this.contentStore = contentStore;
addResourceManager(this.contentStore);
}
/**
* Set the Indexer associated to the properties store
*
* @param propertiesIndexer an IndexStore
*
*/
public void setPropertiesIndexer (IndexStore propertiesIndexer) {
if (propertiesIndexer == null) {
throw new IllegalArgumentException("PropertiesIndexer must not be null");
}
this.propertiesIndexer = propertiesIndexer;
addResourceManager(this.propertiesIndexer);
}
/**
* Set the Indexer associated to the conten store
*
* @param contentIndexer an IndexStore
*
*/
public void setContentIndexer (IndexStore contentIndexer) {
if (contentIndexer == null) {
throw new IllegalArgumentException("ContentIndexer must not be null");
}
this.contentIndexer = contentIndexer;
addResourceManager(this.contentIndexer);
}
/**
* Method getContentIndexer
*
* @return an IndexStore
*
*/
public IndexStore getContentIndexer () {
return contentIndexer;
}
/**
* Method getPropertiesIndexer
*
* @return an IndexStore
*
*/
public IndexStore getPropertiesIndexer () {
return propertiesIndexer;
}
/**
* Sets the sequence store associated with this store.
*/
public void setSequenceStore(SequenceStore store) {
sequenceStore = store;
}
/**
* Sets the sequence store associated with this store.
*/
public void setMacroStore(MacroStore store) {
macroStore = store;
}
//
// sequence methods
//
/**
* @see org.apache.slide.store.SequenceStore#isSequenceSupported()
*/
public boolean isSequenceSupported() {
return (sequenceStore != null && sequenceStore.isSequenceSupported());
}
/**
* @see org.apache.slide.store.SequenceStore#sequenceExists(java.lang.String)
*/
public boolean sequenceExists(String sequenceName) throws ServiceAccessException {
if (!isSequenceSupported()) {
throw new ServiceAccessException(this, "Sequences not supported");
}
return sequenceStore.sequenceExists(sequenceName);
}
/**
* @see org.apache.slide.store.SequenceStore#createSequence(java.lang.String)
*/
public boolean createSequence(String sequenceName) throws ServiceAccessException {
if (!isSequenceSupported()) {
throw new ServiceAccessException(this, "Sequences not supported");
}
return sequenceStore.createSequence(sequenceName);
}
/**
* @see org.apache.slide.store.SequenceStore#nextSequenceValue(java.lang.String)
*/
public long nextSequenceValue(String sequenceName) throws ServiceAccessException {
if (!isSequenceSupported()) {
throw new ServiceAccessException(this, "Sequences not supported");
}
return sequenceStore.nextSequenceValue(sequenceName);
}
//
// macro methods
//
/**
* @see org.apache.slide.store.MacroStore#isMacroDeleteSupported()
*/
public boolean isMacroDeleteSupported() {
return (macroStore != null && macroStore.isMacroDeleteSupported());
}
/**
* @see org.apache.slide.store.MacroStore#macroDelete(org.apache.slide.common.Uri)
*/
public void macroDelete(Uri targetUri) throws ServiceAccessException, ObjectNotFoundException {
if (!isMacroDeleteSupported()) {
throw new ServiceAccessException(this, "Macro delete not supported");
}
enlist(macroStore);
try {
macroStore.macroDelete(targetUri);
} finally {
delist(macroStore);
}
}
/**
* @see org.apache.slide.store.MacroStore#isMacroCopySupported()
*/
public boolean isMacroCopySupported() {
return (macroStore != null && macroStore.isMacroCopySupported());
}
/**
* @see org.apache.slide.store.MacroStore#macroCopy(Uri, Uri, boolean, boolean)
*/
public void macroCopy(Uri sourceUri, Uri targetUri, boolean overwrite, boolean recursive)
throws ServiceAccessException, ObjectNotFoundException, ObjectAlreadyExistsException {
if (!isMacroCopySupported()) {
throw new ServiceAccessException(this, "Macro copy not supported");
}
enlist(macroStore);
try {
macroStore.macroCopy(sourceUri, targetUri, overwrite, recursive);
} finally {
delist(macroStore);
}
}
/**
* @see org.apache.slide.store.MacroStore#isMacroMoveSupported()
*/
public boolean isMacroMoveSupported() {
return (macroStore != null && macroStore.isMacroMoveSupported());
}
/**
* @see org.apache.slide.store.MacroStore#macroMove(Uri, Uri, boolean)
*/
public void macroMove(Uri sourceUri, Uri targetUri, boolean overwrite)
throws ServiceAccessException, ObjectNotFoundException, ObjectAlreadyExistsException {
if (!isMacroMoveSupported()) {
throw new ServiceAccessException(this, "Macro move not supported");
}
enlist(macroStore);
try {
macroStore.macroMove(sourceUri, targetUri, overwrite);
} finally {
delist(macroStore);
}
}
/**
* Retrive an object from the Descriptors Store.
*
* @param uri Uri of the object we want to retrieve
* @exception ServiceAccessException Error accessing the Descriptors Store
* @exception ObjectNotFoundException The object to retrieve was not found
*/
public ObjectNode retrieveObject(Uri uri)
throws ServiceAccessException, ObjectNotFoundException {
ObjectNode objectNode = null;
if (isForceStoreEnlistment(uri)) {
enlist(nodeStore);
try {
objectNode = nodeStore.retrieveObject(uri);
} catch (ServiceAccessException e) {
delist(nodeStore, false);
throw e;
} catch (ObjectNotFoundException e) {
// Note : Failed reads aren't considered fatal (ie, the
// transaction won't be always rolledback when committed)
delist(nodeStore);
throw e;
} catch (Error e) {
delist(nodeStore, false);
throw e;
} catch (Throwable t) {
delist(nodeStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(nodeStore, t);
}
delist(nodeStore);
} else {
try {
objectNode = nodeStore.retrieveObject(uri);
} catch (ServiceAccessException e) {
throw e;
} catch (ObjectNotFoundException e) {
throw e;
} catch (Error e) {
throw e;
} catch (Throwable t) {
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(nodeStore, t);
}
}
objectNode.validate(uri.toString());
return objectNode;
}
/**
* Store an object in the Descriptors Store.
*
* @param object Object to update
* @exception ServiceAccessException Error accessing the Descriptors Store
* @exception ObjectNotFoundException The object to update was not found
*/
public void storeObject(Uri uri, ObjectNode object)
throws ServiceAccessException, ObjectNotFoundException {
ObjectNode tempObject = object.cloneObject();
tempObject.validate(uri.toString());
enlist(nodeStore);
try {
nodeStore.storeObject(uri, tempObject);
} catch (ServiceAccessException e) {
delist(nodeStore, false);
throw e;
} catch (ObjectNotFoundException e) {
delist(nodeStore);
throw e;
} catch (Error e) {
delist(nodeStore, false);
throw e;
} catch (Throwable t) {
delist(nodeStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(contentStore, t);
}
delist(nodeStore);
}
/**
* Create a new object in the Descriptors Store.
*
* @param object SlideObject
* @param uri Uri of the object we want to create
* @exception ServiceAccessException Error accessing the Descriptors Store
* @exception ObjectAlreadyExistsException An object already exists
* at this Uri
*/
public void createObject(Uri uri, ObjectNode object)
throws ServiceAccessException, ObjectAlreadyExistsException {
ObjectNode tempObject = object.cloneObject();
tempObject.validate(uri.toString());
enlist(nodeStore);
try {
nodeStore.createObject(uri, tempObject);
if (useBinding()) {
String uuri = tempObject.getUuri();
if (uuri == null) {
throw new IllegalStateException();
}
object.setUuri(uuri);
} else {
object.setUuri(tempObject.getUri());
}
} catch (ServiceAccessException e) {
delist(nodeStore, false);
throw e;
} catch (ObjectAlreadyExistsException e) {
delist(nodeStore);
throw e;
} catch (Error e) {
delist(nodeStore, false);
throw e;
} catch (Throwable t) {
delist(nodeStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(nodeStore, t);
}
delist(nodeStore);
}
/**
* Remove an object from the Descriptors Store.
*
* @param object Object to remove
* @exception ServiceAccessException Error accessing the Descriptors Store
* @exception ObjectNotFoundException The object to remove was not found
*/
public void removeObject(Uri uri, ObjectNode object)
throws ServiceAccessException, ObjectNotFoundException {
object.validate(uri.toString());
enlist(nodeStore);
try {
nodeStore.removeObject(uri, object);
} catch (ServiceAccessException e) {
delist(nodeStore, false);
throw e;
} catch (ObjectNotFoundException e) {
delist(nodeStore);
throw e;
} catch (Error e) {
delist(nodeStore, false);
throw e;
} catch (Throwable t) {
delist(nodeStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(nodeStore, t);
}
delist(nodeStore);
}
/**
* Store an object permissions in the Descriptors Store.
*
* @param permission Permission we want to create
* @exception ServiceAccessException Error accessing the Descriptors Store
*/
public void grantPermission(Uri uri, NodePermission permission)
throws ServiceAccessException {
NodePermission tempPermission = permission.cloneObject();
tempPermission.validate(uri.toString());
enlist(securityStore);
try {
securityStore.grantPermission(uri, tempPermission);
} catch (ServiceAccessException e) {
delist(securityStore, false);
throw e;
} catch (Error e) {
delist(securityStore, false);
throw e;
} catch (Throwable t) {
delist(securityStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(securityStore, t);
}
delist(securityStore);
}
/**
* Store an object permissions in the Descriptors Store.
*
* @param permission Permission we want to create
* @exception ServiceAccessException Error accessing the Descriptors Store
*/
public void revokePermission(Uri uri, NodePermission permission)
throws ServiceAccessException {
permission.validate(uri.toString());
enlist(securityStore);
try {
securityStore.revokePermission(uri, permission);
} catch (ServiceAccessException e) {
delist(securityStore, false);
throw e;
} catch (Error e) {
delist(securityStore, false);
throw e;
} catch (Throwable t) {
delist(securityStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(securityStore, t);
}
delist(securityStore);
}
/**
* Revoke all the permissions on the object.
*
* @param uri Uri of the object
* @exception ServiceAccessException Error accessing the Descriptors Store
*/
public void revokePermissions(Uri uri)
throws ServiceAccessException {
enlist(securityStore);
try {
securityStore.revokePermissions(uri);
} catch (ServiceAccessException e) {
delist(securityStore, false);
throw e;
} catch (Error e) {
delist(securityStore, false);
throw e;
} catch (Throwable t) {
delist(securityStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(securityStore, t);
}
delist(securityStore);
}
/**
* Enumerate locks on an object.
*
* @param uri Uri of the subject
* @return Enumeration List of {@link org.apache.slide.lock.NodeLock locks}
* which have been put on the subject
* @exception ServiceAccessException Service access error
*/
public Enumeration enumeratePermissions(Uri uri)
throws ServiceAccessException {
// TODO : The vectors elements MUST be cloned
if (isForceStoreEnlistment(uri)) {
enlist(securityStore);
Enumeration permissions = null;
try {
permissions = securityStore.enumeratePermissions(uri);
} catch (ServiceAccessException e) {
delist(securityStore, false);
throw e;
} catch (Error e) {
delist(securityStore, false);
throw e;
} catch (Throwable t) {
delist(securityStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(securityStore, t);
}
delist(securityStore);
return permissions;
} else {
try {
return securityStore.enumeratePermissions(uri);
} catch (ServiceAccessException e) {
throw e;
} catch (Error e) {
throw e;
} catch (Throwable t) {
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(securityStore, t);
}
}
}
/**
* Puts a lock on a subject.
*
* @param lock Lock token
* @exception ServiceAccessException Service access error
*/
public void putLock(Uri uri, NodeLock lock)
throws ServiceAccessException {
lock.validate(uri.toString());
enlist(lockStore);
try {
lockStore.putLock(uri, lock);
} catch (ServiceAccessException e) {
delist(lockStore, false);
throw e;
} catch (Error e) {
delist(lockStore, false);
throw e;
} catch (Throwable t) {
delist(lockStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(lockStore, t);
}
delist(lockStore);
}
/**
* Renews a lock.
*
* @param lock Token to renew
* @exception ServiceAccessException Service access error
* @exception LockTokenNotFoundException Lock token was not found
*/
public void renewLock(Uri uri, NodeLock lock)
throws ServiceAccessException, LockTokenNotFoundException {
lock.validate(uri.toString());
enlist(lockStore);
try {
lockStore.renewLock(uri, lock);
} catch (ServiceAccessException e) {
delist(lockStore, false);
throw e;
} catch (LockTokenNotFoundException e) {
delist(lockStore);
throw e;
} catch (Error e) {
delist(lockStore, false);
throw e;
} catch (Throwable t) {
delist(lockStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(lockStore, t);
}
delist(lockStore);
}
/**
* Removes (cancels) a lock.
*
* @param lock Token to remove
* @exception ServiceAccessException Service access error
* @exception LockTokenNotFoundException Lock token was not found
*/
public void removeLock(Uri uri, NodeLock lock)
throws ServiceAccessException, LockTokenNotFoundException {
lock.validate(uri.toString());
enlist(lockStore);
try {
lockStore.removeLock(uri, lock);
} catch (ServiceAccessException e) {
delist(lockStore, false);
throw e;
} catch (LockTokenNotFoundException e) {
delist(lockStore);
throw e;
} catch (Error e) {
delist(lockStore, false);
throw e;
} catch (Throwable t) {
delist(lockStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(lockStore, t);
}
delist(lockStore);
}
/**
* Kills a lock.
*
* @param lock Token to remove
* @exception ServiceAccessException Service access error
* @exception LockTokenNotFoundException Lock token was not found
*/
public void killLock(Uri uri, NodeLock lock)
throws ServiceAccessException, LockTokenNotFoundException {
lock.validate(uri.toString());
enlist(lockStore);
try {
lockStore.killLock(uri, lock);
} catch (ServiceAccessException e) {
delist(lockStore, false);
throw e;
} catch (LockTokenNotFoundException e) {
delist(lockStore);
throw e;
} catch (Error e) {
delist(lockStore, false);
throw e;
} catch (Throwable t) {
delist(lockStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(lockStore, t);
}
delist(lockStore);
}
/**
* Enumerate locks on an object.
*
* @param uri Uri of the subject
* @return Enumeration List of {@link org.apache.slide.lock.NodeLock locks}
* which have been put on the subject
* @exception ServiceAccessException Service access error
*/
public Enumeration enumerateLocks(Uri uri)
throws ServiceAccessException {
if (isForceStoreEnlistment(uri)) {
enlist(lockStore);
Enumeration locks = null;
try {
locks = lockStore.enumerateLocks(uri);
} catch (ServiceAccessException e) {
delist(lockStore, false);
throw e;
} catch (Error e) {
delist(lockStore, false);
throw e;
} catch (Throwable t) {
delist(lockStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(lockStore, t);
}
delist(lockStore);
return locks;
} else {
try {
return lockStore.enumerateLocks(uri);
} catch (ServiceAccessException e) {
throw e;
} catch (Error e) {
throw e;
} catch (Throwable t) {
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(lockStore, t);
}
}
}
/**
* Retrieve a revision descriptors.
*
* @param uri Uri
* @exception ServiceAccessException Service access error
* @exception RevisionDescriptorNotFoundException Revision descriptor
* was not found
*/
public NodeRevisionDescriptors retrieveRevisionDescriptors(Uri uri)
throws ServiceAccessException, RevisionDescriptorNotFoundException {
NodeRevisionDescriptors revisionDescriptors = null;
if (isForceStoreEnlistment(uri)) {
enlist(revisionDescriptorsStore);
try {
revisionDescriptors =
revisionDescriptorsStore.retrieveRevisionDescriptors(uri);
} catch (ServiceAccessException e) {
delist(revisionDescriptorsStore, false);
throw e;
} catch (RevisionDescriptorNotFoundException e) {
// Normal read failures aren't considered fatal
delist(revisionDescriptorsStore);
throw e;
} catch (Error e) {
delist(revisionDescriptorsStore, false);
throw e;
} catch (Throwable t) {
delist(revisionDescriptorsStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(revisionDescriptorsStore, t);
}
delist(revisionDescriptorsStore);
} else {
try {
revisionDescriptors =
revisionDescriptorsStore.retrieveRevisionDescriptors(uri);
} catch (ServiceAccessException e) {
throw e;
} catch (RevisionDescriptorNotFoundException e) {
throw e;
} catch (Error e) {
throw e;
} catch (Throwable t) {
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(revisionDescriptorsStore, t);
}
}
revisionDescriptors.validate(uri.toString());
return revisionDescriptors;
}
/**
* Create new revision descriptors.
*
* @param uri Uri
* @param revisionDescriptors Node revision descriptors
* @exception ServiceAccessException Service access error
*/
public void createRevisionDescriptors
(Uri uri, NodeRevisionDescriptors revisionDescriptors)
throws ServiceAccessException {
revisionDescriptors.validate(uri.toString());
enlist(revisionDescriptorsStore);
try {
revisionDescriptorsStore.createRevisionDescriptors
(uri, revisionDescriptors);
} catch (ServiceAccessException e) {
delist(revisionDescriptorsStore, false);
throw e;
} catch (Error e) {
delist(revisionDescriptorsStore, false);
throw e;
} catch (Throwable t) {
delist(revisionDescriptorsStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(revisionDescriptorsStore, t);
}
delist(revisionDescriptorsStore);
}
/**
* Update revision descriptors.
*
* @param uri Uri
* @param revisionDescriptors Node revision descriptors
* @exception ServiceAccessException Service access error
* @exception RevisionDescriptorNotFoundException Revision descriptor
* was not found
*/
public void storeRevisionDescriptors
(Uri uri, NodeRevisionDescriptors revisionDescriptors)
throws ServiceAccessException, RevisionDescriptorNotFoundException {
revisionDescriptors.validate(uri.toString());
enlist(revisionDescriptorsStore);
try {
revisionDescriptorsStore.storeRevisionDescriptors
(uri, revisionDescriptors);
} catch (ServiceAccessException e) {
delist(revisionDescriptorsStore, false);
throw e;
} catch (RevisionDescriptorNotFoundException e) {
delist(revisionDescriptorsStore);
throw e;
} catch (Error e) {
delist(revisionDescriptorsStore, false);
throw e;
} catch (Throwable t) {
delist(revisionDescriptorsStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(revisionDescriptorsStore, t);
}
delist(revisionDescriptorsStore);
}
/**
* Remove revision descriptors.
*
* @param uri Uri
* @exception ServiceAccessException Service access error
*/
public void removeRevisionDescriptors(Uri uri)
throws ServiceAccessException {
enlist(revisionDescriptorsStore);
try {
revisionDescriptorsStore.removeRevisionDescriptors(uri);
} catch (ServiceAccessException e) {
delist(revisionDescriptorsStore, false);
throw e;
} catch (Error e) {
delist(revisionDescriptorsStore, false);
throw e;
} catch (Throwable t) {
delist(revisionDescriptorsStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(revisionDescriptorsStore, t);
}
delist(revisionDescriptorsStore);
}
/**
* Retrieve revision descriptor.
*
* @param uri uri
* @param revisionNumber Node revision number
*/
public NodeRevisionDescriptor retrieveRevisionDescriptor
(Uri uri, NodeRevisionNumber revisionNumber)
throws ServiceAccessException, RevisionDescriptorNotFoundException {
NodeRevisionDescriptor revisionDescriptor = null;
if (isForceStoreEnlistment(uri)) {
enlist(revisionDescriptorStore);
try {
revisionDescriptor =
revisionDescriptorStore.retrieveRevisionDescriptor
(uri, revisionNumber);
} catch (ServiceAccessException e) {
delist(revisionDescriptorStore, false);
throw e;
} catch (RevisionDescriptorNotFoundException e) {
// Normal read failures aren't considered fatal
delist(revisionDescriptorStore);
throw e;
} catch (Error e) {
delist(revisionDescriptorsStore, false);
throw e;
} catch (Throwable t) {
delist(revisionDescriptorStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(revisionDescriptorStore, t);
}
delist(revisionDescriptorStore);
} else {
try {
revisionDescriptor =
revisionDescriptorStore.retrieveRevisionDescriptor
(uri, revisionNumber);
} catch (ServiceAccessException e) {
throw e;
} catch (RevisionDescriptorNotFoundException e) {
throw e;
} catch (Error e) {
throw e;
} catch (Throwable t) {
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(revisionDescriptorStore, t);
}
}
revisionDescriptor.validate();
return revisionDescriptor;
}
/**
* Create new revision descriptor.
*
* @param uri Uri
* @param revisionDescriptor Node revision descriptor
* @exception ServiceAccessException Service access error
*/
public void createRevisionDescriptor
(Uri uri, NodeRevisionDescriptor revisionDescriptor)
throws ServiceAccessException {
revisionDescriptor.validate();
enlist(propertiesIndexer);
enlist(revisionDescriptorStore);
try {
propertiesIndexer.createIndex (uri, revisionDescriptor, null);
revisionDescriptorStore.createRevisionDescriptor
(uri, revisionDescriptor);
revisionDescriptor.resetRemovedProperties();
revisionDescriptor.resetUpdatedProperties();
} catch (ServiceAccessException e) {
delist (propertiesIndexer, false);
delist(revisionDescriptorStore, false);
throw e;
} catch (Error e) {
delist (propertiesIndexer, false);
delist(revisionDescriptorStore, false);
throw e;
} catch (Throwable t) {
delist (propertiesIndexer, false);
delist(revisionDescriptorStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(revisionDescriptorStore, t);
}
delist (propertiesIndexer);
delist (revisionDescriptorStore);
}
/**
* Update revision descriptor.
*
* @param uri Uri
* @param revisionDescriptor Node revision descriptor
* @exception ServiceAccessException Service access error
* @exception RevisionDescriptorNotFoundException Revision descriptor
* was not found
*/
public void storeRevisionDescriptor
(Uri uri, NodeRevisionDescriptor revisionDescriptor)
throws ServiceAccessException, RevisionDescriptorNotFoundException {
revisionDescriptor.validate();
enlist (propertiesIndexer);
enlist(revisionDescriptorStore);
try {
propertiesIndexer.updateIndex (uri, revisionDescriptor, null);
revisionDescriptorStore.storeRevisionDescriptor
(uri, revisionDescriptor);
revisionDescriptor.resetRemovedProperties();
revisionDescriptor.resetUpdatedProperties();
} catch (ServiceAccessException e) {
delist (propertiesIndexer, false);
delist(revisionDescriptorStore, false);
throw e;
} catch (RevisionDescriptorNotFoundException e) {
delist (propertiesIndexer);
delist(revisionDescriptorStore);
throw e;
} catch (Error e) {
delist (propertiesIndexer, false);
delist(revisionDescriptorStore, false);
throw e;
} catch (Throwable t) {
delist (propertiesIndexer, false);
delist(revisionDescriptorStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(revisionDescriptorStore, t);
}
delist (propertiesIndexer);
delist(revisionDescriptorStore);
}
/**
* Remove revision descriptor.
*
* @param uri Uri
* @param revisionNumber Revision number
* @exception ServiceAccessException Service access error
*/
public void removeRevisionDescriptor (Uri uri, NodeRevisionNumber number)
throws ServiceAccessException
{
number.validate();
enlist(propertiesIndexer);
enlist(revisionDescriptorStore);
try {
propertiesIndexer.dropIndex (uri, number);
revisionDescriptorStore.removeRevisionDescriptor(uri, number);
} catch (ServiceAccessException e) {
delist(propertiesIndexer, false);
delist(revisionDescriptorStore, false);
throw e;
} catch (Error e) {
delist (propertiesIndexer, false);
delist(revisionDescriptorStore, false);
throw e;
} catch (Throwable t) {
delist(propertiesIndexer, false);
delist(revisionDescriptorStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(revisionDescriptorStore, t);
}
delist(propertiesIndexer);
delist(revisionDescriptorStore);
}
/**
* Retrive revision content.
*
* @param uri Uri
* @param revisionDescriptor Node revision descriptor
*/
public NodeRevisionContent retrieveRevisionContent
(Uri uri, NodeRevisionDescriptor revisionDescriptor)
throws ServiceAccessException, RevisionNotFoundException {
NodeRevisionContent revisionContent = null;
if (isForceStoreEnlistment(uri)) {
enlist(contentStore);
try {
revisionContent =
contentStore.retrieveRevisionContent
(uri, revisionDescriptor);
} catch (ServiceAccessException e) {
delist(contentStore, false);
throw e;
} catch (RevisionNotFoundException e) {
// Normal read failures aren't considered fatal
delist(contentStore);
throw e;
} catch (Error e) {
delist(contentStore, false);
throw e;
} catch (Throwable t) {
delist(contentStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(contentStore, t);
}
delist(contentStore);
} else {
try {
revisionContent =
contentStore.retrieveRevisionContent
(uri, revisionDescriptor);
} catch (ServiceAccessException e) {
throw e;
} catch (RevisionNotFoundException e) {
throw e;
} catch (Error e) {
throw e;
} catch (Throwable t) {
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException
(contentStore, t);
}
}
revisionContent.validate();
return revisionContent;
}
/**
* Create a new revision
*
* @param uri Uri
* @param revisionDescriptor Node revision descriptor
* @param revisionContent Node revision content
*/
public void createRevisionContent
(Uri uri, NodeRevisionDescriptor revisionDescriptor,
NodeRevisionContent revisionContent)
throws ServiceAccessException, RevisionAlreadyExistException
{
revisionDescriptor.validate();
revisionContent.validate();
enlist(contentIndexer);
enlist(contentStore);
try {
contentIndexer.createIndex (uri, revisionDescriptor, revisionContent);
contentStore.createRevisionContent(uri, revisionDescriptor,
revisionContent);
} catch (ServiceAccessException e) {
delist(contentIndexer, false);
delist(contentStore, false);
throw e;
} catch (RevisionAlreadyExistException e) {
delist(contentIndexer);
delist(contentStore);
throw e;
} catch (Error e) {
delist(contentIndexer, false);
delist(contentStore, false);
throw e;
} catch (Throwable t) {
delist(contentIndexer, false);
delist(contentStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(contentStore, t);
}
delist(contentIndexer);
delist(contentStore);
}
/**
* Modify the latest revision of an object.
*
* @param uri Uri
* @param revisionDescriptor Node revision descriptor
* @param revisionContent Node revision content
*/
public void storeRevisionContent
(Uri uri, NodeRevisionDescriptor revisionDescriptor,
NodeRevisionContent revisionContent)
throws ServiceAccessException, RevisionNotFoundException {
revisionDescriptor.validate();
revisionContent.validate();
enlist (contentIndexer);
enlist(contentStore);
try {
contentIndexer.updateIndex (uri, revisionDescriptor, revisionContent);
contentStore.storeRevisionContent(uri, revisionDescriptor,
revisionContent);
} catch (ServiceAccessException e) {
delist (contentIndexer, false);
delist (contentStore, false);
throw e;
} catch (RevisionNotFoundException e) {
delist(contentIndexer);
delist(contentStore);
throw e;
} catch (Error e) {
delist(contentIndexer, false);
delist(contentStore, false);
throw e;
} catch (Throwable t) {
delist(contentIndexer, false);
delist(contentStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException (contentStore, t);
}
delist(contentIndexer);
delist(contentStore);
}
/**
* Remove revision.
*
* @param uri Uri
* @param revisionDescriptor Node revision descriptor
*/
public void removeRevisionContent
(Uri uri, NodeRevisionDescriptor revisionDescriptor)
throws ServiceAccessException {
revisionDescriptor.validate();
enlist(contentIndexer);
enlist(contentStore);
try {
contentIndexer.dropIndex (uri, revisionDescriptor.getRevisionNumber());
contentStore.removeRevisionContent(uri, revisionDescriptor);
} catch (ServiceAccessException e) {
delist(contentIndexer, false);
delist(contentStore, false);
throw e;
} catch (Error e) {
delist(contentIndexer, false);
delist(contentStore, false);
throw e;
} catch (Throwable t) {
delist(contentIndexer, false);
delist(contentStore, false);
// Wrap everything else in a ServiceAccessException
throw new ServiceAccessException(contentStore, t);
}
delist(contentIndexer);
delist(contentStore);
}
public void createPropertiesIndex(Uri uri, NodeRevisionDescriptor revisionDescriptor,
NodeRevisionContent revisionContent) throws ServiceAccessException, IndexException
{
enlist(propertiesIndexer);
try {
propertiesIndexer.createIndex(uri, revisionDescriptor, revisionContent);
} finally {
delist(propertiesIndexer);
}
}
public void createContentIndex(Uri uri, NodeRevisionDescriptor revisionDescriptor,
NodeRevisionContent revisionContent) throws ServiceAccessException, IndexException
{
enlist(contentIndexer);
try {
contentIndexer.createIndex(uri, revisionDescriptor, revisionContent);
} finally {
delist(contentIndexer);
}
}
// ------------------------------------------------------ Protected Methods
/**
* Return true if the store should also be enlisted for a read operation.
*/
protected boolean isForceStoreEnlistment(Uri uri) {
SlideToken token = uri.getToken();
if (token == null)
return false;
return token.isForceStoreEnlistment();
}
/**
* Add a new resource manager.
*
* @param service New resource manager
*/
protected void addResourceManager(Service service) {
if (service == null)
return;
// First check if the new store isn't already in the array
for (int i = 0; i < resourceManagers.length; i++) {
try {
if (resourceManagers[i].isSameRM(service))
return;
} catch (XAException e) {
}
}
Service results[] = new Service[resourceManagers.length + 1];
System.arraycopy(resourceManagers, 0, results, 0,
resourceManagers.length);
results[resourceManagers.length] = service;
resourceManagers = results;
}
/**
* Enlist the resource manager in the current transaction.
*/
protected void enlist()
throws ServiceAccessException {
enlist(this);
}
/**
* Enlist the resource manager in the current transaction.
*/
protected void enlist(Service service)
throws ServiceAccessException {
// Note: No exception is thrown
boolean enlisted = false;
// FIXME : Enhance retries.
int nbTry = 0;
while ((!enlisted) && (nbTry++ < 20)) {
Transaction transaction = null;
try {
transaction =
namespace.getTransactionManager().getTransaction();
} catch (Exception e) {
}
if (transaction == null) {
getLogger().log("WARNING: No active transaction", Logger.WARNING);
return;
}
try {
enlisted = transaction.enlistResource(service);
} catch (Exception e) {
// Something went wrong.
setRollbackOnly();
throw new ServiceAccessException(this, e);
}
if (!enlisted) {
try {
Thread.sleep(200);
} catch (InterruptedException e) {
// Then go on.
}
}
}
if (!enlisted) {
String exMessage = Messages.format
(AbstractStore.class.getName() + ".enlistFail", service);
setRollbackOnly();
throw new ServiceAccessException(this, exMessage);
}
if (getLogger().isEnabled(LOG_CHANNEL, Logger.DEBUG)) {
String logMessage = Messages.format
(AbstractStore.class.getName() + ".enlist", service);
getLogger().log(logMessage, LOG_CHANNEL, Logger.DEBUG);
}
}
/**
* Delist (suspend) the resource manager in the current transaction.
*/
protected void delist(boolean success)
throws ServiceAccessException {
delist(this, success);
}
/**
* Delist (suspend) the resource manager in the current transaction.
*/
protected void delist(Service service)
throws ServiceAccessException {
delist(service, true);
}
/**
* Delist (suspend) the resource manager in the current transaction.
*/
protected void delist(Service service, boolean success)
throws ServiceAccessException {
try {
Transaction transaction =
namespace.getTransactionManager().getTransaction();
if (transaction == null)
return;
if (success) {
transaction.delistResource(service, TMSUSPEND);
if (getLogger().isEnabled(LOG_CHANNEL, Logger.DEBUG)) {
String logMessage = Messages.format
(AbstractStore.class.getName() + ".delist", service);
getLogger().log(logMessage, LOG_CHANNEL, Logger.DEBUG);
}
} else {
transaction.delistResource(service, TMFAIL);
String logMessage = Messages.format
(AbstractStore.class.getName() + ".delistFail", service);
if (getLogger().isEnabled(Logger.DEBUG)) {
getLogger().log(logMessage, LOG_CHANNEL, Logger.DEBUG);
}
}
} catch (Exception e) {
// Something went wrong.
throw new ServiceAccessException(this, e);
}
}
/**
* Mark transaction as rollback in case of enlistment failure.
*/
protected void setRollbackOnly() {
try {
Transaction transaction =
namespace.getTransactionManager().getTransaction();
if (transaction == null)
return;
transaction.setRollbackOnly();
} catch (Exception e) {
}
}
/**
* Always returns false. Default implementation for this method
* Stores that support binding should override this method.
*/
public boolean useBinding() {
return false;
}
}
The table below shows all metrics for AbstractStore.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 287.00 | Number of blocks | |
| BLOCK_COMMENT | 22.00 | Number of block comment lines | |
| COMMENTS | 514.00 | Comment lines | |
| COMMENT_DENSITY | 0.55 | Comment density | |
| COMPARISONS | 54.00 | Number of comparison operators | |
| CYCLOMATIC | 243.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 95.00 | Comments in declarations | |
| DOC_COMMENT | 436.00 | Number of javadoc comment lines | |
| ELOC | 927.00 | Effective lines of code | |
| EXEC_COMMENTS | 42.00 | Comments in executable code | |
| EXITS | 91.00 | Procedure exits | |
| FUNCTIONS | 76.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 87.84 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 289.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 | 1.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 | 1.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 | 6.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 | 6.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 | 2.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 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 1.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 | 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 | 6.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 1.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 14.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 2.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 27.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 2.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 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 22.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 31.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 | 66.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 62.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 | 0.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 | 9.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 | 1822.00 | Number of lines in the source file | |
| LINE_COMMENT | 56.00 | Number of line comments | |
| LOC | 1089.00 | Lines of code | |
| LOGICAL_LINES | 551.00 | Number of statements | |
| LOOPS | 10.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 2005.00 | Number of operands | |
| OPERATORS | 4026.00 | Number of operators | |
| PARAMS | 96.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 6031.00 | Halstead program length | |
| PROGRAM_VOCAB | 571.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 193.00 | Number of return points from functions | |
| SIZE | 59685.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 525.00 | Number of unique operands | |