View Javadoc

1   /*
2    * Copyright 2005-2009 The Kuali Foundation
3    *
4    *
5    * Licensed under the Educational Community License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    *
9    * http://www.opensource.org/licenses/ecl2.php
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.kuali.rice.kew.xml.export;
18  
19  import static org.kuali.rice.core.api.impex.xml.XmlConstants.DELEGATION_TYPE;
20  import static org.kuali.rice.core.api.impex.xml.XmlConstants.GROUP_NAME;
21  import static org.kuali.rice.core.api.impex.xml.XmlConstants.NAMESPACE;
22  import static org.kuali.rice.core.api.impex.xml.XmlConstants.PARENT_RESPONSIBILITY;
23  import static org.kuali.rice.core.api.impex.xml.XmlConstants.PARENT_RULE_NAME;
24  import static org.kuali.rice.core.api.impex.xml.XmlConstants.PRINCIPAL_NAME;
25  import static org.kuali.rice.core.api.impex.xml.XmlConstants.ROLE;
26  import static org.kuali.rice.core.api.impex.xml.XmlConstants.RULE_DELEGATION;
27  import static org.kuali.rice.core.api.impex.xml.XmlConstants.RULE_DELEGATIONS;
28  import static org.kuali.rice.core.api.impex.xml.XmlConstants.RULE_NAMESPACE;
29  import static org.kuali.rice.core.api.impex.xml.XmlConstants.RULE_SCHEMA_LOCATION;
30  import static org.kuali.rice.core.api.impex.xml.XmlConstants.SCHEMA_LOCATION_ATTR;
31  import static org.kuali.rice.core.api.impex.xml.XmlConstants.SCHEMA_NAMESPACE;
32  
33  import java.util.Iterator;
34  
35  import org.jdom.Element;
36  import org.kuali.rice.core.api.exception.RiceRuntimeException;
37  import org.kuali.rice.core.api.impex.ExportDataSet;
38  import org.kuali.rice.core.framework.impex.xml.XmlExporter;
39  import org.kuali.rice.core.util.xml.XmlRenderer;
40  import org.kuali.rice.kew.export.KewExportDataSet;
41  import org.kuali.rice.kew.rule.RuleBaseValues;
42  import org.kuali.rice.kew.rule.RuleDelegation;
43  import org.kuali.rice.kew.rule.RuleResponsibility;
44  import org.kuali.rice.kew.service.KEWServiceLocator;
45  import org.kuali.rice.kim.api.entity.principal.Principal;
46  import org.kuali.rice.kim.api.group.Group;
47  
48  /**
49   * Exports rules to XML.
50   *
51   * @see RuleBaseValues
52   *
53   * @author Kuali Rice Team (rice.collab@kuali.org)
54   */
55  public class RuleDelegationXmlExporter implements XmlExporter {
56  
57      protected final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(getClass());
58  
59      private XmlRenderer renderer = new XmlRenderer(RULE_NAMESPACE);
60      private RuleXmlExporter ruleExporter = new RuleXmlExporter(RULE_NAMESPACE);
61  
62  	@Override
63  	public boolean supportPrettyPrint() {
64  		return true;
65  	}
66  
67      public Element export(ExportDataSet exportDataSet) {
68      	KewExportDataSet dataSet = KewExportDataSet.fromExportDataSet(exportDataSet);
69          if (!dataSet.getRuleDelegations().isEmpty()) {
70              Element rootElement = renderer.renderElement(null, RULE_DELEGATIONS);
71              rootElement.setAttribute(SCHEMA_LOCATION_ATTR, RULE_SCHEMA_LOCATION, SCHEMA_NAMESPACE);
72              for (Iterator iterator = dataSet.getRuleDelegations().iterator(); iterator.hasNext();) {
73                  RuleDelegation ruleDelegation = (RuleDelegation) iterator.next();
74                  exportRuleDelegation(rootElement, ruleDelegation);
75              }
76              return rootElement;
77          }
78          return null;
79      }
80  
81      private void exportRuleDelegation(Element parent, RuleDelegation ruleDelegation) {
82      	Element ruleDelegationElement = renderer.renderElement(parent, RULE_DELEGATION);
83      	exportParentResponsibility(ruleDelegationElement, ruleDelegation);
84      	renderer.renderTextElement(ruleDelegationElement, DELEGATION_TYPE, ruleDelegation.getDelegationType());
85      	ruleExporter.exportRule(ruleDelegationElement, ruleDelegation.getDelegationRuleBaseValues());
86      }
87      
88      private void exportParentResponsibility(Element parent, RuleDelegation delegation) {
89          Element parentResponsibilityElement = renderer.renderElement(parent, PARENT_RESPONSIBILITY);
90          RuleResponsibility ruleResponsibility = KEWServiceLocator.getRuleService().findRuleResponsibility(delegation.getResponsibilityId());
91          renderer.renderTextElement(parentResponsibilityElement, PARENT_RULE_NAME, ruleResponsibility.getRuleBaseValues().getName());
92          if (ruleResponsibility.isUsingWorkflowUser()) {
93          	Principal principal = ruleResponsibility.getPrincipal();
94          	renderer.renderTextElement(parentResponsibilityElement, PRINCIPAL_NAME, principal.getPrincipalName());
95          } else if (ruleResponsibility.isUsingGroup()) {
96          	Group group = ruleResponsibility.getGroup();
97          	Element groupElement = renderer.renderElement(parentResponsibilityElement, GROUP_NAME);
98          	groupElement.setText(group.getName());
99          	groupElement.setAttribute(NAMESPACE, group.getNamespaceCode());
100         } else if (ruleResponsibility.isUsingRole()) {
101         	renderer.renderTextElement(parentResponsibilityElement, ROLE, ruleResponsibility.getRuleResponsibilityName());
102         } else {
103         	throw new RiceRuntimeException("Encountered a rule responsibility when exporting with an invalid type of '" + ruleResponsibility.getRuleResponsibilityType());
104         }
105     }
106 
107 }