View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 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.admininterface;
35  
36  import info.magnolia.cms.core.Content;
37  import info.magnolia.cms.gui.dialog.Dialog;
38  import info.magnolia.objectfactory.Components;
39  import info.magnolia.registry.RegistryMap;
40  
41  import java.util.List;
42  import java.util.Set;
43  
44  import javax.inject.Singleton;
45  import javax.jcr.RepositoryException;
46  import javax.servlet.http.HttpServletRequest;
47  import javax.servlet.http.HttpServletResponse;
48  
49  
50  /**
51   * Manages all the dialog handlers.
52   */
53  @Singleton
54  public class DialogHandlerManager {
55  
56      private final RegistryMap<String, DialogHandlerProvider> registry = new RegistryMap<String, DialogHandlerProvider>() {
57  
58          @Override
59          protected String keyFromValue(DialogHandlerProvider value) {
60              return value.getId();
61          }
62      };
63  
64      public void register(DialogHandlerProvider provider) {
65          registry.put(provider.getId(), provider);
66      }
67  
68      public void unregister(String id) {
69          registry.remove(id);
70      }
71  
72      public Set<String> unregisterAndRegister(Set<String> registeredIds, List<DialogHandlerProvider> providers) {
73          return this.registry.removeAndPutAll(registeredIds, providers);
74      }
75  
76      /**
77       * @deprecated since 4.3.2, is obsolete since fix for MAGNOLIA-2907
78       */
79      @Deprecated
80      public Content getDialogConfigNode(String id) {
81          DialogHandlerProvider provider = registry.get(id);
82          if (provider == null) {
83              throw new InvalidDialogHandlerException(id, registry.keySet().toString());
84          }
85          return provider.getDialogConfigNode();
86      }
87  
88      public DialogMVCHandler getDialogHandler(String id, HttpServletRequest request, HttpServletResponse response) {
89          DialogHandlerProvider provider = registry.get(id);
90          if (provider == null) {
91              throw new InvalidDialogHandlerException(id, registry.keySet().toString());
92          }
93          return provider.getDialogHandler(request, response);
94      }
95  
96      /**
97       * Caution: use this method with care, as it creates an Dialog instance having ServletRequest
98       * and -Response as well as StorageNode being null.
99       */
100     public Dialog getDialog(String id) throws RepositoryException {
101         DialogHandlerProvider provider = registry.get(id);
102         if (provider == null) {
103             throw new InvalidDialogHandlerException(id, registry.keySet().toString());
104         }
105         return provider.getDialog();
106     }
107 
108     /**
109      * @return Returns the instance.
110      */
111     public static DialogHandlerManager getInstance() {
112         return Components.getSingleton(DialogHandlerManager.class);
113     }
114 
115 }