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.cms.beans.config;
35  
36  import info.magnolia.cms.core.Content;
37  import info.magnolia.content2bean.Content2BeanException;
38  import info.magnolia.content2bean.Content2BeanUtil;
39  import info.magnolia.content2bean.TransformationState;
40  import info.magnolia.content2bean.impl.Content2BeanTransformerImpl;
41  import info.magnolia.objectfactory.ComponentProvider;
42  import info.magnolia.objectfactory.Components;
43  import info.magnolia.objectfactory.ObservedComponentFactory;
44  import info.magnolia.repository.RepositoryConstants;
45  
46  import java.util.Map;
47  
48  import javax.inject.Singleton;
49  
50  /**
51   * Holds the basic server configuration info.
52   *
53   * @version $Revision: $ ($Author: $)
54   */
55  @Singleton
56  public class ServerConfiguration {
57      private String defaultExtension;
58      private String defaultBaseUrl;
59      private boolean admin;
60  
61      public String getDefaultExtension() {
62          return defaultExtension;
63      }
64  
65      public void setDefaultExtension(String defaultExtension) {
66          this.defaultExtension = defaultExtension;
67      }
68  
69      public String getDefaultBaseUrl() {
70          return defaultBaseUrl;
71      }
72  
73      public void setDefaultBaseUrl(String defaultBaseUrl) {
74          this.defaultBaseUrl = defaultBaseUrl;
75      }
76  
77      public boolean isAdmin() {
78          return admin;
79      }
80  
81      public void setAdmin(boolean admin) {
82          this.admin = admin;
83      }
84  
85      /**
86       * @deprecated since 4.5, use IoC
87       */
88      @Deprecated
89      public static ServerConfiguration getInstance() {
90          return Components.getSingleton(ServerConfiguration.class);
91      }
92  
93      /**
94       * A special instance factory preventing recursive instantiation. The server configuration contains sub-nodes but only the direct properties belong to the server configuration bean.
95       */
96      public static final class InstanceFactory extends ObservedComponentFactory<ServerConfiguration> {
97          public InstanceFactory() {
98              super(RepositoryConstants.CONFIG, "/server", ServerConfiguration.class);
99          }
100 
101         // the false parameter here is the important thing to keep (not recursive)
102         @Override
103         protected ServerConfiguration transformNode(Content node) throws Content2BeanException {
104             return (ServerConfiguration) Content2BeanUtil.toBean(node, false, new Content2BeanTransformerImpl() {
105                 @Override
106                 public Object newBeanInstance(TransformationState state, Map properties, ComponentProvider componentProvider) {
107                     return new ServerConfiguration();
108                 }
109             });
110         }
111     }
112 }