Studio Developer Manual / Version 2207
Table Of Contents
Once the implementation of an adapter has been created, an additional configuration must be available to tell
Studio which concrete instances to display. These instances are configured in
settings documents in a folder named Connections. The Connections folder should contain
only Content Hub connections documents, otherwise you will encounter some warnings
in the logging. Each document contains a Struct List connections.
Every connection sub-struct defines the following properties:
| Name | Type | Required | Description |
|---|---|---|---|
| connectionId | String | x | The identifier of the connection. For technical reasons, it must not contain '/' characters. |
| factoryId | String | x | The identifier of the implementing factory class. |
| settings | Struct | x | A struct that defines the connection attributes. |
| enabled | Boolean | Allows disabling a connection. | |
| itemTypes | Link |
Links to a settings document that contains the item type mapping. Alternatively, you can override
getItemTypes() in your ContentHubAdapterType and implement this mapping
hard coded.
| |
| contentTypeMapping | Link |
Links to a settings document that contains the mapping from Content Hub types
to content types. Alternatively, you can override
getContentTypeMapping() in your ContentHubAdapterType and implement this mapping
hard coded.
|
Table 9.8. Connection Struct Properties
Every connection struct must contain a sub-struct settings.
Properties of this struct will automatically be mapped to the settings interface that you have created
for the adapter. For example, if the settings interface contains the method
String getConnectionUrl(), then the struct must provide the String property connectionUrl.
Caution
Please take care of security protection. The settings should not contain secrets
like passwords or API tokens. For example, better store them in a dedicated secrets manager and only pass them
through to the external system in your custom adapter implementation during runtime.
The following rules of thumb provide additional protection for sensitive data:
-
Restrict access to the
Connectionsfolder to the people that actually configure the adapters. - Do not publish adapter configuration. The adapters are only accessed in the CoreMedia Studio. As such they are not relevant on the live side.
- Ensure that there are not links to Settings content. The adapter configuration is identified by means of their location. Links are not required. A link would risk that the Settings content is accidentally published if for example its referring content is published.
- Exclude the content and folder from website search by checking the corresponding option.
- Prevent access to arbitrary content from the Headless Server and from other client applications. See Section 3.5, “Security” in Headless Server Manual for more details.
