View Javadoc
1   /**
2    * This file Copyright (c) 2013-2018 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.blossom.dialog;
35  
36  import info.magnolia.config.registry.DefinitionMetadata;
37  import info.magnolia.config.registry.DefinitionMetadataBuilder;
38  import info.magnolia.config.registry.DefinitionProvider;
39  import info.magnolia.config.registry.DefinitionRawView;
40  import info.magnolia.config.registry.Registry;
41  import info.magnolia.config.registry.decoration.DefinitionDecorator;
42  import info.magnolia.config.source.ConfigurationSourceTypes;
43  import info.magnolia.module.blossom.BlossomModule;
44  import info.magnolia.module.blossom.support.ExplicitIdDefinitionMetadataBuilder;
45  import info.magnolia.objectfactory.Components;
46  import info.magnolia.ui.dialog.DefinitionTypes;
47  import info.magnolia.ui.dialog.DialogDefinition;
48  import info.magnolia.ui.dialog.definition.ConfiguredFormDialogDefinition;
49  import info.magnolia.ui.form.definition.ConfiguredFormDefinition;
50  
51  import java.util.Collections;
52  import java.util.List;
53  
54  /**
55   * Registers a blossom dialog with basic metadata.
56   *
57   * @since 3.0
58   */
59  public class BlossomDialogDefinitionProvider implements DefinitionProvider<DialogDefinition> {
60      private BlossomDialogDescription dialogDescription;
61  
62      public BlossomDialogDefinitionProvider(BlossomDialogDescription dialogDescription) {
63          this.dialogDescription = dialogDescription;
64      }
65  
66      @Override
67      public List<DefinitionDecorator<DialogDefinition>> getDecorators() {
68          return Collections.EMPTY_LIST;
69      }
70  
71      @Override
72      public DefinitionMetadata getMetadata() {
73          DefinitionMetadataBuilder builder = new ExplicitIdDefinitionMetadataBuilder(dialogDescription.getId())
74                  .type(DefinitionTypes.DIALOG)
75                  .configurationSourceType(ConfigurationSourceTypes.code);
76          DialogFactoryMetaData factoryMetaData = dialogDescription.getFactoryMetaData();
77          if (factoryMetaData != null) {
78              if (factoryMetaData.getFactoryMethod() != null) {
79                  builder.location(factoryMetaData.getFactoryObject().getClass().getName() + "." + factoryMetaData.getFactoryMethod().getName());
80              } else {
81                  builder.location(factoryMetaData.getFactoryObject().getClass().getName());
82              }
83          }
84          return builder.build();
85      }
86  
87      @Override
88      public DefinitionRawView getRaw() {
89          return DefinitionRawView.EMPTY;
90      }
91  
92      @Override
93      public boolean isValid() {
94          return true;
95      }
96  
97      @Override
98      public List<String> getErrorMessages() {
99          return Collections.emptyList();
100     }
101 
102     @Override
103     public long getLastModified() {
104         return System.currentTimeMillis();
105     }
106 
107     @Override
108     public DialogDefinition get() throws Registry.InvalidDefinitionException {
109 
110         ConfiguredFormDialogDefinition dialog = new ConfiguredFormDialogDefinition();
111         dialog.setId(dialogDescription.getId());
112         dialog.setLabel(dialogDescription.getFactoryMetaData().getLabel());
113         dialog.setI18nBasename(dialogDescription.getFactoryMetaData().getI18nBasename());
114         dialog.setPresenterClass(Components.getComponent(BlossomModule.class).getFormDialogPresenterClass());
115         dialog.setForm(new ConfiguredFormDefinition());
116 
117         return dialog;
118     }
119 }