View Javadoc

1   /**
2    * Copyright 2005-2011 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.xml.export;
17  
18  import org.jdom.Element;
19  import org.kuali.rice.core.api.impex.ExportDataSet;
20  import org.kuali.rice.core.api.util.xml.XmlRenderer;
21  import org.kuali.rice.core.framework.impex.xml.XmlExporter;
22  import org.kuali.rice.kew.export.KewExportDataSet;
23  import org.kuali.rice.kim.api.group.Group;
24  import org.kuali.rice.kim.api.services.KimApiServiceLocator;
25  import org.kuali.rice.kim.api.type.KimType;
26  
27  import java.util.Iterator;
28  
29  import static org.kuali.rice.core.api.impex.xml.XmlConstants.*;
30  
31  /**
32   * This is a description of what this class does - jjhanso don't forget to fill this in.
33   *
34   * @author Kuali Rice Team (rice.collab@kuali.org)
35   *
36   */
37  public class GroupXmlExporter implements XmlExporter {
38      protected final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(getClass());
39  
40      private XmlRenderer renderer = new XmlRenderer(GROUP_NAMESPACE);
41  
42  	@Override
43  	public boolean supportPrettyPrint() {
44  		return true;
45  	}
46      
47      /**
48       * This overridden method ...
49       *
50       * @see org.kuali.rice.core.framework.impex.xml.XmlExporter#export(org.kuali.rice.core.api.impex.ExportDataSet)
51       */
52      public Element export(ExportDataSet exportDataSet) {
53      	KewExportDataSet dataSet = KewExportDataSet.fromExportDataSet(exportDataSet);
54          if (!dataSet.getGroups().isEmpty()) {
55              Element rootElement = renderer.renderElement(null, GROUPS);
56              rootElement.setAttribute(SCHEMA_LOCATION_ATTR, GROUP_SCHEMA_LOCATION, SCHEMA_NAMESPACE);
57              for (Iterator iterator = dataSet.getGroups().iterator(); iterator.hasNext();) {
58                  Group group = (Group) iterator.next();
59                  exportGroup(rootElement, group);
60              }
61              return rootElement;
62          }
63          // TODO jjhanso - THIS METHOD NEEDS JAVADOCS
64          return null;
65      }
66  
67      /**
68       * This method ...
69       *
70       * @param rootElement
71       * @param group
72       * @param object
73       */
74      private void exportGroup(Element parent, Group group) {
75          Element groupElement = renderer.renderElement(parent, GROUP);
76          if (group.getName() != null) {
77              renderer.renderTextElement(groupElement, NAME, group.getName());
78          }
79          if (group.getNamespaceCode() != null) {
80              renderer.renderTextElement(groupElement, NAMESPACE, group.getNamespaceCode());
81          }
82  
83          if (group.getDescription() != null && !group.getDescription().trim().equals("")) {
84              renderer.renderTextElement(groupElement, DESCRIPTION, group.getDescription());
85          }
86  
87          renderer.renderTextElement(groupElement, ACTIVE, new Boolean(group.isActive()).toString());
88  
89          if (group.getKimTypeId() != null) {
90              Element typeElement = renderer.renderElement(groupElement, TYPE);
91              KimType kimType = KimApiServiceLocator.getKimTypeInfoService().getKimType(group.getKimTypeId());
92              renderer.renderTextElement(typeElement, NAMESPACE, kimType.getNamespaceCode());
93              renderer.renderTextElement(typeElement, NAME, kimType.getName());
94          }
95  
96          if (group.getAttributes().size() > 0) {
97              Element attributesElement = renderer.renderElement(groupElement, ATTRIBUTES);
98              for (String key : group.getAttributes().keySet()) {
99                  Element attributeElement = renderer.renderElement(attributesElement, ATTRIBUTE);
100                 attributeElement.setAttribute(KEY, key);
101                 attributeElement.setAttribute(VALUE, group.getAttributes().get(key));
102             }
103         }
104 
105         java.util.List<String> memberGroupIds = KimApiServiceLocator.getGroupService().getDirectMemberGroupIds(group.getId());
106 
107         java.util.List<String> memberPrincipalIds = KimApiServiceLocator.getGroupService().getDirectMemberPrincipalIds(
108                 group.getId());
109 
110         if (memberGroupIds.size() > 0 || memberPrincipalIds.size() > 0) {
111             Element membersElement = renderer.renderElement(groupElement, MEMBERS);
112             for (String memberGroupId : memberGroupIds) {
113                 Group memberGroup = KimApiServiceLocator.getGroupService().getGroup(memberGroupId);
114                 Element groupNameElement = renderer.renderElement(membersElement, GROUP_NAME);
115                 renderer.renderTextElement(groupNameElement, NAME, memberGroup.getName());
116                 renderer.renderTextElement(groupNameElement, NAMESPACE, memberGroup.getNamespaceCode());
117             }
118             for (String memberPrincipalId : memberPrincipalIds) {
119                 renderer.renderTextElement(membersElement, PRINCIPAL_NAME, KimApiServiceLocator.getIdentityService().getPrincipal(memberPrincipalId).getPrincipalName());
120             }
121         }
122     }
123 
124 }