UriHandler.java

Index Score
org.apache.slide.webdav.util
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.

MetricDescription
RETURNSNumber of return points from functions
JAVA0034JAVA0034 Missing braces in if statement
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
INTERFACE_COMPLEXITYInterface complexity
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
SIZESize of the file in bytes
JAVA0115JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
DECL_COMMENTSComments in declarations
CYCLOMATICCyclomatic complexity
COMPARISONSNumber of comparison operators
LOGICAL_LINESNumber of statements
OPERATORSNumber of operators
BLOCKSNumber of blocks
PROGRAM_LENGTHHalstead program length
ELOCEffective lines of code
OPERANDSNumber of operands
LOCLines of code
LOOPSNumber of loops
LINESNumber of lines in the source file
EXITSProcedure exits
JAVA0035JAVA0035 Missing braces in for statement
UNIQUE_OPERANDSNumber of unique operands
PROGRAM_VOCABHalstead program vocabulary
FUNCTIONSNumber of function declarations
DOC_COMMENTNumber of javadoc comment lines
COMMENTSComment lines
JAVA0049JAVA0049 Nested block at depth N (maximum: M)
EXEC_COMMENTSComments in executable code
LINE_COMMENTNumber of line comments
JAVA0067JAVA0067 Array descriptor on identifier name
JAVA0163JAVA0163 Empty statement
UNIQUE_OPERATORSNumber of unique operators
JAVA0117JAVA0117 Missing javadoc: method 'method'
JAVA0008JAVA0008 Empty catch block
NEST_DEPTHMaximum nesting depth
PROGRAM_VOLUMEHalstead program volume
JAVA0136JAVA0136 N methods defined in class (maximum: M)
JAVA0126JAVA0126 Method declares unchecked exception in throws
JAVA0076JAVA0076 Use of magic number
WHITESPACENumber of whitespace lines
PARAMSNumber of formal parameter declarations
JAVA0254JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0130JAVA0130 Non-static method does not use instance fields
JAVA0270JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0145JAVA0145 Tab character used in source file
/* * $Header$ * $Revision: 208550 $ * $Date: 2005-02-28 12:27:09 -0500 (Mon, 28 Feb 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.webdav.util; import java.io.Serializable; import java.util.HashMap; import java.util.HashSet; import java.util.Iterator; import java.util.Map; import java.util.Set; import java.util.StringTokenizer; import net.sf.ehcache.Cache; import net.sf.ehcache.CacheException; import net.sf.ehcache.CacheManager; import net.sf.ehcache.Element; import org.apache.slide.common.Domain; import org.apache.slide.common.NamespaceAccessToken; import org.apache.slide.common.ServiceAccessException; import org.apache.slide.common.SlideToken; import org.apache.slide.content.Content; import org.apache.slide.content.NodeProperty; 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.event.VetoException; import org.apache.slide.lock.ObjectLockedException; import org.apache.slide.security.AccessDeniedException; import org.apache.slide.structure.LinkedObjectNotFoundException; import org.apache.slide.structure.ObjectAlreadyExistsException; import org.apache.slide.structure.ObjectNotFoundException; import org.apache.slide.structure.Structure; import org.apache.slide.structure.SubjectNode; /** * Helper class for the handling of URIs */ public class UriHandler implements DeltavConstants, AclConstants, DaslConstants, Serializable { /** * Determines whether the hack that restricts the size of collections in * the history collection is configured to be used. */ protected static boolean useHistoryCollectionHack = false; /** * Sets whether the hack that restricts the size of collections in * the history collection is configured to be used. */ public static void setGloballyUseHistoryCollectionHack(boolean useHistoryCollectionHack) { // XXX it is truely ugly to do things this way, it would be better to have an Uri factory // that gets initialized with this value UriHandler.useHistoryCollectionHack = useHistoryCollectionHack; } private static Cache instanceCache; static { try { CacheManager manager = CacheManager.create(); instanceCache = new Cache( "org.apache.slide.webdav.util.UriHandler", 256, false, false, 0, 0); manager.addCache(instanceCache); } catch (CacheException e) { Domain.error("Can't create UrlHandler instance cache.", e); } } /** * Factory method. */ public static UriHandler getUriHandler( String resourcePath ) { Element element = null; try { element = instanceCache.get(resourcePath); } catch (CacheException e) { Domain.error("Error while reading from UriHandler instance cache.", e); } if (element != null) { return (UriHandler)element.getValue(); } else { UriHandler handler = new UriHandler( resourcePath ); instanceCache.put(new Element(resourcePath, handler)); return handler; } } /** * Factory method. */ public static UriHandler getUriHandler( NodeRevisionDescriptors nrds, NodeRevisionDescriptor nrd ) { String uri = nrds.getUri(); UriHandler uriHandler = UriHandler.getUriHandler( uri ); if ( ! uriHandler.isHistoryUri() ) { // any resource return uriHandler; } else { if( (NodeRevisionNumber.HIDDEN_0_0).equals(nrd.getRevisionNumber()) ) { // history resource return uriHandler; } else { StringBuffer b = new StringBuffer(); // version resource b.append( uri ); if( !uri.endsWith("/") ) { b.append( "/" ); } b.append( nrd.getRevisionNumber().toString() ); return UriHandler.getUriHandler( b.toString() ); } } } /** * Generates the next available history URI and returns an URI handler for it. * @param sToken the Slide token * @param nsaToken the namespace access token * @param uh the URI handler of the resource being set under version control */ public static UriHandler createNextHistoryUri( SlideToken sToken, NamespaceAccessToken nsaToken, UriHandler uh ) throws ObjectNotFoundException, AccessDeniedException, ObjectLockedException, LinkedObjectNotFoundException, ServiceAccessException, RevisionDescriptorNotFoundException, RevisionNotFoundException, VetoException { UriHandler result = null; String nsName = nsaToken.getName(); UriHandler hpathHandler = HistoryPathHandler.getResolvedHistoryPathHandler( nsName, uh ); Content content = nsaToken.getContentHelper(); String hpath = hpathHandler.toString(); Structure structure = nsaToken.getStructureHelper(); String uniqueUri = structure.generateUniqueUri(sToken, hpath); if (uniqueUri != null) { if (UriHandler.useHistoryCollectionHack) { // XXX this is a bit silly: first compose it, now analyze it... String nextHnStr = uniqueUri.substring(uniqueUri.lastIndexOf('/') + 1); // XXX start with (at least) 10 to // assure no resources are created directly in history folder long nextHnLong = Long.parseLong(nextHnStr) + 10; nextHnStr = String.valueOf(nextHnLong); // make hpath/1/2/3 out of 1234 StringBuffer pathBuffer = new StringBuffer(hpath); for (int i = 0; i < nextHnStr.length() - 1; i++) { pathBuffer.append('/'); pathBuffer.append(nextHnStr.charAt(i)); // as we have no information how this number may look like we will have to assure the full // path is created String dir = pathBuffer.toString(); try { structure.retrieve(sToken, dir); } catch (ObjectNotFoundException onfe) { try { structure.create(sToken, new SubjectNode(), dir); content.create(sToken, dir, new NodeRevisionDescriptor(0), null); } catch (ObjectAlreadyExistsException oae) { Domain.warn("Object " + dir + " already exists."); } catch (RevisionAlreadyExistException rae) { Domain.warn("Revision " + dir + " already exists."); } } } // make hpath/1/2/3/h4 out of 1234 pathBuffer.append("/h").append(nextHnStr.charAt(nextHnStr.length() - 1)); String fullPath = pathBuffer.toString(); return UriHandler.getUriHandler(fullPath); } else { return UriHandler.getUriHandler(uniqueUri); } } else { NodeRevisionDescriptors hpathNrds = content.retrieve(sToken, hpath); NodeRevisionDescriptor hpathNrd = content.retrieve(sToken, hpathNrds); NodeProperty nextHnProp = hpathNrd.getProperty(PN_NEXT_HISTORY_NAME); if (UriHandler.useHistoryCollectionHack) { if (nextHnProp == null || nextHnProp.getValue() == null) { // XXX start with historyCollectionHackChildren to assure no // resources are created directly in history folder nextHnProp = new NodeProperty(PN_NEXT_HISTORY_NAME, "10", true); // protected hpathNrd.setProperty(nextHnProp); } String nextHnStr = (String) nextHnProp.getValue(); long nextHnLong = Long.parseLong(nextHnStr); if (nextHnLong % 10 == 0) { // create parent collection long dirNum = nextHnLong / 10; char dirChar[] = Long.toString(dirNum).toCharArray(); StringBuffer buf = new StringBuffer(); for (int i = 0; i < dirChar.length - 1; i++) { buf.append(dirChar[i]); buf.append('/'); } buf.append(dirChar[dirChar.length - 1]); String dirPath = hpath + "/" + buf.toString(); try { structure.create(sToken, new SubjectNode(), dirPath); //content.create(sToken,dirPath,true); //NodeRevisionDescriptors dnrds = // structure.retrieve(stoken,dirPath); content.create(sToken, dirPath, new NodeRevisionDescriptor(0), null); } catch (ObjectAlreadyExistsException oae) { Domain.warn("Object " + dirPath + " already exists."); } catch (RevisionAlreadyExistException rae) { Domain.warn("Revision " + dirPath + " already exists."); } } StringBuffer buf = new StringBuffer(); char nextHnChar[] = nextHnStr.toCharArray(); for (int i = 0; i < nextHnChar.length - 1; i++) { buf.append(nextHnChar[i]); buf.append('/'); } buf.append('h'); buf.append(nextHnChar[nextHnChar.length - 1]); result = UriHandler.getUriHandler(hpath + "/" + buf.toString()); nextHnProp = new NodeProperty(PN_NEXT_HISTORY_NAME, String.valueOf(nextHnLong + 1)); hpathNrd.setProperty(nextHnProp); } else { if (nextHnProp == null) { // convert to slide namespace if this property is still // in DAV: namespace nextHnProp = hpathNrd.getProperty(PN_NEXT_HISTORY_NAME_COMP); if (nextHnProp != null) { hpathNrd.removeProperty(nextHnProp); nextHnProp = new NodeProperty(PN_NEXT_HISTORY_NAME, nextHnProp.getValue(), true); // protected hpathNrd.setProperty(nextHnProp); } } if (nextHnProp == null || nextHnProp.getValue() == null) { nextHnProp = new NodeProperty(PN_NEXT_HISTORY_NAME, I_INITIAL_HISTORY_NAME, true); // protected hpathNrd.setProperty(nextHnProp); } String nextHnStr = (String) nextHnProp.getValue(); result = UriHandler.getUriHandler(hpath + "/" + nextHnStr); long nextHnLong = Long.parseLong(nextHnStr); nextHnProp = new NodeProperty(PN_NEXT_HISTORY_NAME, String.valueOf(nextHnLong + 1)); hpathNrd.setProperty(nextHnProp); } content.store(sToken, hpath, hpathNrd, null); //revisionContent = null return result; } } /** * Generates the next available workingresource URI and returns an URI handler for it. * @param sToken the Slide token * @param nsaToken the namespace access token * @param uh the URI handler of the version resource being checked-out */ public static UriHandler createNextWorkingresourceUri( SlideToken sToken, NamespaceAccessToken nsaToken, UriHandler uh ) throws ObjectNotFoundException, AccessDeniedException, ObjectLockedException, LinkedObjectNotFoundException, ServiceAccessException, RevisionDescriptorNotFoundException, RevisionNotFoundException, VetoException { UriHandler result = null; String nsName = nsaToken.getName(); UriHandler wrpathHandler = WorkingresourcePathHandler.getResolvedWorkingresourcePathHandler( nsName, uh ); Content content = nsaToken.getContentHelper(); String wrpath = wrpathHandler.toString(); Structure structure = nsaToken.getStructureHelper(); String uniqueUri = structure.generateUniqueUri(sToken, wrpath); if (uniqueUri != null) { result = UriHandler.getUriHandler(uniqueUri); } else { NodeRevisionDescriptors wrpathNrds = content.retrieve( sToken, wrpath ); NodeRevisionDescriptor wrpathNrd = content.retrieve( sToken, wrpathNrds ); NodeProperty nextWrnProp = wrpathNrd.getProperty(PN_NEXT_WORKINGRESOURCE_NAME); if (nextWrnProp == null) { // convert to slide namespace if this property is still // in DAV: namespace nextWrnProp = wrpathNrd.getProperty(PN_NEXT_WORKINGRESOURCE_NAME_COMP); if (nextWrnProp != null) { wrpathNrd.removeProperty(nextWrnProp); nextWrnProp = new NodeProperty(PN_NEXT_WORKINGRESOURCE_NAME, nextWrnProp.getValue(), true); // protected wrpathNrd.setProperty( nextWrnProp ); } } if( nextWrnProp == null || nextWrnProp.getValue() == null ) { nextWrnProp = new NodeProperty(PN_NEXT_WORKINGRESOURCE_NAME, I_INITIAL_WORKINGRESOURCE_NAME, true); // protected wrpathNrd.setProperty( nextWrnProp ); } String nextWrnStr = (String)nextWrnProp.getValue(); result = UriHandler.getUriHandler( wrpath+"/"+nextWrnStr ); long nextWrnLong = Long.parseLong( nextWrnStr ); nextWrnProp = new NodeProperty(PN_NEXT_WORKINGRESOURCE_NAME, String.valueOf(nextWrnLong + 1)); wrpathNrd.setProperty( nextWrnProp ); content.store( sToken, wrpath, wrpathNrd, null ); //revisionContent = null } return result; } /** * Creates a VR URI for the specified version in the specified history and * returns an URI handler for it. */ public static UriHandler createVersionUri( UriHandler vhrUri, String version ) { return new UriHandler( vhrUri, version ); } /** * Registerd stores: namespaceName -> (scope -> store) */ protected static Map registeredStores = new HashMap(); protected static Set allScopes = new HashSet(); protected static Set allStoreNames = new HashSet(); /** * Called when a Namespace registers a Store */ public static void notifyStoreCreated( String namespaceName, String scope, String storeName ) { Map storesInNamespace = (Map)registeredStores.get( namespaceName ); if( storesInNamespace == null ) { storesInNamespace = new HashMap(); registeredStores.put( namespaceName, storesInNamespace ); } UriHandler scopeUh = UriHandler.getUriHandler(scope); storesInNamespace.put( scopeUh, storeName ); allScopes.add( scopeUh ); allStoreNames.add( storeName ); } /** * Return the best matching scope for the specified URI in the specified namespace */ protected static UriHandler bestMatchingScope( String namespaceName, UriHandler uh ) { UriHandler result = null; Map storesInNamespace = (Map)registeredStores.get( namespaceName ); Iterator i = storesInNamespace.keySet().iterator(); int matchSize = 0; while( i.hasNext() ) { UriHandler scopeUh = (UriHandler)i.next(); if( scopeUh.isAncestorOf(uh) && scopeUh.length() > matchSize ) { matchSize = scopeUh.length(); result = scopeUh; } } return result; } private String uri; private String[] uriTokens = null; private UriHandler parentUriHandler = null; /** * Protected constructor */ protected UriHandler( String uri ) { this.uri = uri; StringTokenizer t = new StringTokenizer( uri, "/" ); int n = t.countTokens(); this.uriTokens = new String[n]; for( int i = 0; i < n; i++ ) uriTokens[i] = t.nextToken(); } /** * Protected constructor */ protected UriHandler( String[] uriTokens, int number ) { String[] t = new String[number]; for( int i = 0; i < number; i++ ) t[i] = uriTokens[i]; this.uriTokens = t; } /** * Protected constructor for VR URIs */ protected UriHandler( UriHandler vhrUri, String versionName ) { int n = vhrUri.length(); this.uriTokens = new String[n + 1]; for( int i = 0; i < n; i++ ) uriTokens[i] = vhrUri.uriTokens[i]; uriTokens[n] = versionName; } /** * Get the URI as string */ public String getUri() { if( uri == null ) uri = toString(); return uri; } /** * Get the name (last token) */ public String getName() { if( uriTokens.length == 0 ) return null; return uriTokens[uriTokens.length - 1]; } /** * Get the UriHandler for the parent URI, null if this URI is root. */ public UriHandler getParentUriHandler() { if( uriTokens.length == 0 ) return null; if (this.parentUriHandler == null) { this.parentUriHandler = new UriHandler( uriTokens, uriTokens.length - 1 ); } return this.parentUriHandler; } /** * Return true, if this handler's tokens are the initial tokens of the specified handler. * Example: /a/b is ancestor of /a/b/x/y/z */ public boolean isAncestorOf( UriHandler uh ) { if( uriTokens.length > uh.length() ) return false; String[] otherTokens = uh.getUriTokens(); for( int i = 0; i < uriTokens.length; i++ ) { if( !uriTokens[i].equals(otherTokens[i]) ) return false; } return true; } /** * Get the tokens */ public String[] getUriTokens() { return uriTokens; } /** * Return true, if this URI determines the root. */ public boolean isRootUri() { return (uriTokens.length == 0); } /** * Return true, if this URI determines the history path. */ public boolean isHistoryPathUri() { HistoryPathHandler hpathHandler = HistoryPathHandler.getHistoryPathHandler(); return hpathHandler.isHistoryPathUri( this ); } /** * Return true, if this is a history URI */ public boolean isHistoryUri() { HistoryPathHandler hpathHandler = HistoryPathHandler.getHistoryPathHandler(); if (UriHandler.useHistoryCollectionHack) { if (hpathHandler.isAncestorOf(this)) { String[] hpathTokens = hpathHandler.getUriTokens(); if (uriTokens.length < hpathTokens.length + 1) { return false; } String h = uriTokens[uriTokens.length - 1]; return (h.charAt(0) == 'h'); } else { return false; } } else { String[] hpathTokens = hpathHandler.getUriTokens(); if ((hpathTokens.length + 1) == uriTokens.length) { if (hpathHandler.isHistoryPathUri(getParentUriHandler())) { try { Integer.parseInt(uriTokens[uriTokens.length - 1]); return true; } catch (NumberFormatException x) { } } } return false; } } /** * Return true, if this is a version URI */ public boolean isVersionUri() { HistoryPathHandler hpathHandler = HistoryPathHandler.getHistoryPathHandler(); if (UriHandler.useHistoryCollectionHack) { /* * Version Uris look like /my/history/path/1/2/3/h9/1.0 */ if (hpathHandler.isAncestorOf(this)) { String[] hpathTokens = hpathHandler.getUriTokens(); if (uriTokens.length < hpathTokens.length + 2) { return false; } String h = uriTokens[uriTokens.length - 2]; return (h.charAt(0) == 'h'); } else { return false; } } else { String[] hpathTokens = hpathHandler.getUriTokens(); if ((hpathTokens.length + 2) == uriTokens.length) { if (getParentUriHandler().isHistoryUri()) return true; } return false; } } /** * Returns <code>true</code> if this is a collection below the history path, * but not a history. This is relevant only with the HistoryCollectionHack * where we have collections like this: /my/history/path/1/2, that are not * histories of versions. */ public boolean isHistoryCollectionUri() { HistoryPathHandler hpathHandler = HistoryPathHandler.getHistoryPathHandler(); if (UriHandler.useHistoryCollectionHack) { return hpathHandler.isAncestorOf(this) && !isHistoryUri() && !isVersionUri(); } else { return false; } } /** * Returns <code>true</code> if this is any uri below the history path. */ public boolean isHistoryRelatedUri() { HistoryPathHandler hpathHandler = HistoryPathHandler.getHistoryPathHandler(); return hpathHandler.isAncestorOf(this); } /** * Return true, if this URI determines the workspace path. */ public boolean isWorkspacePathUri() { WorkspacePathHandler wspathHandler = WorkspacePathHandler.getWorkspacePathHandler(); return wspathHandler.isWorkspacePathUri( this ); } /** * Return true, if this is a valid workspace URI */ public boolean isWorkspaceUri() { WorkspacePathHandler wspathHandler = WorkspacePathHandler.getWorkspacePathHandler(); String[] wspathTokens = wspathHandler.getUriTokens(); if( (wspathTokens.length + 1) == uriTokens.length ) { if( wspathHandler.isWorkspacePathUri(getParentUriHandler()) ) { return true; } } return false; } /** * Return true, if this is an URI of a resource in a workspace */ public boolean isResourceInWorkspaceUri() { WorkspacePathHandler wspathHandler = WorkspacePathHandler.getWorkspacePathHandler(); String[] wspathTokens = wspathHandler.getUriTokens(); if( (wspathTokens.length + 1) < uriTokens.length ) { UriHandler p = new UriHandler( uriTokens, wspathTokens.length + 1 ); if( p.isWorkspaceUri() ) { return true; } } return false; } /** * Return true, if this URI determines the workingresource path. */ public boolean isWorkingresourcePathUri() { WorkingresourcePathHandler wrpathHandler = WorkingresourcePathHandler.getWorkingresourcePathHandler(); return wrpathHandler.isWorkingresourcePathUri( this ); } /** * Return true, if this is a valid workingresource URI */ public boolean isWorkingresourceUri() { WorkingresourcePathHandler wrpathHandler = WorkingresourcePathHandler.getWorkingresourcePathHandler(); String[] wrpathTokens = wrpathHandler.getUriTokens(); if( (wrpathTokens.length + 1) == uriTokens.length ) { if( wrpathHandler.isWorkingresourcePathUri(getParentUriHandler()) ) { try { Integer.parseInt( uriTokens[uriTokens.length - 1] ); return true; } catch( NumberFormatException x ) {}; } } return false; } /** * Returns the workspace identifier from the uri * @pre isWorkspaceUri() */ public String getWorkspaceName() { UriHandler wspathHandler = WorkspacePathHandler.getWorkspacePathHandler(); String[] wspathTokens = wspathHandler.getUriTokens(); if( !isWorkspaceUri() ) throw new IllegalStateException( "URI "+uri+" is not a workspace URI" ); return uriTokens[wspathTokens.length]; } /** * Returns the history identifier from the uri * @pre isHistoryUri() || isVersionUri() */ public String getHistoryName() { UriHandler hpathHandler = HistoryPathHandler.getHistoryPathHandler(); String[] hpathTokens = hpathHandler.getUriTokens(); if (UriHandler.useHistoryCollectionHack) { if (isHistoryUri()) { return getName(); } else if (isVersionUri()) { return uriTokens[uriTokens.length - 2]; } else { throw new IllegalStateException("URI " + toString() + " is neither history nor version URI"); } } else { if (!isHistoryUri() && !isVersionUri()) throw new IllegalStateException("URI " + uri + " is neither history nor version URI"); return uriTokens[hpathTokens.length]; } } /** * Returns the version name from the uri * * @pre isVersionUri() */ public String getVersionName() { if (!isVersionUri()) throw new IllegalStateException("URI " + uri + " is not a version URI"); if (UriHandler.useHistoryCollectionHack) { return getName(); } else { UriHandler hpathHandler = HistoryPathHandler.getHistoryPathHandler(); String[] hpathTokens = hpathHandler.getUriTokens(); return uriTokens[hpathTokens.length + 1]; } } /** * Returns the associated history URI of this version URI * * @pre isVersionUri() */ public String getAssociatedHistoryUri() { if( !isVersionUri() ) throw new IllegalStateException( "URI "+uri+" is not a version URI" ); StringBuffer b = new StringBuffer(); for( int i = 0; i < (uriTokens.length - 1); i++ ) { b.append( "/" ); b.append( uriTokens[i] ); } return b.toString(); } /** * Returns the associated workspace URI if this URI represents a resource * in a workspace; if the resource is a workspace itself, its own URI is returned. * @return the associated workspace URI; null, if the resource is neither a workspace itself * nor contained in a workspace */ public String getAssociatedWorkspaceUri() { if( !isWorkspaceUri() && !isResourceInWorkspaceUri() ) return null; UriHandler wspathHandler = WorkspacePathHandler.getWorkspacePathHandler(); String[] wspathTokens = wspathHandler.getUriTokens(); StringBuffer b = new StringBuffer(); for( int i = 0; i < (wspathTokens.length + 1); i++ ) { b.append( "/" ); b.append( uriTokens[i] ); } return b.toString(); } /** * Returns the associated <b>base</b> store name. * Examples (assume historyPath is parameterized: /history/${store}): * uri=/history/mycoll/1 ---> result=mycoll // history URI * uri=/history/files/1/1.17 ---> result=files // version URI * uri=/files/foo/bar.xml ---> result=files // best matching scope * If the URI is e.g. a version URI but historyPath is not parameterized, no associated * base store can be determined. * * @return the associated base store name. */ public String getAssociatedBaseStoreName( String namespaceName ) { String result = ""; if( isHistoryPathUri() || isHistoryUri() || isVersionUri() ) { if( HistoryPathHandler.parameterized ) { result = extractStoreName( HistoryPathHandler.historyPathHandler ); } else { Domain.info( "Cannot determine base store name for URI "+this ); } } else if( isWorkspacePathUri() || isWorkspaceUri() || isResourceInWorkspaceUri() ) { if( WorkspacePathHandler.parameterized ) { result = extractStoreName( WorkspacePathHandler.workspacePathHandler ); } else { Domain.info( "Cannot determine base store name for URI "+this ); } } else if( isWorkingresourcePathUri() || isWorkingresourceUri() ) { if( WorkingresourcePathHandler.parameterized ) { result = extractStoreName( WorkingresourcePathHandler.workingresourcePathHandler ); } else { Domain.info( "Cannot determine base store name for URI "+this ); } } else { UriHandler scopeUh = bestMatchingScope( namespaceName, this ); Map storesInNamespace = (Map)registeredStores.get( namespaceName ); result = (String)storesInNamespace.get( scopeUh ); } return result; } /** * Extract the store name from a parameterized path. */ private String extractStoreName( UriHandler pUh ) { String result = ""; String[] pTokens = pUh.getUriTokens(); int ptIndex = -1; for( int i = 0; i < pTokens.length; i++ ) { if( pTokens[i].indexOf(I_STORE_PLACE_HOLDER_IN_PATH) >= 0 ) { ptIndex = i; break; } } if( ptIndex >= 0 ) { result = extractStoreName( pTokens[ptIndex], uriTokens[ptIndex] ); } return result; } /** * Extract the store name from a parameterized path. */ private String extractStoreName( String prmStr, String srcStr ) { String tail = null; int start = prmStr.indexOf( I_STORE_PLACE_HOLDER_IN_PATH ); int endP = start + I_STORE_PLACE_HOLDER_IN_PATH.length(); int endS = -1; if( endP < prmStr.length() ) { tail = prmStr.substring( endP ); endS = srcStr.lastIndexOf( tail ); } else endS = srcStr.length(); return srcStr.substring( start, endS ); } /** * Returns <code>true</code> if the usage of this URI * is restricted by the server, means the server may refuse to * create resource at this URI due to a client request like <code>PUT</code>. * (e.g. an URI that determines a resource in a history folder). * * @return <code>true</code> if the usage of the URI is restricted. */ public boolean isRestrictedUri() { if( isRootUri() ) return true; if( isVersionUri() ) return true; if( isHistoryUri() ) return true; if( isHistoryPathUri() ) return true; if( useHistoryCollectionHack && isHistoryCollectionUri() ) return true; if( isWorkspaceUri() ) return true; if( isWorkspacePathUri() ) return true; if( isWorkingresourceUri() ) return true; if( isWorkingresourcePathUri() ) return true; UriHandler p = getParentUriHandler(); if( p != null ) { if( p.isRootUri() ) return true; if( p.isHistoryPathUri() ) return true; if( p.isWorkingresourcePathUri() ) return true; } return false; } /** * Overwrites Object.equals() */ public boolean equals( Object o ) { if( !(o instanceof UriHandler) ) return false; String[] oTokens = ((UriHandler)o).getUriTokens(); if( oTokens.length != uriTokens.length ) return false; for( int i = 0; i < uriTokens.length; i++ ) if( !oTokens[i].equals(uriTokens[i]) ) return false; return true; } /** * Overwrites Object.hashCode() */ public int hashCode() { return uriTokens.length; } /** * Get the length of this handler. */ public int length() { return uriTokens.length; } /** * Return string representation of the object */ public String toString() { StringBuffer b = new StringBuffer(); if( uriTokens.length == 0 ) b.append("/"); else for( int i = 0; i < uriTokens.length; i++ ) b.append("/").append( uriTokens[i] ); return b.toString(); } }

The table below shows all metrics for UriHandler.java.

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