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