Module for Sunrise Java that serves as an adapter for Contentful CMS platform providing read access to its content.
##Configuration
In order to create a new instance of ContentfulCmsService following parameters needs to be provided:
| param | description |
|---|---|
| spaceId | Contentful space ID |
| token | access token to given space |
| pageType | Contentful model's content type |
| pageQueryField | a field defined in pageType |
| callbackExecutor | defines execution context in which requests are executed |
ContentfulCmsService.of("spaceId", "token", "pageType", "pageQueryField", callbackExecutor);Instance of the service is created per Contentful page type and one of this type's fields upon which queries will be executed.
Contentful's JVM executor is synchronous and for that reason this service is built with additional Executor
parameter to provide its user with control over execution context in which requests are executed.
##Localization
Contentful provides its users with localization facilities. Several locales might be defined for given space. This adapter might be used to request a page with empty locales list. In such situation implementation makes such request locale-independent. Contentful uses space's default locale in this case.
##Supported field types
Contentful provides several field types. This implementation serves following of them:
- Boolean
- Date
- Integer
- Number
- Symbol
- Text
- Location
- Asset
- Array
Note that Asset field is converted to string in a special way. It is done by getting contained url.
Fields of all other types are just converted by their toString() method.
Array type is not representable as string. Fields of that type can only be used to access contained items.
##Error handling
Content should be uniquely identified by chosen field. If there is more than one entity of chosen type with the same query field Contentful will return all of them but this service execution will result in CompletableFuture completed exceptionally by throwing CmsServiceException informing about non-unique identifier used.
If content is requested for a specific locale that is not defined for the space this implementation will respond with 'CmsServiceException' with adequate message.