Example with Marketo REST API - Bloomreach Experience Manager (PaaS/Self-Hosted) - The Fast and Flexible Headless CMS

Example with Marketo REST API

Introduction

The following ResourceResolver bean definition is an example configuration for Marketo REST API backend. This will give hints on how to configure conneciton information, RestTemplate object configuration, authentication such as OAuth2, ResourceLinkResolver object configuration, cache control configuration, etc.

The following ResourceResolver Spring Framework Beans configuration can be set at /hippo:configuration/hippo:modules/crispregistry/hippo:moduleconfig/crisp:resourceresolvercontainer/demoMarketo/@crisp:beandefinition property in the repository for "demoMarketo" resource space, for instance.

ResourceResolver Configuration

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:s="http://www.springframework.org/schema/security"
       xsi:schemaLocation="
                        http://www.springframework.org/schema/security
            https://www.springframework.org/schema/security/spring-security.xsd
                        http://www.springframework.org/schema/beans
                        http://www.springframework.org/schema/beans/spring-beans-4.1.xsd">

  <bean parent="abstractCrispSimpleJacksonRestTemplateResourceResolver" class="org.onehippo.cms7.crisp.core.resource.jackson.SimpleJacksonRestTemplateResourceResolver">
    <property name="cacheEnabled" value="${cache.enabled}" />
    <property name="baseUri" value="${marketo.baseUrl}/rest/v1" />
    <property name="resourceDataCache">
      <bean class="org.onehippo.cms7.crisp.core.resource.SpringResourceDataCache">
        <constructor-arg>
          <bean class="org.springframework.cache.ehcache.EhCacheCache">
            <constructor-arg>
              <bean parent="abstractCrispResourceEhCache">
                <property name="cacheName" value="demomarketoCache" />
                <property name="maxEntriesLocalHeap" value="1000" />
                <property name="maxEntriesLocalDisk" value="0" />
                <property name="timeToLiveSeconds" value="60" />
                <property name="timeToIdleSeconds" value="60" />
              </bean>
            </constructor-arg>
          </bean>
        </constructor-arg>
      </bean>
    </property>
    <property name="clientHttpRequestInterceptor">
      <list value-type="org.springframework.http.client.ClientHttpRequestInterceptor">
        <bean class="org.onehippo.cms7.crisp.core.interceptor.SimpleOAuth2AuthorizedClientInterceptor" autowire="constructor">
          <property name="authorizedClientService" ref="authorizedClientService" />
          <property name="clientRegistrationId" value="marketo-login" />
        </bean>
      </list>
    </property>
  </bean>

  <s:client-registrations>
      <s:client-registration registration-id="marketo-login"
                             client-id="${marketo.clientId}"
                             client-secret="${marketo.clientSecret}"
                             client-authentication-method="client_secret_basic"
                             authorization-grant-type="client_credentials"
                             provider-id="marketo"/>
      <s:provider provider-id="marketo"
                  authorization-uri="${marketo.baseUrl}/identity/oauth/token"
                  token-uri="${marketo.baseUrl}/identity/oauth/token"/>
  </s:client-registrations>

  <bean id="authorizedClientService" class="org.springframework.security.oauth2.client.InMemoryOAuth2AuthorizedClientService" autowire="constructor"/>
  <bean id="authorizedClientRepository" class="org.springframework.security.oauth2.client.web.AuthenticatedPrincipalOAuth2AuthorizedClientRepository">
    <constructor-arg ref="authorizedClientService"/>
  </bean>
</beans>

The following properties are used in the bean configuration through pairs of crisp:propnames and crisp:propvalues properties at /hippo:configuration/hippo:modules/crispregistry/hippo:moduleconfig/crisp:resourceresolvercontainer/demoMarketo node for "demoMarketo" resource space, for instance.

Property Name Example Value
cache.enabled true
marketo.clientId someClientId
marketo.clientSecret someClientSecret
marketo.baseUrl https://123-something-456.mktorest.com
  • cacheEnabled property is enable or disable ResourceResolver level caching.
  • baseUri property is to set the base URI of the backend Marketo REST API. So, invocations on ResourceServiceBroker for this resource space will take a relative resource path to combine it with the base URI to invoke the backend Marketo REST API in the end.
  • resourceDataCache property specifies a ResourceResolver specific ResourceDataCache object. If this property is set and the specific resource is cacheable, the ResourceServiceBroker may cache resource specific data in the specified ResourceDataCache. If not set but the specific resource is still cacheable, ResourceServiceBroker may cache resource specific data in a globally-shared ResourceDataCache by default.
  • Finally, clientHttpRequestInterceptor property specifies a SimpleOAuth2AuthorizedClientInterceptor object. In this example, because the Marketo REST API backend requires OAuth2 authentication, a OAuth2 client needs to be registered in the OAuth2AuthorizedClientRepository with all the necessary OAuth2 authentication information. Please note that the spring-security-oauth2 project is deprecated and the related libraries will be removed in the next versions. Please have a look at the Salesforce example to evaluate a possible implementation of the SimpleOAuth2AuthorizedClientInterceptor.

 

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?