001: /*
002: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/flex/CmsFlexCacheConfiguration.java,v $
003: * Date : $Date: 2008-02-27 12:05:47 $
004: * Version: $Revision: 1.9 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.flex;
033:
034: /**
035: * Flex Cache configuration class.<p>
036: *
037: * @author Armen Markarian
038: *
039: * @version $Revision: 1.9 $
040: *
041: * @since 6.0.0
042: */
043: public class CmsFlexCacheConfiguration {
044:
045: private int m_avgCacheBytes;
046:
047: /** Indicates if the cache is enabled or not. */
048: private boolean m_cacheEnabled;
049:
050: /** Indicates if offline resources should be cached or not. */
051: private boolean m_cacheOffline;
052:
053: /**
054: * Sizing parameters for the cached "entries" (ie. pages) in the FlexCache.<p>
055: *
056: * The amount of server memory available obviously is the
057: * critical factor here. The values below are set in byte size.
058: * The default is 2mb memory for the cached pages _or_ a maximum of 4000
059: * cached page variations in total.
060: */
061: private int m_maxCacheBytes;
062:
063: private int m_maxEntryBytes;
064:
065: private int m_maxKeys;
066:
067: /**
068: * Empty public constructor for the digester.
069: */
070: public CmsFlexCacheConfiguration() {
071:
072: // empty public constructor for digester
073: }
074:
075: /**
076: * Returns the average cache bytes.<p>
077: *
078: * @return the average cache bytes
079: */
080: public int getAvgCacheBytes() {
081:
082: return m_avgCacheBytes;
083: }
084:
085: /**
086: * Returns the maxCacheBytes.<p>
087: *
088: * @return the maxCacheBytes
089: */
090: public int getMaxCacheBytes() {
091:
092: return m_maxCacheBytes;
093: }
094:
095: /**
096: * Returns the maxEntryBytes.<p>
097: *
098: * @return the maxEntryBytes
099: */
100: public int getMaxEntryBytes() {
101:
102: return m_maxEntryBytes;
103: }
104:
105: /**
106: * Returns the maxKeys.<p>
107: *
108: * @return the maxKeys
109: */
110: public int getMaxKeys() {
111:
112: return m_maxKeys;
113: }
114:
115: /**
116: * Initializes the flex cache configuration with required parameters.<p>
117: *
118: * @param enabled enables or disable the flexcache
119: * @param offline enable the flexcache for the offline project
120: * @param maxCacheBytes the max bytes for cache
121: * @param avgCacheBytes the average bytes for cache
122: * @param maxEntryBytes the max bytes for entry
123: * @param maxKeys the max keys
124: */
125: public void initialize(String enabled, String offline,
126: String maxCacheBytes, String avgCacheBytes,
127: String maxEntryBytes, String maxKeys) {
128:
129: setCacheEnabled(Boolean.valueOf(enabled).booleanValue());
130: setCacheOffline(Boolean.valueOf(offline).booleanValue());
131: setMaxCacheBytes(Integer.parseInt(maxCacheBytes));
132: setAvgCacheBytes(Integer.parseInt(avgCacheBytes));
133: setMaxEntryBytes(Integer.parseInt(maxEntryBytes));
134: setMaxKeys(Integer.parseInt(maxKeys));
135: }
136:
137: /**
138: * Checks if flexcache is enabled or not.<p>
139: *
140: * @return true if flexcache is enabled; otherwise false
141: */
142: public boolean isCacheEnabled() {
143:
144: return m_cacheEnabled;
145: }
146:
147: /**
148: * Checks the cacheOffline.<p>
149: *
150: * @return true if cacheoffline is set to true; otherwise false
151: */
152: public boolean isCacheOffline() {
153:
154: return m_cacheOffline;
155: }
156:
157: /**
158: * Sets the avgCacheBytes.<p>
159: *
160: * @param avgCacheBytes the avgCacheBytes to set
161: */
162: public void setAvgCacheBytes(int avgCacheBytes) {
163:
164: m_avgCacheBytes = avgCacheBytes;
165: }
166:
167: /**
168: * Sets the enabled.<p>
169: *
170: * @param enabled the enabled to set
171: */
172: public void setCacheEnabled(boolean enabled) {
173:
174: m_cacheEnabled = enabled;
175: }
176:
177: /**
178: * Sets the cacheOffline.<p>
179: *
180: * @param cacheOffline the cacheOffline to set
181: */
182: public void setCacheOffline(boolean cacheOffline) {
183:
184: m_cacheOffline = cacheOffline;
185: }
186:
187: /**
188: * Sets the maxCacheBytes.<p>
189: *
190: * @param maxCacheBytes the maxCacheBytes to set
191: */
192: public void setMaxCacheBytes(int maxCacheBytes) {
193:
194: m_maxCacheBytes = maxCacheBytes;
195: }
196:
197: /**
198: * Sets the maxEntryBytes.<p>
199: *
200: * @param maxEntryBytes the maxEntryBytes to set
201: */
202: public void setMaxEntryBytes(int maxEntryBytes) {
203:
204: m_maxEntryBytes = maxEntryBytes;
205: }
206:
207: /**
208: * Sets the maxKeys.<p>
209: *
210: * @param maxKeys the maxKeys to set
211: */
212: public void setMaxKeys(int maxKeys) {
213:
214: m_maxKeys = maxKeys;
215: }
216: }
|