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.registry.AbstractRegistry;
37  import info.magnolia.config.registry.DefinitionMetadataBuilder;
38  import info.magnolia.config.registry.DefinitionProvider;
39  import info.magnolia.config.registry.DefinitionProviderProblemLogger;
40  import info.magnolia.config.registry.DefinitionProviderWrapper;
41  import info.magnolia.config.registry.DefinitionType;
42  import info.magnolia.module.ModuleRegistry;
43  import info.magnolia.virtualuri.compatibility.VirtualUriMappingAdapter;
44  
45  import javax.inject.Inject;
46  import javax.inject.Singleton;
47  
48  import org.slf4j.Logger;
49  import org.slf4j.LoggerFactory;
50  
51  /**
52   * Registry for {@link VirtualUriMapping VirtualUriMappings}.
53   */
54  @Singleton
55  public class VirtualUriRegistry extends AbstractRegistry<VirtualUriMapping> {
56      private static final Logger log = LoggerFactory.getLogger(VirtualUriRegistry.class);
57  
58      static final DefinitionType TYPE = new DefinitionType() {
59          @Override
60          public String name() {
61              return "virtualUriMapping";
62          }
63  
64          @Override
65          public Class baseClass() {
66              return VirtualUriMapping.class;
67          }
68      };
69  
70      @Inject
71      public VirtualUriRegistry(ModuleRegistry moduleRegistry) {
72          super(moduleRegistry);
73      }
74  
75      @Override
76      public DefinitionType type() {
77          return TYPE;
78      }
79  
80      @Override
81      public DefinitionMetadataBuilder newMetadataBuilder() {
82          return DefinitionMetadataBuilder.usingModuleAndRelativePathAsId();
83      }
84  
85      @Override
86      protected DefinitionProvider<VirtualUriMapping> onRegister(DefinitionProvider<VirtualUriMapping> provider) {
87          return super.onRegister(newVirtualMappingProvider(provider));
88      }
89  
90      private DefinitionProvider<VirtualUriMapping> newVirtualMappingProvider(DefinitionProvider<VirtualUriMapping> provider) {
91  
92          if (provider.isValid()) {
93              if (provider.get() instanceof info.magnolia.cms.beans.config.VirtualURIMapping) {
94                  provider = new VirtualUriMappingCompatibilityProvider(provider);
95              }
96  
97              VirtualUriMappingProvider validatingProvider = new VirtualUriMappingProvider(provider);
98  
99              // Need to validate again base on VirtualUriMapping itself
100             if (!validatingProvider.isValid()) {
101 
102                 provider.getProblems().add(
103                         DefinitionProvider.Problem
104                                 .minor()
105                                 .withDetails(String.format("Config for %s is incomplete, mapping is disabled.", provider.get()))
106                                 .withType(DefinitionProvider.Problem.DefaultTypes.SEMANTIC)
107                                 .withTitle("VirtualUriMapping problem")
108                                 .build());
109 
110                 DefinitionProviderProblemLogger
111                         .withLoggingContext(log, true)
112                         .logProblems(provider);
113             }
114         }
115 
116         return provider;
117     }
118 
119 
120     /**
121      * Compatibility mapping provider for old {@link info.magnolia.cms.beans.config.VirtualURIMapping}.
122      */
123     static class VirtualUriMappingCompatibilityProvider extends DefinitionProviderWrapper<VirtualUriMapping> {
124 
125         VirtualUriMappingCompatibilityProvider(DefinitionProvider oldProvider) {
126             super(oldProvider);
127         }
128 
129         @Override
130         public VirtualUriMapping get() throws InvalidDefinitionException {
131             return new VirtualUriMappingAdapter((info.magnolia.cms.beans.config.VirtualURIMapping) super.get());
132         }
133     }
134 
135     /**
136      * Mapping provider for validating VirtualUriMapping.
137      */
138     static class VirtualUriMappingProvider extends DefinitionProviderWrapper<VirtualUriMapping> {
139 
140         protected VirtualUriMappingProvider(DefinitionProvider<VirtualUriMapping> delegate) {
141             super(delegate);
142         }
143 
144         @Override
145         public boolean isValid() {
146             return super.isValid() && get().isValid();
147         }
148     }
149 }