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 javax.inject.Singleton;
37  
38  import info.magnolia.objectfactory.Components;
39  
40  
41  /**
42   * Versioning configuration. Defines if versions are created and how many version are kept.
43   * @author Sameer Charles
44   * $Id: VersionConfig.java 48388 2011-08-17 08:29:13Z dlipp $
45   */
46  @Singleton
47  public class VersionConfig {
48  
49      /**
50       * maximum index to keep.
51       */
52      public static final String MAX_VERSION_INDEX = "maxVersionIndex";
53  
54      /**
55       * is versioning is active. (at application level, JCR is always configured to version if implemented)
56       */
57      public static final String ACTIVE = "active";
58  
59      /**
60       * maximum number of version index.
61       */
62      private static long maxVersions = 2; // default is 3 which could be overwritten through config
63  
64      public VersionConfig() {
65          // do not instantiate
66      }
67  
68      /**
69       * @deprecated since 4.5, use IoC !
70       */
71      public static VersionConfig getInstance() {
72          return Components.getSingleton(VersionConfig.class);
73      }
74  
75      /**
76       * Initialize bean.
77       */
78      public void init() {
79          load();
80      }
81  
82      /**
83       * Its a fixed config bean.
84       */
85      public void load() {
86          // nothing to do
87      }
88  
89      /**
90       * Read config and reload bean.
91       */
92      public void reload() {
93          load();
94      }
95  
96      /**
97       * Checks active flag in version config.
98       * @return true if versioning is active at application level
99       */
100     public boolean isActive() {
101         return true;
102     }
103 
104     /**
105      * Get maximum number of versions allowed in version history.
106      * @return max version index
107      */
108     public long getMaxVersionAllowed() {
109         return maxVersions;
110     }
111 
112 }