org.opencms.db.CmsCacheSettings Maven / Gradle / Ivy
Show all versions of opencms-core Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.db;
/**
* The settings of the OpenCms memory monitor.
*
* @since 6.0.0
*/
public class CmsCacheSettings {
/** The size of the memory monitor's cache for ACLs. */
private int m_aclCacheSize;
/** The name of the class to generate cache keys. */
private String m_cacheKeyGenerator;
/** The size of the memory monitor's cache for groups. */
private int m_groupCacheSize;
/** The size of the memory monitor's cache for organizational units. */
private int m_orgUnitCacheSize = -1; // this configuration entry is optional
/** The size of the memory monitor's cache for permission checks. */
private int m_permissionCacheSize;
/** The size of the memory monitor's cache for projects. */
private int m_projectCacheSize;
/** The size of the memory monitor's cache for project resources. */
private int m_projectResourcesCacheSize = -1; // this configuration entry is optional
/** The size of the memory monitor's cache for properties. */
private int m_propertyCacheSize;
/** The size of the memory monitor's cache for property lists. */
private int m_propertyListsCacheSize = -1; // this configuration entry is optional
/** The size of the memory monitor's cache for resources. */
private int m_resourceCacheSize;
/** The size of the memory monitor's cache for lists of resources. */
private int m_resourcelistCacheSize;
/** The size of the memory monitor's cache for roles. */
private int m_rolesCacheSize = -1; // this configuration entry is optional
/** The size of the memory monitor's cache for users. */
private int m_userCacheSize;
/** The size of the memory monitor's cache for user/group relations. */
private int m_userGroupsCacheSize;
/**
* Default constructor.
*/
public CmsCacheSettings() {
super();
}
/**
* Returns the size of the memory monitor's cache for ACLs.
*
* @return the size of the memory monitor's cache for ACLs
*/
public int getAclCacheSize() {
return m_aclCacheSize;
}
/**
* Returns the name of the class to generate cache keys.
*
* @return the name of the class to generate cache keys
*/
public String getCacheKeyGenerator() {
return m_cacheKeyGenerator;
}
/**
* Returns the size of the memory monitor's cache for organizational units.
*
* Might be -1 if configuration entry is missing.
*
* @return the size of the memory monitor's cache for organizational units
*/
public int getConfiguredOrgUnitCacheSize() {
return m_orgUnitCacheSize;
}
/**
* Returns the size of the memory monitor's cache for project resources.
*
* Might be -1 if configuration entry is missing.
*
* @return the size of the memory monitor's cache for project resources
*/
public int getConfiguredProjectResourcesCacheSize() {
return m_projectResourcesCacheSize;
}
/**
* Returns the size of the memory monitor's cache for property lists.
*
* Might be -1 if configuration entry is missing.
*
* @return the size of the memory monitor's cache for property lists
*/
public int getConfiguredPropertyListsCacheSize() {
return m_propertyListsCacheSize;
}
/**
* Returns the size of the memory monitor's cache for roles.
*
* Might be -1 if configuration entry is missing.
*
* @return the size of the memory monitor's cache for roles
*/
public int getConfiguredRolesCacheSize() {
return m_rolesCacheSize;
}
/**
* Returns the size of the memory monitor's cache for groups.
*
* @return the size of the memory monitor's cache for groups
*/
public int getGroupCacheSize() {
return m_groupCacheSize;
}
/**
* Returns the size of the memory monitor's cache for organizational units.
*
* @return the size of the memory monitor's cache for organizational units
*/
public int getOrgUnitCacheSize() {
if (m_orgUnitCacheSize < 0) {
return getGroupCacheSize();
}
return m_orgUnitCacheSize;
}
/**
* Returns the size of the memory monitor's cache for permission checks.
*
* @return the size of the memory monitor's cache for permission checks
*/
public int getPermissionCacheSize() {
return m_permissionCacheSize;
}
/**
* Returns the size of the memory monitor's cache for projects.
*
* @return the size of the memory monitor's cache for projects
*/
public int getProjectCacheSize() {
return m_projectCacheSize;
}
/**
* Returns the size of the memory monitor's cache for project resources.
*
* @return the size of the memory monitor's cache for project resources
*/
public int getProjectResourcesCacheSize() {
if (m_propertyListsCacheSize < 0) {
return getProjectCacheSize();
}
return m_projectResourcesCacheSize;
}
/**
* Returns the size of the memory monitor's cache for properties.
*
* @return the size of the memory monitor's cache for properties
*/
public int getPropertyCacheSize() {
return m_propertyCacheSize;
}
/**
* Returns the size of the memory monitor's cache for property lists.
*
* @return the size of the memory monitor's cache for property lists
*/
public int getPropertyListsCacheSize() {
if (m_propertyListsCacheSize < 0) {
return getPropertyCacheSize();
}
return m_propertyListsCacheSize;
}
/**
* Returns the size of the memory monitor's cache for resources.
*
* @return the size of the memory monitor's cache for resources
*/
public int getResourceCacheSize() {
return m_resourceCacheSize;
}
/**
* Returns the size of the memory monitor's cache for lists of resources.
*
* @return the size of the memory monitor's cache for lists of resources
*/
public int getResourcelistCacheSize() {
return m_resourcelistCacheSize;
}
/**
* Returns the size of the memory monitor's cache for roles.
*
* @return the size of the memory monitor's cache for roles
*/
public int getRolesCacheSize() {
if (m_rolesCacheSize < 0) {
return getPermissionCacheSize();
}
return m_rolesCacheSize;
}
/**
* Returns the size of the memory monitor's cache for users.
*
* @return the size of the memory monitor's cache for users
*/
public int getUserCacheSize() {
return m_userCacheSize;
}
/**
* Returns the size of the memory monitor's cache for user/group relations.
*
* @return the size of the memory monitor's cache for user/group relations
*/
public int getUserGroupsCacheSize() {
return m_userGroupsCacheSize;
}
/**
* Sets the size of the memory monitor's cache for ACLs.
*
* @param size the size of the memory monitor's cache for ACLs
*/
public void setAclCacheSize(String size) {
m_aclCacheSize = getIntValue(size, 1024);
}
/**
* Sets the name of the class to generate cache keys.
*
* @param classname the name of the class to generate cache keys
*/
public void setCacheKeyGenerator(String classname) {
m_cacheKeyGenerator = classname;
}
/**
* Sets the size of the memory monitor's cache for groups.
*
* @param size the size of the memory monitor's cache for groups
*/
public void setGroupCacheSize(String size) {
m_groupCacheSize = getIntValue(size, 64);
}
/**
* Sets the size of the memory monitor's cache for organizational units.
*
* @param size the size of the memory monitor's cache for organizational units
*/
public void setOrgUnitCacheSize(String size) {
m_orgUnitCacheSize = getIntValue(size, 64);
}
/**
* Sets the size of the memory monitor's cache for permission checks.
*
* @param size the size of the memory monitor's cache for permission checks
*/
public void setPermissionCacheSize(String size) {
m_permissionCacheSize = getIntValue(size, 1024);
}
/**
* Sets the size of the memory monitor's cache for projects.
*
* @param size the size of the memory monitor's cache for projects
*/
public void setProjectCacheSize(String size) {
m_projectCacheSize = getIntValue(size, 32);
}
/**
* Sets the size of the memory monitor's cache for project resources.
*
* @param size the size of the memory monitor's cache for project resources
*/
public void setProjectResourcesCacheSize(String size) {
m_projectResourcesCacheSize = getIntValue(size, -1);
}
/**
* Sets the size of the memory monitor's cache for properties.
*
* @param size the size of the memory monitor's cache for properties
*/
public void setPropertyCacheSize(String size) {
m_propertyCacheSize = getIntValue(size, 128);
}
/**
* Sets the size of the memory monitor's cache for property lists.
*
* @param size the size of the memory monitor's cache for property lists
*/
public void setPropertyListsCacheSize(String size) {
m_propertyListsCacheSize = getIntValue(size, -1);
}
/**
* Sets the size of the memory monitor's cache for resources.
*
* @param size the size of the memory monitor's cache for resources
*/
public void setResourceCacheSize(String size) {
m_resourceCacheSize = getIntValue(size, 8192);
}
/**
* Sets the size of the memory monitor's cache for lists of resources.
*
* @param size the size of the memory monitor's cache for lists of resources
*/
public void setResourcelistCacheSize(String size) {
m_resourcelistCacheSize = getIntValue(size, 256);
}
/**
* Sets the size of the memory monitor's cache for roles.
*
* @param size the size of the memory monitor's cache for roles
*/
public void setRolesCacheSize(String size) {
m_rolesCacheSize = getIntValue(size, 8192);
}
/**
* Sets the size of the memory monitor's cache for users.
*
* @param size the size of the memory monitor's cache for users
*/
public void setUserCacheSize(String size) {
m_userCacheSize = getIntValue(size, 64);
}
/**
* Sets the size of the memory monitor's cache for user/group relations.
*
* @param size the size of the memory monitor's cache for user/group relations
*/
public void setUserGroupsCacheSize(String size) {
m_userGroupsCacheSize = getIntValue(size, 256);
}
/**
* Turns a string into an int.
*
* @param str the string to be converted
* @param defaultValue a default value to be returned in case the string could not be parsed or the parsed int value is <= 0
* @return the int value of the string
*/
private int getIntValue(String str, int defaultValue) {
try {
int intValue = Integer.parseInt(str);
return (intValue > 0) ? intValue : defaultValue;
} catch (NumberFormatException e) {
// intentionally left blank
}
return defaultValue;
}
}