Content Application Developer Manual / Version 2401

Table Of Contents

Content Application Developer Manual

Copyright CoreMedia GmbH © 2024

CoreMedia GmbH

Altes Klöpperhaus, 5. OG

Rödingsmarkt 9

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.

November 07, 2024

1.1. Audience

1.2. Typographic Conventions

1.3. CoreMedia Services

1.3.1. Registration
1.3.2. CoreMedia Releases
1.3.3. Documentation
1.3.4. CoreMedia Training
1.3.5. CoreMedia Support

1.4. Changelog

2. Overview

2.1. Components and Use Cases

2.2. Architecture

2.3. Caching

2.3.1. Unified API Cache
2.3.2. Data View Cache
2.3.3. CacheKey Cache

2.4. The Spring Framework

3. Administration and Operation

3.1. Connecting to the Content Server

3.2. Configuring Cache Sizes

3.2.1. In-memory caching (UAPI Cache)
3.2.2. File System Cache for Transformed Image Blobs

3.3. Configuring HTTP Cache-Control

3.3.1. Object Type based Configuration
3.3.2. URL Pattern based Configuration

3.4. JMX Management

4. Development

4.1. Content Beans - Mapping content to objects

4.1.1. Structure of the Content Bean
4.1.2. Patterns For Content Beans
4.1.3. Spring Configuration
4.1.4. Programmatic Access to Content Beans

4.2. Data Views

4.2.1. Defining Data Views
4.2.2. Data View Design
4.2.3. Configuring Cache Sizes
4.2.4. Writing Cacheable Beans

4.3. The CAE Web Application

4.3.1. Handling Requests
4.3.2. Building Links
4.3.3. Views
4.3.4. Writing Templates
4.3.5. Adding Document Metadata
4.3.6. Working with Forms
4.3.7. Integrating with Spring Web Flows
4.3.8. Spring Security
4.3.9. Unit Testing a CAE Application
4.3.10. Dealing with Errors

4.4. Multi-Site and Localization Management

4.5. Image Transformation API

5. Reference

5.1. Customizer
5.2. Aspects
5.3. Entity Resolver
5.4. Content Placeholders
5.5. Configuration Property Reference
5.6. Bean Definition Reference
5.7. Managed Properties

List of Figures

4.1. Phases of a data view lifecycle
4.2. Example site structure
4.3. Entity Model
4.4. Dependencies of the Unified API cache
4.5. Processing chain of DispatcherServlet, handlers and view dispatcher
4.6. Processing chain of handlers and link schemes
4.7. View lookup sequence

List of Tables

1.1. Typographic conventions
1.2. Pictographs
1.3. CoreMedia manuals
1.4. Changes
2.1. Components of the CAE framework
3.1. Connection properties
3.2. Properties for UAPI and temp blob cache
3.3. Properties for transformed blob cache
4.1. Content property to Java property mappings
4.2. Association types
4.3. Bean Properties in the DataView Example
4.4. Example of image transformation strings
5.1. Beans in artifact com.coremedia.cms:cae-component
5.2. Beans in artifact com.coremedia.cms:cae-viewservices
5.3. Beans in artifact com.coremedia.cms:cap-unified-api
5.4. Beans in artifact com.coremedia.cms:cae-contentbeanservices
5.5. Beans in artifact com.coremedia.cms:coremedia-cache
5.6. Beans in artifact com.coremedia.cms:cae-linkservices
5.7. Beans in artifact com.coremedia.cms:coremedia-id
5.8. Beans in artifact com.coremedia.cms:cae-handlerservices
5.9. Beans in artifact com.coremedia.cms:coremedia-common
5.10. Beans in artifact com.coremedia.cms:coremedia-transform
5.11. Conditional beans in artifact com.coremedia.cms:coremedia-transform
5.12. com/coremedia/cae/controller-services.xml in artifact cae-handlerservices
5.13. TransformedBlobCacheManager attributes

List of Examples

3.1. Type based Cache-Control Configuration
3.2. Type based Cache-Control Configuration
4.1. Auto completion example
4.2. Auto completion exclusion example
4.3. Bean property with custom dependency
4.4. Accessing a bean property with a custom dependency
4.5. Triggering an invalidation of a custom dependency
4.6. A link scheme
4.7. Defining a link scheme
4.8. Iterating over java.util.Map entries in FreeMarker templates
4.9. Code for Idea auto-completion
4.10. A DOM with Metadata and Generated Metadata Tree
4.11. Responsive Device Slider Metadata
4.12. Studio Specific CSS and JavaScript Metadata
4.13. Mixed preview and custom metadata in FreeMarker
4.14. Configuring support for CSRF tokens in multipart forms
4.15. Implementing a CsrfLegacyTokenSetter
4.16. Implementing a CsrfLegacyTokenGetterFilter
4.17. Configuring CSRF backward compatibility
5.1. Add aspect support to content beans
5.2. Registering an aspects provider for content beans
5.3. Definition of an aspects provider for arbitrary Java beans
5.4. Annotating a Substitution method
5.5. Use of cm.substitute() in CMAction.ftl
5.6. Registering a substitution programmatically

Preface

Search Results

Table Of Contents