NamespaceConfig.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.slide.common |
 |
 |
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 |  |
| JAVA0009 | JAVA0009 Protected member in final class | |
| DOC_COMMENT | Number of javadoc comment lines | |
| COMMENTS | Comment lines | |
| RETURNS | Number of return points from functions | |
| SIZE | Size of the file in bytes | |
| LINES | Number of lines in the source file | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| FUNCTIONS | Number of function declarations | |
| BLOCKS | Number of blocks | |
| WHITESPACE | Number of whitespace lines | |
| LOGICAL_LINES | Number of statements | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| CYCLOMATIC | Cyclomatic complexity | |
| OPERANDS | Number of operands | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LOOPS | Number of loops | |
| JAVA0008 | JAVA0008 Empty catch block | |
| PARAMS | Number of formal parameter declarations | |
| EXITS | Procedure exits | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* $Header$
* $Revision: 208193 $
* $Date: 2004-11-24 11:22:45 -0500 (Wed, 24 Nov 2004) $
*
* ====================================================================
*
* 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.common;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Vector;
import org.apache.slide.content.ContentInterceptor;
import org.apache.slide.content.NodeProperty;
import org.apache.slide.structure.ActionNode;
import org.apache.slide.structure.LinkNode;
import org.apache.slide.structure.ObjectNode;
import org.apache.slide.structure.SubjectNode;
import org.apache.slide.util.Messages;
import org.apache.slide.util.conf.Configuration;
import org.apache.slide.util.conf.ConfigurationException;
import org.apache.slide.util.logger.Logger;
/**
* Configuration of the Namespace.
*
* @version $Revision: 208193 $
*/
public final class NamespaceConfig {
// -------------------------------------------------------------- Constants
/**
* Base role names.
*/
public static final String NOBODY = "nobody";
public static final String NOBODY_ROLE = ObjectNode.class.getName();
public static final String BASE_ROLE = SubjectNode.class.getName();
public static final String ACTION_ROLE = ActionNode.class.getName();
public static final String LINK_ROLE = LinkNode.class.getName();
private final static String
ACL_INHERIT_TYPE = "acl_inheritance_type",
NESTED_ROLES_MAXDEPTH = "nested_roles_maxdepth";
private final static int
NESTED_ROLES_MAXDEPTH_DEFAULT = 0;
public final static int
ACL_INHERIT_TYPE_NONE = 0,
ACL_INHERIT_TYPE_ROOT = 1,
ACL_INHERIT_TYPE_PATH = 2,
ACL_INHERIT_TYPE_FULL = 3;
// ----------------------------------------------------- Instance Variables
/**
* Namespace name.
*/
protected String name;
/**
* Read object action.
*/
protected ActionNode readObjectAction;
/**
* Create object action. Equivalent to createChildAction.
*/
protected ActionNode createObjectAction;
/**
* Remove object action.
*/
protected ActionNode removeObjectAction;
/**
* Grant permission action.
*/
protected ActionNode grantPermissionAction;
/**
* Revoke permission action.
*/
protected ActionNode revokePermissionAction;
/**
* Read permissions action.
*/
protected ActionNode readPermissionsAction;
protected ActionNode readOwnPermissionsAction;
/**
* Lock object action.
*/
protected ActionNode lockObjectAction;
/**
* Kill lock action.
*/
protected ActionNode killLockAction;
/**
* Read locks action.
*/
protected ActionNode readLocksAction;
/**
* Create revision metadata action.
*/
protected ActionNode createRevisionMetadataAction;
/**
* Modify revision metadata action.
*/
protected ActionNode modifyRevisionMetadataAction;
/**
* Remove revision metadata action.
*/
protected ActionNode removeRevisionMetadataAction;
/**
* Read revision metadata action.
*/
protected ActionNode readRevisionMetadataAction;
/**
* Read revision content action.
*/
protected ActionNode readRevisionContentAction;
/**
* Create revision content action.
*/
protected ActionNode createRevisionContentAction;
/**
* Modify revision content action.
*/
protected ActionNode modifyRevisionContentAction;
/**
* Remove revision content action.
*/
protected ActionNode removeRevisionContentAction;
/**
* Bind/unbind actions
*/
protected ActionNode bindMemberAction;
protected ActionNode unbindMemberAction;
/**
* Users path.
*/
protected String usersPath = null;
protected String groupsPath = null;
protected String rolesPath = null;
private UriPath
usersUriPath,
groupsUriPath,
rolesUriPath;
/**
* Guest user path.
*/
protected String guestPath;
/**
* File path.
*/
protected String filesPath = null;
/**
* File path.
*/
protected String actionsPath = null;
/**
* Additional parameters.
*/
protected Hashtable parameters;
/**
* Role name -> role interface mappings.
* Note : One name is associated to only one interface.
*/
protected Hashtable roleMappings = new Hashtable();
/**
* Role interface -> role name mappings.
* Note : One interface can be associated to multiple names, in which case
* only one is stored here.
*/
protected Hashtable roleClassMappings = new Hashtable();
/**
* List of default properties.
* Role name -> Vector[NodeProperty].
*/
protected Hashtable defaultProperties;
/**
* Empty vector. Don't add stuff there.
*/
protected static Vector emptyVector = new Vector();
/**
* Content interceptors.
*/
protected ContentInterceptor[] contentInterceptors
= new ContentInterceptor[0];
/**
* Automatically create users.
*/
protected boolean autoCreateUsers = false;
/**
* Roles implementation to be used for automatically created users.
*/
protected String autoCreateUsersRole = "slideroles.basic.UserRoleImpl";
// ------------------------------------------------------------- Properties
/**
* Default action accessor.
*
* @return ActionNode Default action
*/
public ActionNode getDefaultAction() {
return ActionNode.DEFAULT;
}
/**
* Read object action accessor.
*
* @return ActionNode Read object action
*/
public ActionNode getReadObjectAction() {
return readObjectAction;
}
/**
* Create object action accessor.
*
* @return ActionNode Create object action
*/
public ActionNode getCreateObjectAction() {
return createObjectAction;
}
/**
* Remove object accessor.
*
* @return ActionNode Remove object action
*/
public ActionNode getRemoveObjectAction() {
return removeObjectAction;
}
/**
* Grant permission accessor.
*
* @return ActionNode Grant permission action
*/
public ActionNode getGrantPermissionAction() {
return grantPermissionAction;
}
/**
* Revoke permission accessor.
*
* @return ActionNode Revoke permission action
*/
public ActionNode getRevokePermissionAction() {
return revokePermissionAction;
}
/**
* Read permissions accessor.
*
* @return ActionNode Read permissions action
*/
public ActionNode getReadPermissionsAction() {
return readPermissionsAction;
}
public ActionNode getReadOwnPermissionsAction() {
return readOwnPermissionsAction;
}
/**
* Lock object accessor.
*
* @return ActionNode Lock object action
*/
public ActionNode getLockObjectAction() {
return lockObjectAction;
}
/**
* Kill lock accessor.
*
* @return ActionNode Kill lock action
*/
public ActionNode getKillLockAction() {
return killLockAction;
}
/**
* Read locks accessor.
*
* @return ActionNode Read locks action
*/
public ActionNode getReadLocksAction() {
return readLocksAction;
}
/**
* Create revision metadata accessor.
*
* @return ActionNode Create revision metadata action
*/
public ActionNode getCreateRevisionMetadataAction() {
return createRevisionMetadataAction;
}
/**
* Read revision metadata accessor.
*
* @return ActionNode Read revision metadata action
*/
public ActionNode getReadRevisionMetadataAction() {
return readRevisionMetadataAction;
}
/**
* Modify revision metadata accessor.
*
* @return ActionNode Modify revision metadata action
*/
public ActionNode getModifyRevisionMetadataAction() {
return modifyRevisionMetadataAction;
}
/**
* Remove revision metadata accessor.
*
* @return ActionNode Remove revision metadata action
*/
public ActionNode getRemoveRevisionMetadataAction() {
return removeRevisionMetadataAction;
}
/**
* Read revision content accessor.
*
* @return ActionNode Read revision content action
*/
public ActionNode getReadRevisionContentAction() {
return readRevisionContentAction;
}
/**
* Create revision content accessor.
*
* @return ActionNode Create revision content action
*/
public ActionNode getCreateRevisionContentAction() {
return createRevisionContentAction;
}
/**
* Modify revision content accessor.
*
* @return ActionNode Modify revision content action
*/
public ActionNode getModifyRevisionContentAction() {
return modifyRevisionContentAction;
}
/**
* Remove revision content accessor.
*
* @return ActionNode Remove revision content action
*/
public ActionNode getRemoveRevisionContentAction() {
return removeRevisionContentAction;
}
/**
* Method getBindAction
*
* @return an ActionNode
*/
public ActionNode getBindMemberAction() {
return bindMemberAction;
}
public ActionNode getUnbindMemberAction() {
return unbindMemberAction;
}
/**
* Users path accessor.
*
* @return String Users path
*/
public String getUsersPath() {
return usersPath;
}
/**
* Groups path accessor.
*
* @return String Groups path
*/
public String getGroupsPath() {
return groupsPath;
}
/**
* Roles path accessor.
*
* @return String Roles path
*/
public String getRolesPath() {
return rolesPath;
}
/**
* Guest path accessor.
*
* @return String Guest path
* @deprecated There is now a generic SubjectNode for "guest"
*/
public String getGuestPath() {
return guestPath;
}
/**
* Files path accessor.
*
* @return String Files path
*/
public String getFilesPath() {
return filesPath;
}
/**
* Actions path accessor.
*
* @return String Action path
*/
public String getActionsPath() {
return actionsPath;
}
/**
* Get default properties for a given role.
*
* @return Enumeration of properties
*/
public Enumeration getDefaultProperties(String role) {
Vector result = (Vector) defaultProperties.get(role);
if (result == null)
return emptyVector.elements();
else
return result.elements();
}
/**
* Get content interceptors.
*/
ContentInterceptor[] getContentInterceptors() {
return contentInterceptors;
}
// --------------------------------------------------------- Public Methods
/**
* Get parameter value.
*
* @param name Parameter name
* @return String Parameter value
*/
public String getParameter(String name) {
Object result = parameters.get(name);
if (result==null) {
return null;
} else {
return (String) result;
}
}
/**
* Get role mapping. If the interface name is given, one of the names is
* returned. If the name is given, the interface name is returned.
*
* @param name Role name (or interface name)
* @return String Role interface name (or name)
*/
public String getRoleMapping(String name) {
Object result = roleMappings.get(name);
if (result == null) {
return (String) roleClassMappings.get(name);
} else {
return (String) result;
}
}
/**
* Is automcatic user creation active ?
*/
public boolean isAutoCreateUsers() {
return autoCreateUsers;
}
public boolean isPrincipal(String uri) {
return (usersUriPath != null && usersUriPath.isParentOf(uri) ||
rolesUriPath != null && rolesUriPath.isParentOf(uri) ||
groupsUriPath != null && groupsUriPath.isParentOf(uri));
}
public boolean isRole(String uri) {
return (rolesUriPath != null && rolesUriPath.isParentOf(uri));
}
public boolean isGroup(String uri) {
return (groupsUriPath != null && groupsUriPath.isParentOf(uri));
}
/**
* Get the class name of the role which will be used to create nodes which
* are automatically created when isAutoCreateUsers() returns true.
*/
public String getAutoCreateUsersRole() {
return autoCreateUsersRole;
}
public int getAclInheritanceType() {
String aclInheritanceTypeStr = getParameter(ACL_INHERIT_TYPE);
if ("none".equalsIgnoreCase(aclInheritanceTypeStr)) {
return ACL_INHERIT_TYPE_NONE;
}
else if ("root".equalsIgnoreCase(aclInheritanceTypeStr)) {
return ACL_INHERIT_TYPE_ROOT;
}
else if ("path".equalsIgnoreCase(aclInheritanceTypeStr)) {
return ACL_INHERIT_TYPE_PATH;
}
else if ("full".equalsIgnoreCase(aclInheritanceTypeStr)) {
return ACL_INHERIT_TYPE_FULL;
}
else {
return ACL_INHERIT_TYPE_PATH;
}
}
public int getNestedRolesMaxDepth() {
int result = NESTED_ROLES_MAXDEPTH_DEFAULT;
String nestedRolesMaxDepthStr = getParameter(NESTED_ROLES_MAXDEPTH);
try {
result = Integer.parseInt(nestedRolesMaxDepthStr);
}
catch (NumberFormatException e) {}
return result;
}
// -------------------------------------------------------- Package Methods
/**
* Initialize the Namespace configuration using the given Configuration
* object.
*
* @param namespace Namespace on which we are trying to load the config
* @param config Castor Config object
* @exception InvalidNamespaceConfigurationException Namespace
* configuration is invalid
* @exception SlideException One of the action nodes doesn't exist
*/
void initializeNamespaceConfig(Namespace namespace, Configuration config)
throws InvalidNamespaceConfigurationException, SlideException {
name = namespace.getName();
readObjectAction = getConfiguredNode(namespace, config, "read-object");
createObjectAction = getConfiguredNode(namespace, config, "create-object");
removeObjectAction = getConfiguredNode(namespace, config, "remove-object");
grantPermissionAction = getConfiguredNode(namespace, config, "grant-permission");
revokePermissionAction = getConfiguredNode(namespace, config, "revoke-permission");
readPermissionsAction = getConfiguredNode(namespace, config, "read-permissions");
readOwnPermissionsAction = getConfiguredNode(namespace, config, "read-own-permissions");
lockObjectAction = getConfiguredNode(namespace, config, "lock-object");
killLockAction = getConfiguredNode(namespace, config, "kill-lock");
readLocksAction = getConfiguredNode(namespace, config, "read-locks");
readRevisionMetadataAction = getConfiguredNode(namespace, config, "read-revision-metadata");
createRevisionMetadataAction = getConfiguredNode(namespace, config, "create-revision-metadata");
modifyRevisionMetadataAction = getConfiguredNode(namespace, config, "modify-revision-metadata");
removeRevisionMetadataAction = getConfiguredNode(namespace, config, "remove-revision-metadata");
readRevisionContentAction = getConfiguredNode(namespace, config, "read-revision-content");
createRevisionContentAction = getConfiguredNode(namespace, config, "create-revision-content");
modifyRevisionContentAction = getConfiguredNode(namespace, config, "modify-revision-content");
removeRevisionContentAction = getConfiguredNode(namespace, config, "remove-revision-content");
bindMemberAction = getConfiguredNode(namespace, config, "bind-member");
unbindMemberAction = getConfiguredNode(namespace, config, "unbind-member");
setPathsAndConfigValues(config);
setParameters(config, namespace);
setRoles(config, namespace);
setDefaultProperties(config, namespace);
Enumeration contentInteceptorsDef =
config.getConfigurations("content-interceptor");
try {
while (contentInteceptorsDef.hasMoreElements()) {
Configuration contentInterceptorDef =
(Configuration) contentInteceptorsDef.nextElement();
String classname = contentInterceptorDef.getAttribute("class");
// Load contentInterceptor parameters
Enumeration contentInterceptorParametersDef =
contentInterceptorDef.getConfigurations("parameter");
Hashtable contentInterceptorParameters = new Hashtable();
while (contentInterceptorParametersDef.hasMoreElements()) {
Configuration parameterDefinition = (Configuration)
contentInterceptorParametersDef.nextElement();
String parameterName =
parameterDefinition.getAttribute("name");
String parameterValue = parameterDefinition.getValue();
contentInterceptorParameters.put(parameterName,
parameterValue);
}
try {
Class contentInterceptorClass =
Class.forName(classname);
ContentInterceptor contentInterceptor =
(ContentInterceptor)
contentInterceptorClass.newInstance();
contentInterceptor.setParameters(contentInterceptorParameters);
ContentInterceptor[] tempArray =
new ContentInterceptor[contentInterceptors.length + 1];
for (int i = 0; i < contentInterceptors.length; i++) {
tempArray[i] = contentInterceptors[i];
}
tempArray[contentInterceptors.length] = contentInterceptor;
contentInterceptors = tempArray;
} catch (Exception e) {
namespace.getLogger().log
(Messages.format
("org.apache.slide.common.InvalidContentInterceptor",
classname, e.getMessage()), Logger.WARNING);
}
}
// Initialize the content interceptors with the
// NamespaceAccessToken
NamespaceAccessToken nat = new NamespaceAccessTokenImpl(namespace);
ContentInterceptor[] contentInterceptors =
namespace.getContentInterceptors();
for (int i = 0; i < contentInterceptors.length; i++) {
contentInterceptors[i].setNamespace(nat);
}
} catch (ConfigurationException e) {
throw new InvalidNamespaceConfigurationException
(namespace, e.getMessage());
}
}
private void setDefaultProperties(Configuration config, Namespace namespace) throws InvalidNamespaceConfigurationException {
defaultProperties = new Hashtable();
Enumeration defaultPropertiesDef =
config.getConfigurations("default-property");
try {
while (defaultPropertiesDef.hasMoreElements()) {
Configuration defaultProperty =
(Configuration) defaultPropertiesDef.nextElement();
String name = defaultProperty.getAttribute("name");
String value = defaultProperty.getAttribute("value", "");
String propertyNamespace = defaultProperty.getAttribute
("namespace", NodeProperty.DEFAULT_NAMESPACE);
String role = defaultProperty.getAttribute("role");
addDefaultProperty(role, name, value, propertyNamespace);
}
} catch (ConfigurationException e) {
throw new InvalidNamespaceConfigurationException
(namespace, e.getMessage());
}
}
private void setParameters(Configuration config, Namespace namespace) throws InvalidNamespaceConfigurationException {
parameters = new Hashtable();
Enumeration parametersDef = config.getConfigurations("parameter");
try {
while (parametersDef.hasMoreElements()) {
Configuration parameter =
(Configuration) parametersDef.nextElement();
addParameter(parameter.getAttribute("name"),
parameter.getValue());
}
} catch (ConfigurationException e) {
throw new InvalidNamespaceConfigurationException
(namespace, e.getMessage());
}
}
private ActionNode getConfiguredNode(Namespace namespace, Configuration config, String nodeName) throws SlideException {
ActionNode result = null;
try {
result = getActionNode(namespace, config.getConfiguration( nodeName).getValue());
} catch (ConfigurationException e) {
result = getDefaultAction();
}
return result;
}
private void setPathsAndConfigValues(Configuration config) {
try {
usersPath = config.getConfiguration("userspath").getValue();
usersUriPath = new UriPath(usersPath);
} catch (ConfigurationException e) {
usersPath = "";
}
try {
groupsPath = config.getConfiguration("groupspath").getValue();
groupsUriPath = new UriPath(groupsPath);
} catch (ConfigurationException e) {
groupsPath = "";
}
try {
rolesPath = config.getConfiguration("rolespath").getValue();
rolesUriPath = new UriPath(rolesPath);
} catch (ConfigurationException e) {
rolesPath = "";
}
try {
guestPath = config.getConfiguration("guestpath").getValue();
} catch (ConfigurationException e) {
guestPath = "";
}
try {
filesPath = config.getConfiguration("filespath").getValue();
} catch (ConfigurationException e) {
filesPath = "";
}
try {
actionsPath = config.getConfiguration("actionspath").getValue();
} catch (ConfigurationException e) {
actionsPath = "";
}
try {
autoCreateUsers = Boolean.valueOf
(config.getConfiguration("auto-create-users").getValue())
.booleanValue();
} catch (ConfigurationException e) {
autoCreateUsers = false;
}
try {
autoCreateUsersRole =
config.getConfiguration("auto-create-users-role").getValue();
} catch (ConfigurationException e) {
}
}
/**
* Initialize the Namespace configuration using the given Configuration
* object.
*
* @param namespace Namespace on which we are trying to load the config
* @param config Castor Config object
* @exception InvalidNamespaceConfigurationException Namespace
* configuration is invalid
* @exception SlideException One of the action nodes doesn't exist
*/
void initializeNamespaceParameters
(Namespace namespace, Configuration config)
throws InvalidNamespaceConfigurationException, SlideException {
setParameters(config, namespace);
setPathsAndConfigValues(config);
setRoles(config, namespace);
setDefaultProperties(config, namespace);
}
private void setRoles(Configuration config, Namespace namespace) throws InvalidNamespaceConfigurationException {
// Add basic role mappings
addRoleMapping(NOBODY, NOBODY_ROLE);
addRoleMapping(NOBODY, LINK_ROLE);
addRoleMapping(NOBODY, ACTION_ROLE);
// Note : the base role should be the last one.
addRoleMapping(NOBODY, BASE_ROLE);
Enumeration roleMappingsDef = config.getConfigurations("role");
try {
while (roleMappingsDef.hasMoreElements()) {
Configuration roleMappingDef =
(Configuration) roleMappingsDef.nextElement();
addRoleMapping(roleMappingDef.getAttribute("name"),
roleMappingDef.getValue());
}
} catch (ConfigurationException e) {
throw new InvalidNamespaceConfigurationException
(namespace, e.getMessage());
}
}
/**
* Create a dummy config, used to create the base namespace data.
*
* @param namespace Namespace
* @exception InvalidNamespaceConfigurationException Namespace
* configuration is invalid
*/
void initializeAsDummyConfig(Namespace namespace)
throws InvalidNamespaceConfigurationException {
name = namespace.getName();
try {
readObjectAction = getDefaultAction();
createObjectAction = getDefaultAction();
removeObjectAction = getDefaultAction();
grantPermissionAction = getDefaultAction();
revokePermissionAction = getDefaultAction();
readPermissionsAction = getDefaultAction();
readOwnPermissionsAction = getDefaultAction();
lockObjectAction = getDefaultAction();
killLockAction = getDefaultAction();
readLocksAction = getDefaultAction();
readRevisionMetadataAction = getDefaultAction();
createRevisionMetadataAction = getDefaultAction();
modifyRevisionMetadataAction = getDefaultAction();
removeRevisionMetadataAction = getDefaultAction();
readRevisionContentAction = getDefaultAction();
createRevisionContentAction = getDefaultAction();
modifyRevisionContentAction = getDefaultAction();
removeRevisionContentAction = getDefaultAction();
bindMemberAction = getDefaultAction();
unbindMemberAction = getDefaultAction();
} catch (Exception e) {
throw new InvalidNamespaceConfigurationException
(namespace, e.getMessage());
}
}
/**
* TEST PURPOSES ONLY.
*/
public void initializeForTestPurposesOnly()
throws InvalidNamespaceConfigurationException {
name = "slide";
try {
readObjectAction = getDefaultAction();
createObjectAction = getDefaultAction();
removeObjectAction = getDefaultAction();
grantPermissionAction = getDefaultAction();
revokePermissionAction = getDefaultAction();
readPermissionsAction = getDefaultAction();
readOwnPermissionsAction = getDefaultAction();
lockObjectAction = getDefaultAction();
killLockAction = getDefaultAction();
readLocksAction = getDefaultAction();
readRevisionMetadataAction = getDefaultAction();
createRevisionMetadataAction = getDefaultAction();
modifyRevisionMetadataAction = getDefaultAction();
removeRevisionMetadataAction = getDefaultAction();
readRevisionContentAction = getDefaultAction();
createRevisionContentAction = getDefaultAction();
modifyRevisionContentAction = getDefaultAction();
removeRevisionContentAction = getDefaultAction();
bindMemberAction = getDefaultAction();
unbindMemberAction = getDefaultAction();
} catch (Exception e) {
throw new InvalidNamespaceConfigurationException
(null, e.getMessage());
}
}
// ------------------------------------------------------ Protected Methods
/**
* Add a new parameter.
*
* @param name Parameter name
* @param value Parameter value
*/
protected void addParameter(String name, String value) {
if ((name!=null) && (value!=null)) {
parameters.put(name, value);
}
}
/**
* Add a new default property.
*
* @param role Role
* @param name Property name
* @param value Property value
* @param namespace Property namespace
*/
protected void addDefaultProperty(String role, String name, String value,
String namespace) {
if ((role!=null) && (name!=null) && (value!=null)) {
Vector currentDefaultProperties =
(Vector) defaultProperties.get(role);
if (currentDefaultProperties == null) {
currentDefaultProperties = new Vector();
defaultProperties.put(role, currentDefaultProperties);
}
currentDefaultProperties.addElement
(new NodeProperty(name, value, namespace));
}
}
/**
* Add a new role mapping.
*
* @param name Role mapping name
* @param value Role mapping value
*/
protected void addRoleMapping(String name, String value) {
if ((name!=null) && (value!=null)) {
roleMappings.put(name, value);
roleClassMappings.put(value, name);
}
}
/**
* Retrieve an action node.
*
* @param namespace The namespace, that contains the action node
* @param actionPath Path of the action
*/
protected ActionNode getActionNode(Namespace namespace, String actionPath)
throws InvalidNamespaceConfigurationException, SlideException {
ActionNode result = null;
if (actionPath != null) {
Uri actionUri = namespace.getUri(actionPath);
result = (ActionNode) actionUri.getStore()
.retrieveObject(actionUri);
}
else {
result = getDefaultAction();
}
return result;
}
// --------------------------------------------------------- Object Methods
/**
* Get a String representation of this domain.
*/
public String toString() {
return name;
}
}
The table below shows all metrics for NamespaceConfig.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 108.00 | Number of blocks | |
| BLOCK_COMMENT | 22.00 | Number of block comment lines | |
| COMMENTS | 352.00 | Comment lines | |
| COMMENT_DENSITY | 0.83 | Comment density | |
| COMPARISONS | 33.00 | Number of comparison operators | |
| CYCLOMATIC | 98.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 81.00 | Comments in declarations | |
| DOC_COMMENT | 318.00 | Number of javadoc comment lines | |
| ELOC | 425.00 | Effective lines of code | |
| EXEC_COMMENTS | 4.00 | Comments in executable code | |
| EXITS | 45.00 | Procedure exits | |
| FUNCTIONS | 52.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 66.84 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 124.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 | 2.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 39.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 2.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 3.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 | 5.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 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 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 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 5.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 3.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 8.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 7.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 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 | 1.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 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 1.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 | 3.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 2.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 1.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 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 | 1.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 | 1076.00 | Number of lines in the source file | |
| LINE_COMMENT | 12.00 | Number of line comments | |
| LOC | 515.00 | Lines of code | |
| LOGICAL_LINES | 265.00 | Number of statements | |
| LOOPS | 7.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 1056.00 | Number of operands | |
| OPERATORS | 1865.00 | Number of operators | |
| PARAMS | 31.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2921.00 | Halstead program length | |
| PROGRAM_VOCAB | 356.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 93.00 | Number of return points from functions | |
| SIZE | 32303.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 316.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 40.00 | Number of unique operators | |
| WHITESPACE | 209.00 | Number of whitespace lines | |