001/* 002 * This library is part of OpenCms - 003 * the Open Source Content Management System 004 * 005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com) 006 * 007 * This library is free software; you can redistribute it and/or 008 * modify it under the terms of the GNU Lesser General Public 009 * License as published by the Free Software Foundation; either 010 * version 2.1 of the License, or (at your option) any later version. 011 * 012 * This library is distributed in the hope that it will be useful, 013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 015 * Lesser General Public License for more details. 016 * 017 * For further information about Alkacon Software GmbH & Co. KG, please see the 018 * company website: http://www.alkacon.com 019 * 020 * For further information about OpenCms, please see the 021 * project website: http://www.opencms.org 022 * 023 * You should have received a copy of the GNU Lesser General Public 024 * License along with this library; if not, write to the Free Software 025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 026 */ 027 028package org.opencms.file; 029 030import org.opencms.gwt.shared.CmsGwtConstants; 031import org.opencms.main.CmsIllegalArgumentException; 032import org.opencms.util.A_CmsModeIntEnumeration; 033import org.opencms.util.CmsStringUtil; 034import org.opencms.util.CmsUUID; 035 036/** 037 * Defines a property name, so that <code>{@link CmsProperty}</code> instances can be created with that name.<p> 038 * 039 * @since 6.0.0 040 */ 041public class CmsPropertyDefinition implements Cloneable, Comparable<CmsPropertyDefinition> { 042 043 /** 044 * Enumeration class for property types.<p> 045 */ 046 public static final class CmsPropertyType extends A_CmsModeIntEnumeration { 047 048 /** Property value is treated as a link or list of links. */ 049 protected static final CmsPropertyType LINK = new CmsPropertyType(1); 050 051 /** Property value is not a link. */ 052 protected static final CmsPropertyType NORMAL = new CmsPropertyType(0); 053 054 /** serializable version id. */ 055 private static final long serialVersionUID = 74746076708908673L; 056 057 /** 058 * Creates a new property type with the given identifier.<p> 059 * 060 * @param type the mode id to use 061 */ 062 private CmsPropertyType(int type) { 063 064 super(type); 065 } 066 067 /** 068 * Returns the property definition type for the given type id. <p> 069 * 070 * If the given String matches no known type <code>{@link #NORMAL}</code> 071 * will be returned as the default.<p> 072 * 073 * @param type the type value to get the property type for 074 * 075 * @return the property type for the given type value 076 */ 077 public static CmsPropertyType valueOf(int type) { 078 079 switch (type) { 080 case 1: 081 return LINK; 082 case 0: 083 default: 084 return NORMAL; 085 } 086 087 } 088 } 089 090 /** The name constraints when generating new properties. */ 091 public static final String NAME_CONSTRAINTS = "-._~$"; 092 093 /** Property for the active method in the administration view. */ 094 public static final String PROPERTY_ACTIV = "activemethod"; 095 096 /** Property for the allowed set of locales. */ 097 public static final String PROPERTY_AVAILABLE_LOCALES = "locale-available"; 098 099 /** Property to control the Java class for body. */ 100 public static final String PROPERTY_BODY_CLASS = "templateclass"; 101 102 /** The name of the VFS property that controls the caching. */ 103 public static final String PROPERTY_CACHE = "cache"; 104 105 /** Property to define the function detail container for a template. */ 106 public static final String PROPERTY_CONTAINER_INFO = "container.info"; 107 108 /** Property for the content conversion. */ 109 public static final String PROPERTY_CONTENT_CONVERSION = "content-conversion"; 110 111 /** Property for the content encoding. */ 112 public static final String PROPERTY_CONTENT_ENCODING = "content-encoding"; 113 114 /** Property for the content encoding. */ 115 public static final String PROPERTY_COPYRIGHT = "Copyright"; 116 117 /** Property for the default file in folders. */ 118 public static final String PROPERTY_DEFAULT_FILE = "default-file"; 119 120 /** Property for the days a resource has to be expired to be deleted by the <code>{@link org.opencms.scheduler.jobs.CmsDeleteExpiredResourcesJob}</code>. */ 121 public static final String PROPERTY_DELETE_EXPIRED = "delete.expired"; 122 123 /** Property for the description. */ 124 public static final String PROPERTY_DESCRIPTION = "Description"; 125 126 /** Property for the description in HTML format. */ 127 public static final String PROPERTY_DESCRIPTION_HTML = "Description.html"; 128 129 /** Property to set the display order of a content in lists. */ 130 public static final String PROPERTY_DISPLAY_ORDER = "display-order"; 131 132 /** The name of the property which controls whether an element will be used as a copy model by the container page editor. */ 133 public static final String PROPERTY_ELEMENT_MODEL = "element.model"; 134 135 /** May contain a path to an element replacement configuration, for use in the 'copy page' dialog. */ 136 public static final String PROPERTY_ELEMENT_REPLACEMENTS = "element.replacements"; 137 138 /** Property for the resource title. */ 139 public static final String PROPERTY_ENABLE_NOTIFICATION = "enable-notification"; 140 141 /** Property for the static export. */ 142 public static final String PROPERTY_EXPORT = "export"; 143 144 /** Property for the resource export name, during export this name is used instead of the resource name. */ 145 public static final String PROPERTY_EXPORTNAME = "exportname"; 146 147 /** Property for JSP additional suffix during static export, default is "html". */ 148 public static final String PROPERTY_EXPORTSUFFIX = "exportsuffix"; 149 150 /** Property to control the folders where template or default bodies should be available. */ 151 public static final String PROPERTY_FOLDERS_AVAILABLE = "folders.available"; 152 153 /** Property stating where to create new gallery folders. */ 154 public static final String PROPERTY_GALLERIES_FOLDER = "galleries.folder"; 155 156 /** Property containing the maps API key. */ 157 public static final String PROPERTY_GOOGLE_API_KEY = "google.apikey"; 158 159 /** Property containing the maps API key. */ 160 public static final String PROPERTY_GOOGLE_API_KEY_WORKPLACE = "google.apikey.workplace"; 161 162 /** Name of the property in which the focal point is stored. */ 163 public static final String PROPERTY_IMAGE_FOCAL_POINT = CmsGwtConstants.PROPERTY_IMAGE_FOCALPOINT; 164 165 /** Property constant for <code>"image.size"</code>. */ 166 public static final String PROPERTY_IMAGE_SIZE = "image.size"; 167 168 /** The property for defining the date (as Solr field) that should be used for sorting in lists. */ 169 public static final String PROPERTY_INSTANCEDATE_COPYFIELD = "instancedate.copyfield"; 170 171 /** Property for the keywords. */ 172 public static final String PROPERTY_KEYWORDS = "Keywords"; 173 174 /** Property for the current locale. */ 175 public static final String PROPERTY_LOCALE = "locale"; 176 177 /** Property to mark detail pages to have locale independent detail only containers. */ 178 public static final String PROPERTY_LOCALE_INDEPENDENT_DETAILS = "locale.independent-details"; 179 180 /** Property for the 'do not translate' marking in the sitemap editor. */ 181 public static final String PROPERTY_LOCALE_NOTRANSLATION = "locale.notranslation"; 182 183 /** Property for the login form. */ 184 public static final String PROPERTY_LOGIN_FORM = "login-form"; 185 186 /** Property constant for <code>"NavImage"</code>. */ 187 public static final String PROPERTY_NAVIMAGE = "NavImage"; 188 189 /** Property constant for <code>"NavInfo"</code>. */ 190 public static final String PROPERTY_NAVINFO = "NavInfo"; 191 192 /** Property for the navigation position. */ 193 public static final String PROPERTY_NAVPOS = "NavPos"; 194 195 /** Property for the navigation text. */ 196 public static final String PROPERTY_NAVTEXT = "NavText"; 197 198 /** Property for the resource title. */ 199 public static final String PROPERTY_NOTIFICATION_INTERVAL = "notification-interval"; 200 201 /** Property for the relative root link substitution. */ 202 public static final String PROPERTY_RELATIVEROOT = "relativeroot"; 203 204 /** Property name that defines the available resource types for the "new" dialog. */ 205 public static final String PROPERTY_RESTYPES_AVAILABLE = "restypes.available"; 206 207 /** Property to sort search results in categories. */ 208 public static final String PROPERTY_SEARCH_CATEGORY = "category"; 209 210 /** Property to exclude individual resources from search index generation. */ 211 public static final String PROPERTY_SEARCH_EXCLUDE = "search.exclude"; 212 213 /** Property to boost certain search results. */ 214 public static final String PROPERTY_SEARCH_PRIORITY = "search.priority"; 215 216 /** Property for secondary locales for use in the locale compare view in the sitemap editor. */ 217 public static final String PROPERTY_SECONDARY_LOCALES = "locale.secondary"; 218 219 /** Property for the secure transmission of resources. */ 220 public static final String PROPERTY_SECURE = "secure"; 221 222 /** Property for the stylesheet of files. */ 223 public static final String PROPERTY_STYLESHEET = "stylesheet"; 224 225 /** Property to control the template. */ 226 public static final String PROPERTY_TEMPLATE = "template"; 227 228 /** Property for specifying a list of container types used to match formatters in the display formatter selection widget. */ 229 public static final String PROPERTY_TEMPLATE_DISPLAY_TYPES = "template.display.types"; 230 231 /** Property to control the template elements. */ 232 public static final String PROPERTY_TEMPLATE_ELEMENTS = "template-elements"; 233 234 /** Property for the template image. */ 235 public static final String PROPERTY_TEMPLATE_IMAGE = "template.image"; 236 237 /** Property to configure the value which should be used instead of the template path when selecting the template in the GUI. Please note that this does not have to actually be a template provider configuration string, this is just the most common use case. */ 238 public static final String PROPERTY_TEMPLATE_PROVIDER = "template.provider"; 239 240 /** Property for the resource title. */ 241 public static final String PROPERTY_TITLE = "Title"; 242 243 /** Name of the property used to control whether mapped URL names should replace previous URL names. */ 244 public static final String PROPERTY_URLNAME_REPLACE = "urlname.replace"; 245 246 /** Property for the visible method in the administration view. */ 247 public static final String PROPERTY_VISIBLE = "visiblemethod"; 248 249 /** Property for the XML sitemap change frequency. */ 250 public static final String PROPERTY_XMLSITEMAP_CHANGEFREQ = "xmlsitemap.changefreq"; 251 252 /** Property for the XML sitemap priority. */ 253 public static final String PROPERTY_XMLSITEMAP_PRIORITY = "xmlsitemap.priority"; 254 255 /** The property definition type for resources. */ 256 public static final int PROPERYDEFINITION_RESOURCE = 1; 257 258 /** Property value is treated as a link or list of links. */ 259 public static final CmsPropertyType TYPE_LINK = CmsPropertyType.LINK; 260 261 /** Property value is not a link. */ 262 public static final CmsPropertyType TYPE_NORMAL = CmsPropertyType.NORMAL; 263 264 /** The null property definition object. */ 265 private static final CmsPropertyDefinition NULL_PROPERTY_DEFINITION = new CmsPropertyDefinition( 266 CmsUUID.getNullUUID(), 267 "", 268 TYPE_NORMAL); 269 270 /** The id of this property definition. */ 271 private CmsUUID m_id; 272 273 /** The name of this property definition. */ 274 private String m_name; 275 276 /** The type of this property definition.*/ 277 private CmsPropertyType m_type; 278 279 /** 280 * Creates a new property definition object with the type 281 * <code>{@link #TYPE_NORMAL}</code>.<p> 282 * 283 * @param id the id of the property definition 284 * @param name the name of the property definition 285 */ 286 public CmsPropertyDefinition(CmsUUID id, String name) { 287 288 this(id, name, TYPE_NORMAL); 289 } 290 291 /** 292 * Creates a new property definition object.<p> 293 * 294 * @param id the id of the property definition 295 * @param name the name of the property definition 296 * @param propertyType the type of the property 297 */ 298 public CmsPropertyDefinition(CmsUUID id, String name, CmsPropertyType propertyType) { 299 300 m_id = id; 301 m_name = name; 302 m_type = propertyType; 303 } 304 305 /** 306 * Checks if the provided property name is a valid property name, 307 * that is contains only valid characters.<p> 308 * 309 * A property name can only be composed of digits, 310 * standard ASCII letters and the symbols defined in {@link #NAME_CONSTRAINTS}.<p> 311 * 312 * @param name the property name to check 313 * 314 * @throws CmsIllegalArgumentException if the given property name is not valid 315 */ 316 public static void checkPropertyName(String name) throws CmsIllegalArgumentException { 317 318 if (CmsStringUtil.isEmptyOrWhitespaceOnly(name)) { 319 throw new CmsIllegalArgumentException( 320 Messages.get().container(Messages.ERR_BAD_PROPERTYNAME_EMPTY_0, name)); 321 } 322 323 CmsStringUtil.checkName(name, NAME_CONSTRAINTS, Messages.ERR_BAD_PROPERTYNAME_4, Messages.get()); 324 } 325 326 /** 327 * Returns the null property definition.<p> 328 * 329 * @return the null property definition 330 */ 331 public static CmsPropertyDefinition getNullPropertyDefinition() { 332 333 return CmsPropertyDefinition.NULL_PROPERTY_DEFINITION; 334 } 335 336 /** 337 * Returns a clone of this Objects instance.<p> 338 * 339 * @return a clone of this instance 340 */ 341 @Override 342 public Object clone() { 343 344 return new CmsPropertyDefinition(m_id, m_name, m_type); 345 } 346 347 /** 348 * @see java.lang.Comparable#compareTo(java.lang.Object) 349 */ 350 public int compareTo(CmsPropertyDefinition obj) { 351 352 if (obj == this) { 353 return 0; 354 } 355 return m_name.compareTo(obj.m_name); 356 } 357 358 /** 359 * @see java.lang.Object#equals(java.lang.Object) 360 */ 361 @Override 362 public boolean equals(Object obj) { 363 364 if (obj == this) { 365 return true; 366 } 367 if (obj instanceof CmsPropertyDefinition) { 368 return ((CmsPropertyDefinition)obj).m_id.equals(m_id); 369 } 370 return false; 371 } 372 373 /** 374 * Returns the id of this property definition.<p> 375 * 376 * @return id the id of this Propertydefinition 377 */ 378 public CmsUUID getId() { 379 380 return m_id; 381 } 382 383 /** 384 * Returns the name of this property definition.<p> 385 * 386 * @return name The name of this property definition 387 */ 388 public String getName() { 389 390 return m_name; 391 } 392 393 /** 394 * Returns the the type of this property definition.<p> 395 * 396 * @return the type of this property definition 397 */ 398 public CmsPropertyType getType() { 399 400 return m_type; 401 } 402 403 /** 404 * @see java.lang.Object#hashCode() 405 */ 406 @Override 407 public int hashCode() { 408 409 if (m_name != null) { 410 return m_name.hashCode(); 411 } 412 return 0; 413 } 414 415 /** 416 * Sets the type for this property definition.<p> 417 * 418 * @param type the type to set 419 */ 420 public void setType(CmsPropertyType type) { 421 422 m_type = type; 423 } 424 425 /** 426 * @see java.lang.Object#toString() 427 */ 428 @Override 429 public String toString() { 430 431 StringBuffer result = new StringBuffer(); 432 result.append("[Propertydefinition]"); 433 result.append(" name:"); 434 result.append(m_name); 435 result.append(" id:"); 436 result.append(m_id); 437 result.append(" type:"); 438 result.append(m_type); 439 return result.toString(); 440 } 441}