View Javadoc
1   /**
2    * This file Copyright (c) 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.virtualuri;
35  
36  import info.magnolia.config.source.ConfigurationSourceFactory;
37  import info.magnolia.module.ModuleLifecycle;
38  import info.magnolia.module.ModuleLifecycleContext;
39  
40  import javax.inject.Inject;
41  
42  /**
43   * The virtual-uri module binds JCR and YAML configuration sources to the {@link VirtualUriRegistry}.
44   */
45  public class VirtualUriModule implements ModuleLifecycle {
46  
47      private final VirtualUriRegistry virtualUriRegistry;
48      private final ConfigurationSourceFactory configSourceFactory;
49  
50      @Inject
51      public VirtualUriModule(VirtualUriRegistry virtualUriRegistry, ConfigurationSourceFactory configSourceFactory) {
52          this.virtualUriRegistry = virtualUriRegistry;
53          this.configSourceFactory = configSourceFactory;
54      }
55  
56      @Override
57      public void start(ModuleLifecycleContext moduleLifecycleContext) {
58          if (moduleLifecycleContext.getPhase() == ModuleLifecycleContext.PHASE_SYSTEM_STARTUP) {
59              // explicitly add former JCR lookup path within modules: bound to be removed along with compatibility adapters
60              configSourceFactory.jcr().withModulePath("virtualURIMapping").bindTo(virtualUriRegistry);
61              // mappings are now looked up in <module>/virtualUriMappings (plural & camel-case acronym)
62              configSourceFactory.jcr().bindWithDefaults(virtualUriRegistry);
63              configSourceFactory.yaml().bindWithDefaults(virtualUriRegistry);
64          }
65      }
66  
67      @Override
68      public void stop(ModuleLifecycleContext moduleLifecycleContext) {
69      }
70  }