View Javadoc
1   /**
2    * This file Copyright (c) 2013-2017 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.v7.data.Item;
46  import com.vaadin.v7.data.Property;
47  import com.vaadin.v7.data.util.PropertysetItem;
48  
49  /**
50   * Transformer for composite field to handle saving of user's name and password in smtp configuration.
51   *
52   * @deprecated since 5.5. Use {@link info.magnolia.module.mail.app.field.transformer.MailAuthenticationTransformer} instead.
53   */
54  @Deprecated
55  public class MailSecurityTransformer extends BasicTransformer<PropertysetItem> {
56  
57      protected List<String> fieldsName;
58      protected String compositeFieldName = "composite";
59  
60      public MailSecurityTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<PropertysetItem> type, List<String> fieldsName) {
61          super(relatedFormItem, definition, type);
62          fieldsName.clear();
63          List<ConfiguredFieldDefinition> fields = ((SwitchableFieldDefinition) definition).getFields();
64          for (ConfiguredFieldDefinition field : fields) {
65              if (field instanceof CompositeFieldDefinition) {
66                  fieldsName.addAll(((CompositeFieldDefinition) field).getFieldsName());
67              }
68          }
69          this.fieldsName = fieldsName;
70      }
71  
72      @Override
73      public void writeToItem(PropertysetItem newValues) {
74          // Get iterator.
75          Iterator<?> propertyNames = newValues.getItemPropertyIds().iterator();
76  
77          while (propertyNames.hasNext()) {
78              String propertyName = (String) propertyNames.next();
79              if (propertyName.equals(compositeFieldName)) {
80                  PropertysetItem values = (PropertysetItem) newValues.getItemProperty(propertyName).getValue();
81                  Iterator<?> names = values.getItemPropertyIds().iterator();
82  
83                  while (names.hasNext()) {
84                      String name = (String) names.next();
85                      Property<?> property = relatedFormItem.getItemProperty(name);
86                      if (property == null) {
87                          relatedFormItem.addItemProperty(name, values.getItemProperty(name));
88                      }
89                  }
90              }
91          }
92  
93          // This store the selected option
94          String propertyName = definePropertyName();
95          // Add the select property value (select property name == field name)
96          if (newValues.getItemProperty(propertyName) != null) {
97              relatedFormItem.addItemProperty(propertyName, newValues.getItemProperty(propertyName));
98          }
99      }
100 
101     @Override
102     public PropertysetItem readFromItem() {
103         PropertysetItem compositeFielNewValues = new PropertysetItem();
104         for (String propertyName : fieldsName) {
105             if (relatedFormItem.getItemProperty(propertyName) != null) {
106                 compositeFielNewValues.addItemProperty(propertyName, relatedFormItem.getItemProperty(propertyName));
107             }
108         }
109         // Switchable field wait a PropertysetItem (key = field name, value = field property).
110         // In this case, the Switchable field do only have one field 'composite' that have a multiple values (PropertysetItem)
111         PropertysetItem newValue = new PropertysetItem();
112         newValue.addItemProperty(compositeFieldName, new DefaultProperty<>(PropertysetItem.class, compositeFielNewValues));
113 
114         // This set the selected option
115         String propertyName = definePropertyName();
116         if (relatedFormItem.getItemProperty(propertyName) != null) {
117             newValue.addItemProperty(propertyName, relatedFormItem.getItemProperty(propertyName));
118         }
119 
120         return newValue;
121     }
122 }