View Javadoc
1   /**
2    * This file Copyright (c) 2003-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.cms.beans.config;
35  
36  import info.magnolia.jcr.node2bean.Node2BeanException;
37  import info.magnolia.jcr.node2bean.Node2BeanProcessor;
38  import info.magnolia.jcr.node2bean.TransformationState;
39  import info.magnolia.jcr.node2bean.impl.Node2BeanTransformerImpl;
40  import info.magnolia.objectfactory.ComponentProvider;
41  import info.magnolia.objectfactory.Components;
42  import info.magnolia.objectfactory.ObservedComponentFactory;
43  import info.magnolia.repository.RepositoryConstants;
44  
45  import java.util.Map;
46  
47  import javax.inject.Singleton;
48  import javax.jcr.Node;
49  import javax.jcr.RepositoryException;
50  
51  /**
52   * Holds the basic server configuration info.
53   */
54  @Singleton
55  public class ServerConfiguration {
56      private String defaultExtension;
57      private String defaultBaseUrl;
58      private String instanceUuid;
59      private boolean admin;
60      private boolean usageMetrics = true;
61  
62      public String getDefaultExtension() {
63          return defaultExtension;
64      }
65  
66      public void setDefaultExtension(String defaultExtension) {
67          this.defaultExtension = defaultExtension;
68      }
69  
70      public String getDefaultBaseUrl() {
71          return defaultBaseUrl;
72      }
73  
74      public void setDefaultBaseUrl(String defaultBaseUrl) {
75          this.defaultBaseUrl = defaultBaseUrl;
76      }
77  
78  
79      public String getInstanceUuid() {
80          return instanceUuid;
81      }
82  
83      public void setInstanceUuid(String instanceUuid) {
84          this.instanceUuid = instanceUuid;
85      }
86  
87      public boolean isAdmin() {
88          return admin;
89      }
90  
91      public void setAdmin(boolean admin) {
92          this.admin = admin;
93      }
94  
95      public boolean isUsageMetrics() {
96          return usageMetrics;
97      }
98  
99      public void setUsageMetrics(boolean usageMetrics) {
100         this.usageMetrics = usageMetrics;
101     }
102 
103     /**
104      * @deprecated since 4.5, use IoC
105      */
106     @Deprecated
107     public static ServerConfiguration getInstance() {
108         return Components.getSingleton(ServerConfiguration.class);
109     }
110 
111     /**
112      * A special instance factory preventing recursive instantiation. The server configuration contains sub-nodes but only the direct properties belong to the server configuration bean.
113      */
114     public static final class InstanceFactory extends ObservedComponentFactory<ServerConfiguration> {
115         public InstanceFactory() {
116             super(RepositoryConstants.CONFIG, "/server", ServerConfiguration.class);
117         }
118 
119         // the false parameter here is the important thing to keep (not recursive)
120         @Override
121         protected ServerConfiguration transformNode(Node node) throws Node2BeanException, RepositoryException {
122             return (ServerConfiguration) Components.getComponent(Node2BeanProcessor.class).toBean(node, false, new Node2BeanTransformerImpl() {
123                 @Override
124                 public Object newBeanInstance(TransformationState state, Map properties, ComponentProvider componentProvider) {
125                     return new ServerConfiguration();
126                 }
127             }, Components.getComponentProvider());
128         }
129     }
130 }