COREMEDIA CONTENT CLOUD Content Application Developer Manual Content Application Developer Manual Content Application Developer Manual | Copyright CoreMedia GmbH © 2021 CoreMedia GmbH Ludwig-Erhard-Straße 18 20459 Hamburg International All rights reserved. No part of this manual or the corresponding program may be reproduced or copied in any form (print, photocopy or other process) without the written permission of CoreMedia GmbH. Germany Alle Rechte vorbehalten. CoreMedia und weitere im Text erwähnte CoreMedia Produkte sowie die entsprechenden Logos sind Marken oder eingetragene Marken der CoreMedia GmbH in Deutschland. Alle anderen Namen von Produkten sind Marken der jeweiligen Firmen. Das Handbuch bzw. Teile hiervon sowie die dazugehörigen Programme dürfen in keiner Weise (Druck, Fotokopie oder sonstige Verfahren) ohne schriftliche Genehmigung der CoreMedia GmbH reproduziert oder vervielfältigt werden. Unberührt hiervon bleiben die gesetzlich erlaubten Nutzungsarten nach dem UrhG. Licenses and Trademarks All trademarks acknowledged. September 19, 2021 (Release 2104) COREMEDIA CONTENT CLOUD ii Content Application Developer Manual | 1. Preface ................................................................................ 1 1.1. Audience .................................................................... 2 1.2. Typographic Conventions ................................................. 3 1.3. CoreMedia Services ........................................................ 5 1.3.1. Registration ...................................................... 5 1.3.2. CoreMedia Releases ............................................. 6 1.3.3. Documentation .................................................. 6 1.3.4. CoreMedia Training ............................................. 10 1.3.5. CoreMedia Support ............................................. 10 1.4. Changelog ................................................................. 12 2. Overview ............................................................................. 13 2.1. Components and Use Cases ............................................. 14 2.2. Architecture .............................................................. 15 2.3. Caching ................................................................... 16 2.3.1. Unified API Cache ............................................... 16 2.3.2. Data View Cache ............................................... 16 2.3.3. CacheKey Cache ............................................... 17 2.4. The Spring Framework ................................................... 18 3. Administration and Operation ..................................................... 19 3.1. Connecting to the Content Server ....................................... 20 3.2. Configuring Cache Sizes ................................................. 21 3.2.1. In-memory caching (UAPI Cache) .............................. 21 3.2.2. File System Cache for Transformed Image Blobs ............ 22 3.3. Configuring HTTP Cache-Control ........................................ 24 3.3.1. Object Type based Configuration .............................. 25 3.3.2. URL Pattern based Configuration ............................. 25 3.4. JMX Management ........................................................ 27 4. Development ....................................................................... 28 4.1. Content Beans - Mapping content to objects .......................... 29 4.1.1. Generate Content Beans from the Content Type mod- el ....................................................................... 29 4.2. Data Views ............................................................... 38 4.2.1. Defining Data Views ............................................ 39 4.2.2. Data View Design ............................................... 41 4.2.3. Configuring Cache Sizes ....................................... 54 4.2.4. Writing Cacheable Beans ...................................... 55 4.3. The CAE Web Application ................................................ 58 4.3.1. Handling Requests ............................................. 58 4.3.2. Building Links .................................................. 67 4.3.3. Views ........................................................... 74 4.3.4. Writing Templates .............................................. 84 4.3.5. Adding Document Metadata .................................. 93 4.3.6. Working with Forms ........................................... 100 4.3.7. Integrating with Spring Web Flows ............................ 111 4.3.8. Spring Security ................................................. 112 4.3.9. Unit Testing a CAE Application ................................ 113 4.3.10. Dealing with Errors ........................................... 116 4.4. Multi-Site and Localization Management .............................. 119 4.5. Image Transformation API .............................................. 120 COREMEDIA CONTENT CLOUD iii Content Application Developer Manual | 5. Reference ......................................................................... 126 5.1. Customizer ............................................................... 127 5.2. Aspects .................................................................. 130 5.3. Entity Resolver .......................................................... 133 5.4. Content Placeholders ................................................... 134 5.5. Configuration Property Reference ...................................... 137 5.6. Bean Definition Reference .............................................. 138 5.7. Managed Properties ..................................................... 148 Glossary ............................................................................... 151 Index .................................................................................. 157 COREMEDIA CONTENT CLOUD iv Content Application Developer Manual | List of Figures 4.1. Phases of a data view lifecycle .................................................. 43 4.2. Example site structure .......................................................... 49 4.3. Entity Model ...................................................................... 50 4.4. Dependencies of the Unified API cache ........................................ 57 4.5. Processing chain of DispatcherServlet, handlers and view dispatcher ....... 58 4.6. Processing chain of handlers and link schemes .............................. 68 4.7. View lookup sequence ........................................................... 76 COREMEDIA CONTENT CLOUD v Content Application Developer Manual | List of Tables 1.1. Typographic conventions .......................................................... 3 1.2. Pictographs ........................................................................ 4 1.3. CoreMedia manuals ................................................................ 7 1.4. Changes ........................................................................... 12 2.1. Components of the CAE framework ............................................. 14 3.1. Connection properties ........................................................... 20 3.2. Properties for UAPI and temp blob cache ...................................... 21 3.3. Properties for transformed blob cache ........................................ 22 4.1. Parameters of the Beangenerator .............................................. 30 4.2. Document property to Java property mappings ............................... 33 4.3. Association types ................................................................ 43 4.4. Bean Properties in the DataView Example ..................................... 50 4.5. Example of image transformation strings ..................................... 120 5.1. Beans in artifact com.coremedia.cms:cae-component ...................... 138 5.2. Beans in artifact com.coremedia.cms:cae-viewservices .................... 138 5.3. Beans in artifact com.coremedia.cms:cap-unified-api ....................... 141 5.4. Beans in artifact com.coremedia.cms:cae-util ............................... 142 5.5. Beans in artifact com.coremedia.cms:cae-contentbeanservices .......... 142 5.6. Beans in artifact com.coremedia.cms:coremedia-cache ................... 143 5.7. Beans in artifact com.coremedia.cms:cae-linkservices ..................... 143 5.8. Beans in artifact com.coremedia.cms:coremedia-id ........................ 143 5.9. Beans in artifact com.coremedia.cms:cae-handlerservices ................ 144 5.10. Beans in artifact com.coremedia.cms:coremedia-common ............... 145 5.11. Beans in artifact com.coremedia.cms:coremedia-transform ............... 146 5.12. com/coremedia/cae/controller-services.xml in artifact cae-handlerser- vices .................................................................................. 147 5.13. TransformedBlobCacheManager attributes .................................. 148 COREMEDIA CONTENT CLOUD vi Content Application Developer Manual | List of Examples 3.1. Type based Cache-Control Configuration ....................................... 25 3.2. Type based Cache-Control Configuration ...................................... 25 4.1. Auto completion example ....................................................... 45 4.2. Auto completion exclusion example ........................................... 46 4.3. Bean property with custom dependency ....................................... 56 4.4. Accessing a bean property with a custom dependency ...................... 56 4.5. Triggering an invalidation