Coverage Report - org.kuali.rice.kew.doctype.DocumentTypeSecurity
 
Classes in this File Line Coverage Branch Coverage Complexity
DocumentTypeSecurity
0%
0/159
0%
0/108
3.905
 
 1   
 /*
 2   
  * Copyright 2008-2009 The Kuali Foundation
 3   
  *
 4   
  * Licensed under the Educational Community License, Version 2.0 (the "License");
 5   
  * you may not use this file except in compliance with the License.
 6   
  * You may obtain a copy of the License at
 7   
  *
 8   
  * http://www.opensource.org/licenses/ecl2.php
 9   
  *
 10   
  * Unless required by applicable law or agreed to in writing, software
 11   
  * distributed under the License is distributed on an "AS IS" BASIS,
 12   
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13   
  * See the License for the specific language governing permissions and
 14   
  * limitations under the License.
 15   
  */
 16   
 package org.kuali.rice.kew.doctype;
 17   
 
 18   
 import java.io.BufferedReader;
 19   
 import java.io.IOException;
 20   
 import java.io.Serializable;
 21   
 import java.io.StringReader;
 22   
 import java.util.ArrayList;
 23   
 import java.util.List;
 24   
 
 25   
 import javax.xml.parsers.DocumentBuilderFactory;
 26   
 import javax.xml.parsers.ParserConfigurationException;
 27   
 import javax.xml.xpath.XPath;
 28   
 import javax.xml.xpath.XPathConstants;
 29   
 
 30   
 import org.apache.commons.lang.StringUtils;
 31   
 import org.kuali.rice.core.api.impex.xml.XmlConstants;
 32   
 import org.kuali.rice.core.util.ConcreteKeyValue;
 33   
 import org.kuali.rice.core.util.KeyValue;
 34   
 import org.kuali.rice.kew.exception.WorkflowException;
 35   
 import org.kuali.rice.kew.exception.WorkflowRuntimeException;
 36   
 import org.kuali.rice.kew.rule.bo.RuleAttribute;
 37   
 import org.kuali.rice.kew.rule.xmlrouting.XPathHelper;
 38   
 import org.kuali.rice.kew.service.KEWServiceLocator;
 39   
 import org.kuali.rice.kew.util.Utilities;
 40   
 import org.kuali.rice.kim.api.services.KimApiServiceLocator;
 41   
 import org.kuali.rice.kim.api.group.Group;
 42   
 import org.w3c.dom.Element;
 43   
 import org.w3c.dom.NamedNodeMap;
 44   
 import org.w3c.dom.Node;
 45   
 import org.w3c.dom.NodeList;
 46   
 import org.xml.sax.InputSource;
 47   
 import org.xml.sax.SAXException;
 48   
 
 49   
 
 50   
 public class DocumentTypeSecurity implements Serializable {
 51   
 
 52   
   private static final long serialVersionUID = -1886779857180381404L;
 53   
 
 54  0 
   private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(DocumentTypeSecurity.class);
 55   
 
 56   
   private Boolean active;
 57   
 
 58   
   private Boolean initiatorOk;
 59   
   private Boolean routeLogAuthenticatedOk;
 60  0 
   private List<KeyValue> searchableAttributes = new ArrayList<KeyValue>();
 61  0 
   private List<Group> workgroups = new ArrayList<Group>();
 62  0 
   private List<SecurityPermissionInfo> permissions = new ArrayList<SecurityPermissionInfo>();
 63  0 
   private List<String> allowedRoles = new ArrayList<String>();
 64  0 
   private List<String> disallowedRoles = new ArrayList<String>();
 65  0 
   private List<SecurityAttribute> securityAttributes = new ArrayList<SecurityAttribute>();
 66   
 
 67  0 
   private static XPath xpath = XPathHelper.newXPath();
 68   
 
 69  0 
   public DocumentTypeSecurity() {}
 70   
 
 71   
   /** parse <security> XML to populate security object
 72   
    * @throws ParserConfigurationException
 73   
    * @throws IOException
 74   
    * @throws SAXException */
 75   
   public DocumentTypeSecurity(String standardApplicationId, String documentTypeSecurityXml)
 76  0 
   {
 77   
     try {
 78  0 
       if (org.apache.commons.lang.StringUtils.isEmpty(documentTypeSecurityXml)) {
 79  0 
         return;
 80   
       }
 81   
 
 82  0 
       InputSource inputSource = new InputSource(new BufferedReader(new StringReader(documentTypeSecurityXml)));
 83  0 
       Element securityElement = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(inputSource).getDocumentElement();
 84   
 
 85  0 
       String active = (String) xpath.evaluate("./@active", securityElement, XPathConstants.STRING);
 86  0 
       if (org.apache.commons.lang.StringUtils.isEmpty(active) || "true".equals(active.toLowerCase())) {
 87   
         // true is the default
 88  0 
         this.setActive(Boolean.valueOf(true));
 89   
       }
 90   
       else {
 91  0 
         this.setActive(Boolean.valueOf(false));
 92   
       }
 93   
 
 94   
       // there should only be one <initiator> tag
 95  0 
       NodeList initiatorNodes = (NodeList) xpath.evaluate("./initiator", securityElement, XPathConstants.NODESET);
 96  0 
       if (initiatorNodes != null && initiatorNodes.getLength()>0) {
 97  0 
         Node initiatorNode = initiatorNodes.item(0);
 98  0 
         String value = initiatorNode.getTextContent();
 99  0 
         if (org.apache.commons.lang.StringUtils.isEmpty(value) || value.toLowerCase().equals("true")) {
 100  0 
           this.setInitiatorOk(Boolean.valueOf(true));
 101   
         }
 102   
         else {
 103  0 
           this.initiatorOk = Boolean.valueOf(false);
 104   
         }
 105   
       }
 106   
 
 107   
       // there should only be one <routeLogAuthenticated> tag
 108  0 
       NodeList routeLogAuthNodes = (NodeList) xpath.evaluate("./routeLogAuthenticated", securityElement, XPathConstants.NODESET);
 109  0 
       if (routeLogAuthNodes != null && routeLogAuthNodes.getLength()>0) {
 110  0 
         Node routeLogAuthNode = routeLogAuthNodes.item(0);
 111  0 
         String value = routeLogAuthNode.getTextContent();
 112  0 
         if (org.apache.commons.lang.StringUtils.isEmpty(value) || value.toLowerCase().equals("true")) {
 113  0 
           this.routeLogAuthenticatedOk = Boolean.valueOf(true);
 114   
         }
 115   
         else {
 116  0 
           this.routeLogAuthenticatedOk = Boolean.valueOf(false);
 117   
         }
 118   
       }
 119   
 
 120  0 
       NodeList searchableAttributeNodes = (NodeList) xpath.evaluate("./searchableAttribute", securityElement, XPathConstants.NODESET);
 121  0 
       if (searchableAttributeNodes != null && searchableAttributeNodes.getLength()>0) {
 122  0 
         for (int i = 0; i < searchableAttributeNodes.getLength(); i++) {
 123  0 
           Node searchableAttributeNode = searchableAttributeNodes.item(i);
 124  0 
           String name = (String) xpath.evaluate("./@name", searchableAttributeNode, XPathConstants.STRING);
 125  0 
           String idType = (String) xpath.evaluate("./@idType", searchableAttributeNode, XPathConstants.STRING);
 126  0 
           if (!org.apache.commons.lang.StringUtils.isEmpty(name) && !org.apache.commons.lang.StringUtils.isEmpty(idType)) {
 127  0 
             KeyValue searchableAttribute = new ConcreteKeyValue(name, idType);
 128  0 
             searchableAttributes.add(searchableAttribute);
 129   
           }
 130   
         }
 131   
       }
 132   
 
 133  0 
       NodeList workgroupNodes = (NodeList) xpath.evaluate("./workgroup", securityElement, XPathConstants.NODESET);
 134  0 
       if (workgroupNodes != null && workgroupNodes.getLength()>0) {
 135  0 
             LOG.warn("Document Type Security XML is using deprecated element 'workgroup', please use 'groupName' instead.");
 136  0 
         for (int i = 0; i < workgroupNodes.getLength(); i++) {
 137  0 
           Node workgroupNode = workgroupNodes.item(i);
 138  0 
           String value = workgroupNode.getTextContent().trim();
 139  0 
           if (!org.apache.commons.lang.StringUtils.isEmpty(value)) {
 140  0 
                 value = Utilities.substituteConfigParameters(value);
 141  0 
             String namespaceCode = Utilities.parseGroupNamespaceCode(value);
 142  0 
             String groupName = Utilities.parseGroupName(value);
 143  0 
                 Group groupObject = KimApiServiceLocator.getIdentityManagementService().getGroupByName(namespaceCode, groupName);
 144  0 
                 if (groupObject == null) {
 145  0 
                         throw new WorkflowException("Could not find group: " + value);
 146   
                 }
 147  0 
             workgroups.add(groupObject);
 148   
           }
 149   
         }
 150   
       }
 151   
 
 152  0 
       NodeList groupNodes = (NodeList) xpath.evaluate("./groupName", securityElement, XPathConstants.NODESET);
 153  0 
       if (groupNodes != null && groupNodes.getLength()>0) {
 154  0 
         for (int i = 0; i < groupNodes.getLength(); i++) {
 155  0 
           Node groupNode = groupNodes.item(i);
 156  0 
           if (groupNode.getNodeType() == Node.ELEMENT_NODE) {
 157  0 
                 String groupName = groupNode.getTextContent().trim();
 158  0 
             if (!org.apache.commons.lang.StringUtils.isEmpty(groupName)) {
 159  0 
               groupName = Utilities.substituteConfigParameters(groupName).trim();
 160  0 
               String namespaceCode = Utilities.substituteConfigParameters(((Element) groupNode).getAttribute(XmlConstants.NAMESPACE)).trim();
 161  0 
               Group groupObject = KimApiServiceLocator.getIdentityManagementService().getGroupByName(namespaceCode, groupName);
 162   
 
 163   
 
 164  0 
               if (groupObject != null) {
 165  0 
                       workgroups.add(groupObject);
 166   
               } else {
 167  0 
                       LOG.warn("Could not find group with name '" + groupName + "' and namespace '" + namespaceCode + "' which was defined on Document Type security");
 168   
               }
 169   
 //                if (groupObject == null) {
 170   
 //                  throw new WorkflowException("Could not find group with name '" + groupName + "' and namespace '" + namespaceCode + "'");
 171   
 //                }
 172   
 
 173   
 
 174   
             }
 175   
           }
 176   
         }
 177   
       }
 178   
 
 179  0 
       NodeList permissionNodes = (NodeList) xpath.evaluate("./permission", securityElement, XPathConstants.NODESET);
 180  0 
       if (permissionNodes != null && permissionNodes.getLength()>0) {
 181  0 
         for (int i = 0; i < permissionNodes.getLength(); i++) {
 182  0 
           Node permissionNode = permissionNodes.item(i);
 183  0 
           if (permissionNode.getNodeType() == Node.ELEMENT_NODE) {
 184  0 
                   SecurityPermissionInfo securityPermission = new SecurityPermissionInfo();
 185  0 
                 securityPermission.setPermissionName(Utilities.substituteConfigParameters(((Element) permissionNode).getAttribute(XmlConstants.NAME)).trim());
 186  0 
                 securityPermission.setPermissionNamespaceCode(Utilities.substituteConfigParameters(((Element) permissionNode).getAttribute(XmlConstants.NAMESPACE)).trim());
 187  0 
                 if (!StringUtils.isEmpty(securityPermission.getPermissionName()) && !StringUtils.isEmpty(securityPermission.getPermissionNamespaceCode())) {
 188   
                         //get details and qualifications
 189  0 
                         if (permissionNode.hasChildNodes()) {
 190  0 
                                 NodeList permissionChildNodes = permissionNode.getChildNodes();
 191  0 
                                 for (int j = 0; j <permissionChildNodes.getLength(); j++) {
 192  0 
                                         Node permissionChildNode = permissionChildNodes.item(j);
 193  0 
                                         if (permissionChildNode.getNodeType() == Node.ELEMENT_NODE) {
 194  0 
                                                 String childAttributeName = Utilities.substituteConfigParameters(((Element) permissionChildNode).getAttribute(XmlConstants.NAME)).trim();
 195  0 
                                                 String childAttributeValue = permissionChildNode.getTextContent().trim();
 196  0 
                                                 if (!StringUtils.isEmpty(childAttributeValue)) {
 197  0 
                                                         childAttributeValue = Utilities.substituteConfigParameters(childAttributeValue).trim();
 198   
                                                 }
 199  0 
                                                 if (!StringUtils.isEmpty(childAttributeValue)) {
 200  0 
                                                         childAttributeValue = Utilities.substituteConfigParameters(childAttributeValue).trim();
 201   
                                                 }
 202  0 
                                                 if (permissionChildNode.getNodeName().trim().equals("permissionDetail")) {
 203  0 
                                                         securityPermission.getPermissionDetails().put(childAttributeName, childAttributeValue);
 204   
                                                 }
 205  0 
                                                 if (permissionChildNode.getNodeName().trim().equals("qualification")) {
 206  0 
                                                         securityPermission.getQualifications().put(childAttributeName, childAttributeValue);
 207   
                                                 }
 208   
                                         }
 209   
                                 }
 210   
                         }
 211   
 
 212  0 
               if ( KimApiServiceLocator.getPermissionService().isPermissionDefined(securityPermission.getPermissionNamespaceCode(), securityPermission.getPermissionName(), securityPermission.getPermissionDetails())) {
 213  0 
                       permissions.add(securityPermission);
 214   
               } else {
 215  0 
                       LOG.warn("Could not find permission with name '" + securityPermission.getPermissionName() + "' and namespace '" + securityPermission.getPermissionNamespaceCode() + "' which was defined on Document Type security");
 216   
               }
 217   
             }
 218   
           }
 219   
         }
 220   
       }
 221   
 
 222  0 
       NodeList roleNodes = (NodeList) xpath.evaluate("./role", securityElement, XPathConstants.NODESET);
 223  0 
       if (roleNodes != null && roleNodes.getLength()>0) {
 224  0 
         for (int i = 0; i < roleNodes.getLength(); i++) {
 225  0 
           Element roleElement = (Element)roleNodes.item(i);
 226  0 
           String value = roleElement.getTextContent().trim();
 227  0 
           String allowedValue = roleElement.getAttribute("allowed");
 228  0 
           if (StringUtils.isBlank(allowedValue)) {
 229  0 
                   allowedValue = "true";
 230   
           }
 231  0 
           if (!org.apache.commons.lang.StringUtils.isEmpty(value)) {
 232  0 
                   if (Boolean.parseBoolean(allowedValue)) {
 233  0 
                           allowedRoles.add(value);
 234   
                   } else {
 235  0 
                           disallowedRoles.add(value);
 236   
                   }
 237   
           }
 238   
         }
 239   
       }
 240   
 
 241  0 
       NodeList attributeNodes = (NodeList) xpath.evaluate("./securityAttribute", securityElement, XPathConstants.NODESET);
 242  0 
       if (attributeNodes != null && attributeNodes.getLength()>0) {
 243  0 
           for (int i = 0; i < attributeNodes.getLength(); i++) {
 244  0 
             Element attributeElement = (Element)attributeNodes.item(i);
 245  0 
             NamedNodeMap elemAttributes = attributeElement.getAttributes();
 246  0 
             String className = null;
 247  0 
             String applicationId = standardApplicationId;
 248  0 
             if (elemAttributes.getNamedItem("name") != null) {
 249   
                 // found a name attribute so find the class name
 250  0 
                 String ruleAttributeName = elemAttributes.getNamedItem("name").getNodeValue().trim();
 251  0 
                 RuleAttribute ruleAttribute = KEWServiceLocator.getRuleAttributeService().findByName(ruleAttributeName);
 252  0 
                 if (ruleAttribute == null) {
 253  0 
                     throw new WorkflowException("Could not find rule attribute: " + ruleAttributeName);
 254   
                 }
 255  0 
                 applicationId = ruleAttribute.getApplicationId();
 256  0 
                 className = ruleAttribute.getClassName();
 257  0 
             } else if (elemAttributes.getNamedItem("class") != null) {
 258   
                 // class name defined
 259  0 
                 className = elemAttributes.getNamedItem("class").getNodeValue().trim();
 260   
             } else {
 261  0 
                 throw new WorkflowException("Cannot find attribute 'name' or attribute 'class' for securityAttribute Node");
 262   
             }
 263   
 
 264  0 
             this.securityAttributes.add(new LazyLoadSecurityAttribute(className, applicationId));
 265   
 
 266   
           }
 267   
         }
 268  0 
     } catch (Exception err) {
 269  0 
       throw new WorkflowRuntimeException(err);
 270  0 
     }
 271  0 
   }
 272   
 
 273   
   public List<SecurityAttribute> getSecurityAttributes() {
 274  0 
     return this.securityAttributes;
 275   
   }
 276   
 
 277   
   public void setSecurityAttributes(List<SecurityAttribute> securityAttributes) {
 278  0 
     this.securityAttributes = securityAttributes;
 279  0 
   }
 280   
 
 281   
   public Boolean getInitiatorOk() {
 282  0 
     return initiatorOk;
 283   
   }
 284   
   public void setInitiatorOk(Boolean initiatorOk) {
 285  0 
     this.initiatorOk = initiatorOk;
 286  0 
   }
 287   
 
 288   
   public Boolean getRouteLogAuthenticatedOk() {
 289  0 
     return routeLogAuthenticatedOk;
 290   
   }
 291   
   public void setRouteLogAuthenticatedOk(Boolean routeLogAuthenticatedOk) {
 292  0 
     this.routeLogAuthenticatedOk = routeLogAuthenticatedOk;
 293  0 
   }
 294   
 
 295   
   public List<String> getAllowedRoles() {
 296  0 
         return allowedRoles;
 297   
   }
 298   
 
 299   
   public void setAllowedRoles(List<String> allowedRoles) {
 300  0 
         this.allowedRoles = allowedRoles;
 301  0 
   }
 302   
 
 303   
   public List<String> getDisallowedRoles() {
 304  0 
         return disallowedRoles;
 305   
   }
 306   
 
 307   
   public void setDisallowedRoles(List<String> disallowedRoles) {
 308  0 
         this.disallowedRoles = disallowedRoles;
 309  0 
   }
 310   
 
 311   
   public List<KeyValue> getSearchableAttributes() {
 312  0 
         return searchableAttributes;
 313   
   }
 314   
 
 315   
   public void setSearchableAttributes(List<KeyValue> searchableAttributes) {
 316  0 
         this.searchableAttributes = searchableAttributes;
 317  0 
   }
 318   
 
 319   
   public List<Group> getWorkgroups() {
 320  0 
         return workgroups;
 321   
   }
 322   
 
 323   
   public void setWorkgroups(List<Group> workgroups) {
 324  0 
         this.workgroups = workgroups;
 325  0 
   }
 326   
 
 327   
   public List<SecurityPermissionInfo> getPermissions() {
 328  0 
     return this.permissions;
 329   
   }
 330   
 
 331   
   public void setPermissions(List<SecurityPermissionInfo> permissions) {
 332  0 
         this.permissions = permissions;
 333  0 
   }
 334   
 
 335   
   public Boolean getActive() {
 336  0 
     return active;
 337   
   }
 338   
 
 339   
   public void setActive(Boolean active) {
 340  0 
     this.active = active;
 341  0 
   }
 342   
 
 343   
   public boolean isActive() {
 344  0 
     if (active != null) {
 345  0 
       return active.booleanValue();
 346   
     }
 347   
     else {
 348  0 
       return false;
 349   
     }
 350   
   }
 351   
 }
Report generated by Cobertura 1.9.4.1 on 6/12/11 4:28 AM.