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 /** The property to read an additional category folder from. */ 106 public static final String PROPERTY_CATEGORY_REPOSITORY = "category.repository"; 107 108 /** Property to define the function detail container for a template. */ 109 public static final String PROPERTY_CONTAINER_INFO = "container.info"; 110 111 /** Property for the content conversion. */ 112 public static final String PROPERTY_CONTENT_CONVERSION = "content-conversion"; 113 114 /** Property for the content encoding. */ 115 public static final String PROPERTY_CONTENT_ENCODING = "content-encoding"; 116 117 /** Property for the content encoding. */ 118 public static final String PROPERTY_COPYRIGHT = "Copyright"; 119 120 /** Property for the default file in folders. */ 121 public static final String PROPERTY_DEFAULT_FILE = "default-file"; 122 123 /** Property for the days a resource has to be expired to be deleted by the <code>{@link org.opencms.scheduler.jobs.CmsDeleteExpiredResourcesJob}</code>. */ 124 public static final String PROPERTY_DELETE_EXPIRED = "delete.expired"; 125 126 /** Property for the description. */ 127 public static final String PROPERTY_DESCRIPTION = "Description"; 128 129 /** Property for the description in HTML format. */ 130 public static final String PROPERTY_DESCRIPTION_HTML = "Description.html"; 131 132 /** Property to set the display order of a content in lists. */ 133 public static final String PROPERTY_DISPLAY_ORDER = "display-order"; 134 135 /** The name of the property which controls whether an element will be used as a copy model by the container page editor. */ 136 public static final String PROPERTY_ELEMENT_MODEL = "element.model"; 137 138 /** May contain a path to an element replacement configuration, for use in the 'copy page' dialog. */ 139 public static final String PROPERTY_ELEMENT_REPLACEMENTS = "element.replacements"; 140 141 /** Property for the resource title. */ 142 public static final String PROPERTY_ENABLE_NOTIFICATION = "enable-notification"; 143 144 /** Property for the static export. */ 145 public static final String PROPERTY_EXPORT = "export"; 146 147 /** Property used to record the resource type for resources whose type is unknown at import time, so they can be exported with that type later. */ 148 public static final String PROPERTY_EXPORT_TYPE = "export.type"; 149 150 /** Property for the resource export name, during export this name is used instead of the resource name. */ 151 public static final String PROPERTY_EXPORTNAME = "exportname"; 152 153 /** Property for JSP additional suffix during static export, default is "html". */ 154 public static final String PROPERTY_EXPORTSUFFIX = "exportsuffix"; 155 156 /** Property to control the folders where template or default bodies should be available. */ 157 public static final String PROPERTY_FOLDERS_AVAILABLE = "folders.available"; 158 159 /** Property stating where to create new gallery folders. */ 160 public static final String PROPERTY_GALLERIES_FOLDER = "galleries.folder"; 161 162 /** Property containing the maps API key. */ 163 public static final String PROPERTY_GOOGLE_API_KEY = "google.apikey"; 164 165 /** Property containing the maps API key. */ 166 public static final String PROPERTY_GOOGLE_API_KEY_WORKPLACE = "google.apikey.workplace"; 167 168 /** Property to control whether historic versions should be removed when deleted resources are published. */ 169 public static final String PROPERTY_HISTORY_REMOVE_DELETED = "history.removedeleted"; 170 171 /** Name of the property in which the focal point is stored. */ 172 public static final String PROPERTY_IMAGE_FOCAL_POINT = CmsGwtConstants.PROPERTY_IMAGE_FOCALPOINT; 173 174 /** Property constant for <code>"image.size"</code>. */ 175 public static final String PROPERTY_IMAGE_SIZE = "image.size"; 176 177 /** The property for defining the date (as Solr field) that should be used for sorting in lists. */ 178 public static final String PROPERTY_INSTANCEDATE_COPYFIELD = "instancedate.copyfield"; 179 180 /** Property for the keywords. */ 181 public static final String PROPERTY_KEYWORDS = "Keywords"; 182 183 /** Property to enable __forceAbsoluteLinks request parameter for a resource. */ 184 public static final String PROPERTY_LINKS_FORCEABSOLUTE_ENABLED = "links.forceabsolute.enabled"; 185 186 /** Property for the current locale. */ 187 public static final String PROPERTY_LOCALE = "locale"; 188 189 /** Property to mark detail pages to have locale independent detail only containers. */ 190 public static final String PROPERTY_LOCALE_INDEPENDENT_DETAILS = "locale.independent-details"; 191 192 /** Property for the 'do not translate' marking in the sitemap editor. */ 193 public static final String PROPERTY_LOCALE_NOTRANSLATION = "locale.notranslation"; 194 195 /** Property for the login form. */ 196 public static final String PROPERTY_LOGIN_FORM = "login-form"; 197 198 /** Property constant for <code>"NavImage"</code>. */ 199 public static final String PROPERTY_NAVIMAGE = "NavImage"; 200 201 /** Property constant for <code>"NavInfo"</code>. */ 202 public static final String PROPERTY_NAVINFO = "NavInfo"; 203 204 /** Property for the navigation position. */ 205 public static final String PROPERTY_NAVPOS = "NavPos"; 206 207 /** Property for the navigation text. */ 208 public static final String PROPERTY_NAVTEXT = "NavText"; 209 210 /** Property for the resource title. */ 211 public static final String PROPERTY_NOTIFICATION_INTERVAL = "notification-interval"; 212 213 /** Property for the relative root link substitution. */ 214 public static final String PROPERTY_RELATIVEROOT = "relativeroot"; 215 216 /** Property name that defines the available resource types for the "new" dialog. */ 217 public static final String PROPERTY_RESTYPES_AVAILABLE = "restypes.available"; 218 219 /** Property to sort search results in categories. */ 220 public static final String PROPERTY_SEARCH_CATEGORY = "category"; 221 222 /** Property to exclude individual resources from search index generation. */ 223 public static final String PROPERTY_SEARCH_EXCLUDE = "search.exclude"; 224 225 /** Property to boost certain search results. */ 226 public static final String PROPERTY_SEARCH_PRIORITY = "search.priority"; 227 228 /** Property to exclude individual resources from search results online (Solr only). */ 229 public static final String PROPERTY_SEARCH_EXCLUDE_ONLINE = "search.exclude.online"; 230 231 /** Property for secondary locales for use in the locale compare view in the sitemap editor. */ 232 public static final String PROPERTY_SECONDARY_LOCALES = "locale.secondary"; 233 234 /** Property for the secure transmission of resources. */ 235 public static final String PROPERTY_SECURE = "secure"; 236 237 /** Property for the stylesheet of files. */ 238 public static final String PROPERTY_STYLESHEET = "stylesheet"; 239 240 /** Property to control the template. */ 241 public static final String PROPERTY_TEMPLATE = "template"; 242 243 /** Property to customize for which templates elements should be displayed in the gallery when using the CmsTransformerTemplateProvider. */ 244 public static final String PROPERTY_TEMPLATE_COMPATILIBITY = "template.compatibility"; 245 246 /** Property for specifying a list of container types used to match formatters in the display formatter selection widget. */ 247 public static final String PROPERTY_TEMPLATE_DISPLAY_TYPES = "template.display.types"; 248 249 /** Property to control the template elements. */ 250 public static final String PROPERTY_TEMPLATE_ELEMENTS = "template-elements"; 251 252 /** Property for the template image. */ 253 public static final String PROPERTY_TEMPLATE_IMAGE = "template.image"; 254 255 /** 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. */ 256 public static final String PROPERTY_TEMPLATE_PROVIDER = "template.provider"; 257 258 /** Property for the resource title. */ 259 public static final String PROPERTY_TITLE = "Title"; 260 261 /** Property for user data request configuration. */ 262 public static final String PROPERTY_UDR_CONFIG = "udr.config"; 263 264 /** Property used to configure default organizational unit. */ 265 public static final String PROPERTY_UDR_DEFAULTOU = "udr.defaultou"; 266 267 /** Name of the property used to control whether mapped URL names should replace previous URL names. */ 268 public static final String PROPERTY_URLNAME_REPLACE = "urlname.replace"; 269 270 /** Property for the visible method in the administration view. */ 271 public static final String PROPERTY_VISIBLE = "visiblemethod"; 272 273 /** Property for the XML sitemap change frequency. */ 274 public static final String PROPERTY_XMLSITEMAP_CHANGEFREQ = "xmlsitemap.changefreq"; 275 276 /** Property for the XML sitemap priority. */ 277 public static final String PROPERTY_XMLSITEMAP_PRIORITY = "xmlsitemap.priority"; 278 279 /** The property definition type for resources. */ 280 public static final int PROPERYDEFINITION_RESOURCE = 1; 281 282 /** Property value is treated as a link or list of links. */ 283 public static final CmsPropertyType TYPE_LINK = CmsPropertyType.LINK; 284 285 /** Property value is not a link. */ 286 public static final CmsPropertyType TYPE_NORMAL = CmsPropertyType.NORMAL; 287 288 /** The null property definition object. */ 289 private static final CmsPropertyDefinition NULL_PROPERTY_DEFINITION = new CmsPropertyDefinition( 290 CmsUUID.getNullUUID(), 291 "", 292 TYPE_NORMAL); 293 294 /** The id of this property definition. */ 295 private CmsUUID m_id; 296 297 /** The name of this property definition. */ 298 private String m_name; 299 300 /** The type of this property definition.*/ 301 private CmsPropertyType m_type; 302 303 /** 304 * Creates a new property definition object with the type 305 * <code>{@link #TYPE_NORMAL}</code>.<p> 306 * 307 * @param id the id of the property definition 308 * @param name the name of the property definition 309 */ 310 public CmsPropertyDefinition(CmsUUID id, String name) { 311 312 this(id, name, TYPE_NORMAL); 313 } 314 315 /** 316 * Creates a new property definition object.<p> 317 * 318 * @param id the id of the property definition 319 * @param name the name of the property definition 320 * @param propertyType the type of the property 321 */ 322 public CmsPropertyDefinition(CmsUUID id, String name, CmsPropertyType propertyType) { 323 324 m_id = id; 325 m_name = name; 326 m_type = propertyType; 327 } 328 329 /** 330 * Checks if the provided property name is a valid property name, 331 * that is contains only valid characters.<p> 332 * 333 * A property name can only be composed of digits, 334 * standard ASCII letters and the symbols defined in {@link #NAME_CONSTRAINTS}.<p> 335 * 336 * @param name the property name to check 337 * 338 * @throws CmsIllegalArgumentException if the given property name is not valid 339 */ 340 public static void checkPropertyName(String name) throws CmsIllegalArgumentException { 341 342 if (CmsStringUtil.isEmptyOrWhitespaceOnly(name)) { 343 throw new CmsIllegalArgumentException( 344 Messages.get().container(Messages.ERR_BAD_PROPERTYNAME_EMPTY_0, name)); 345 } 346 347 CmsStringUtil.checkName(name, NAME_CONSTRAINTS, Messages.ERR_BAD_PROPERTYNAME_4, Messages.get()); 348 } 349 350 /** 351 * Returns the null property definition.<p> 352 * 353 * @return the null property definition 354 */ 355 public static CmsPropertyDefinition getNullPropertyDefinition() { 356 357 return CmsPropertyDefinition.NULL_PROPERTY_DEFINITION; 358 } 359 360 /** 361 * Returns a clone of this Objects instance.<p> 362 * 363 * @return a clone of this instance 364 */ 365 @Override 366 public Object clone() { 367 368 return new CmsPropertyDefinition(m_id, m_name, m_type); 369 } 370 371 /** 372 * @see java.lang.Comparable#compareTo(java.lang.Object) 373 */ 374 public int compareTo(CmsPropertyDefinition obj) { 375 376 if (obj == this) { 377 return 0; 378 } 379 return m_name.compareTo(obj.m_name); 380 } 381 382 /** 383 * @see java.lang.Object#equals(java.lang.Object) 384 */ 385 @Override 386 public boolean equals(Object obj) { 387 388 if (obj == this) { 389 return true; 390 } 391 if (obj instanceof CmsPropertyDefinition) { 392 return ((CmsPropertyDefinition)obj).m_id.equals(m_id); 393 } 394 return false; 395 } 396 397 /** 398 * Returns the id of this property definition.<p> 399 * 400 * @return id the id of this Propertydefinition 401 */ 402 public CmsUUID getId() { 403 404 return m_id; 405 } 406 407 /** 408 * Returns the name of this property definition.<p> 409 * 410 * @return name The name of this property definition 411 */ 412 public String getName() { 413 414 return m_name; 415 } 416 417 /** 418 * Returns the the type of this property definition.<p> 419 * 420 * @return the type of this property definition 421 */ 422 public CmsPropertyType getType() { 423 424 return m_type; 425 } 426 427 /** 428 * @see java.lang.Object#hashCode() 429 */ 430 @Override 431 public int hashCode() { 432 433 if (m_name != null) { 434 return m_name.hashCode(); 435 } 436 return 0; 437 } 438 439 /** 440 * Sets the type for this property definition.<p> 441 * 442 * @param type the type to set 443 */ 444 public void setType(CmsPropertyType type) { 445 446 m_type = type; 447 } 448 449 /** 450 * @see java.lang.Object#toString() 451 */ 452 @Override 453 public String toString() { 454 455 StringBuffer result = new StringBuffer(); 456 result.append("[Propertydefinition]"); 457 result.append(" name:"); 458 result.append(m_name); 459 result.append(" id:"); 460 result.append(m_id); 461 result.append(" type:"); 462 result.append(m_type); 463 return result.toString(); 464 } 465}