View Javadoc

1   /**
2    * This file Copyright (c) 2013 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.mail.app.field.transformer;
35  
36  import info.magnolia.ui.form.field.definition.CompositeFieldDefinition;
37  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
38  import info.magnolia.ui.form.field.definition.SwitchableFieldDefinition;
39  import info.magnolia.ui.form.field.transformer.basic.BasicTransformer;
40  import info.magnolia.ui.vaadin.integration.jcr.DefaultProperty;
41  
42  import java.util.Iterator;
43  import java.util.List;
44  
45  import com.vaadin.data.Item;
46  import com.vaadin.data.Property;
47  import com.vaadin.data.util.PropertysetItem;
48  
49  /**
50   * Transformer for composite field to handle saving of user's name and password in smtp configuration.
51   */
52  public class MailSecurityTransformer extends BasicTransformer<PropertysetItem> {
53  
54      protected List<String> fieldsName;
55      protected String compositeFieldName = "composite";
56  
57      public MailSecurityTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<PropertysetItem> type, List<String> fieldsName) {
58          super(relatedFormItem, definition, type);
59          fieldsName.clear();
60          List<ConfiguredFieldDefinition> fields = ((SwitchableFieldDefinition) definition).getFields();
61          for (ConfiguredFieldDefinition field : fields) {
62              if (field instanceof CompositeFieldDefinition) {
63                  fieldsName.addAll(((CompositeFieldDefinition) field).getFieldsName());
64              }
65          }
66          this.fieldsName = fieldsName;
67      }
68  
69      @Override
70      public void writeToItem(PropertysetItem newValues) {
71          // Get iterator.
72          Iterator<?> propertyNames = newValues.getItemPropertyIds().iterator();
73  
74          while (propertyNames.hasNext()) {
75              String propertyName = (String) propertyNames.next();
76              if (propertyName.equals(compositeFieldName)) {
77                  PropertysetItem values = (PropertysetItem) newValues.getItemProperty(propertyName).getValue();
78                  Iterator<?> names = values.getItemPropertyIds().iterator();
79  
80                  while (names.hasNext()) {
81                      String name = (String) names.next();
82                      Property<?> property = relatedFormItem.getItemProperty(name);
83                      if (property == null) {
84                          relatedFormItem.addItemProperty(name, values.getItemProperty(name));
85                      }
86                  }
87              }
88          }
89  
90          // This store the selected option
91          String propertyName = definePropertyName();
92          // Add the select property value (select property name == field name)
93          if (newValues.getItemProperty(propertyName) != null) {
94              relatedFormItem.addItemProperty(propertyName, newValues.getItemProperty(propertyName));
95          }
96      }
97  
98      @Override
99      public PropertysetItem readFromItem() {
100         PropertysetItem compositeFielNewValues = new PropertysetItem();
101         for (String propertyName : fieldsName) {
102             if (relatedFormItem.getItemProperty(propertyName) != null) {
103                 compositeFielNewValues.addItemProperty(propertyName, relatedFormItem.getItemProperty(propertyName));
104             }
105         }
106         // Switchable field wait a PropertysetItem (key = field name, value = field property).
107         // In this case, the Switchable field do only have one field 'composite' that have a multiple values (PropertysetItem)
108         PropertysetItem newValue = new PropertysetItem();
109         newValue.addItemProperty(compositeFieldName, new DefaultProperty<PropertysetItem>(PropertysetItem.class, compositeFielNewValues));
110 
111         // This set the selected option
112         String propertyName = definePropertyName();
113         if (relatedFormItem.getItemProperty(propertyName) != null) {
114             newValue.addItemProperty(propertyName, relatedFormItem.getItemProperty(propertyName));
115         }
116 
117         return newValue;
118     }
119 }