Skip to content

Latest commit

 

History

History
186 lines (135 loc) · 11.5 KB

readme.md

File metadata and controls

186 lines (135 loc) · 11.5 KB
Raw

Installation

Java versions

Since Bloomreach 15, Java 11 is required. If you are still using Bloomreach 12, 13 of 14, you need focuspoint-bloomreach version 1.x.x

Bloomreach CMS Integration

Add the following depedency to the CMS module

<dependency>
	<groupId>io.focuspoints</groupId>
	<artifactId>focuspoints-bloomreach15-cms</artifactId>
	<version>2.x.x</version>
</dependency>

Note: use the artifactId focuspoints-bloomreach12-cms or focuspoints-bloomreach13-cms depending on the major version of the Bloomreach DXP that you are using

Restart the project using the -Drepo.bootstrap=true or -Drepo.bootstrap=full command line argument in order to install the FocusPoints plugin. After restart a new Updater Editor with the name UpdateGalleryToFocusPoint should be present in the CMS. Run this editor in order to activate focus point selection support for new and existing images.

Bloomreach Site integration

Add the following dependency to the Site module

<dependency>
	<groupId>io.focuspoints</groupId>
	<artifactId>focuspoints-bloomreach15-taglib</artifactId>
	<version>2.x.x</version>
</dependency>

Note: use the artifactId focuspoints-bloomreach12-taglib or focuspoints-bloomreach13-taglib depending on the major version of the Bloomreach DXP that you are using

Next open the web.xml file of the site module and add classpath*:io/focuspoints/**/*.class to the hst-beans-annotated-classes context-param in order to have the focuspoints beans recognized.

Configuration

In order to start using the FocusPoints client functionality in the website we need to provide it with the correct configuration. There are multiple ways of configuring the plugin.

Manual Configuration

During application startup the following classes need to be configured: ImageServiceConfigurationProperties, TokenCreator and UrlCreator. Below is an example of such a configuration:

ImageServiceConfigurationProperties imageServiceConfiguration = new ImageServiceConfigurationProperties();
imageServiceConfiguration.setTokenId("myTokenId");
imageServiceConfiguration.setTokenSecret("myTokenSecret");

new TokenCreator(imageServiceConfiguration);
new UrlCreator(imageServiceConfiguration);

The TokenCreator and UrlCreator are singleton classes but need to be initialized once with the correct configuration. It is not needed to keep a reference to them.

ServletContext Configuration

Add the following dependency to the Site module

<dependency>
	<groupId>io.focuspoints</groupId>
	<artifactId>focuspoints-client-core-servlet</artifactId>
	<version>1.x.x</version>
</dependency>

This will setup a WebListener at application startup that initializes the FocusPoints client. Make sure the following context params are present in your application

Name Description
focuspoints.token-id Your FocusPoints API Key ID
focuspoints.token-secret Your FocusPoints API Key Secret

Spring Configuration

Add the following dependency to the Site module

<dependency>
	<groupId>io.focuspoints</groupId>
	<artifactId>focuspoints-client-core-spring</artifactId>
	<version>1.x.x</version>
</dependency>

Add the following import to your Spring configuration

@Import(FocusPointsConfiguration.class)

Make sure the following properties are present in your environment configuration

Name Description
focuspoints.token-id Your FocusPoints API Key ID
focuspoints.token-secret Your FocusPoints API Key Secret

Configuration Properties

The following configuration properties are supported.

Name Required Default Value Description
focuspoints.token-id True Your FocusPoints API Key ID
focuspoints.token-secret True Your FocusPoints API Key Secret
focuspoints.enabled False True Enables the use of focuspoints. When disabled, the original image URL will be used
focuspoints.url False https://image.focuspoints.io The focuspoints server endpoint
focuspoints.token-request-parameter-name False _jwt The name of the request parameter containing the token

Using the FocusPoints tags

The FocusPoints client comes with a tld with uri http://www.focuspoints.io/tags/bloomreach. The tld defines two tags used for image transformation and image resizing.

The image transformation tag

The image transformation tag generates a URL containing the correct parameters for transforming an image using the desired parameters. It can be used with a URL or an image of type HippoGalleryImageSet. When the FocusPoints CMS plugin has been installed, images of type FocusPointImageSet are preferred. The images created by the transformation operation always matches the desired with and height. When it is required to crop certain parts of the image the focus point coordinate is used to determin which part of the image must not be removed.

Attribute Required Description
image false The CMS image that is used. The value must of type HippoGalleryImageSet but is typically of type FocusPointImageSet. Either the image or url argument is required
url false An absolute URL of the image that is used. Either the image or url argument is required
filename false The filename of the image. When using the image argument with a value of type HippoGalleryImageSet the filename from the CMS is used.
width true The desired width of the generated image variant in pixels. Must be a positive Integer value
height true The desired height of the generated image variant in pixels. Must be a positive Integer value
focusPointX false The focus point coordinate for the x-axis. Must be a Double value between -1 and 1. When using the image argument with a value of type FocusPointImageSet the value set in the CMS is used.
focusPointY false The focus point coordinate for the y-axis. Must be a Double value between -1 and 1. When using the image argument with a value of type FocusPointImageSet the value set in the CMS is used.
var false The string to use when binding the result to the page, request, session or application scope. If not specified the result gets outputted to the writer (i.e. typically directly to the JSP)
scope false The scope to use when exporting the result to a variable. This attribute is only used when var is also set. Possible values are page, request, session and application. When no value is specified this defaults to the page scope

Examples

<%-- Import imageservice taglib --%>
<%@ taglib prefix="focuspoints" uri="http://www.focuspoints.io/tags/bloomreach" %>

<%-- Transform a CMS image to the desired with and height --%>
<focuspoints:transform image="${image}" width="1280" height="360" />

<%-- Transform a CMS image to the desired with and height and store the result in the page scope --%>
<focuspoints:transform var="imageTransformed1280x360" image="${image}" width="1280" height="360" />

<%-- Transform a custom image using the settings as specified in the tag --%>
<focuspoints:transform url="https://path/to/my/image" filename="my-image.jpg" width="1280" height="360" focusPointX="0.6" focusPointY="-0.35" />

The image resize tag

The image resize tag generates a URL containing the correct parameters for resizing an image using the desired parameters. It can be used with a URL or an image of type HippoGalleryImageSet. Where the image transformation tag can crop certain parts of an image this is not always desired (e.g. when displaying a company logo). The resize operation makes sure the image fits within the desired dimensions but only fits the longest side of the image. The shortest side could therefor be smaller than the provided with or height.

Attribute Required Description
image false The CMS image that is used. The value must of type HippoGalleryImageSet. Either the image or url argument is required
url false An absolute URL of the image that is used. Either the image or url argument is required
filename false The filename of the image. When using the image argument with a value of type HippoGalleryImageSet the filename from the CMS is used.
width true The desired width of the generated image variant in pixels. Must be a positive Integer value
height true The desired height of the generated image variant in pixels. Must be a positive Integer value
var false The string to use when binding the result to the page, request, session or application scope. If not specified the result gets outputted to the writer (i.e. typically directly to the JSP)
scope false The scope to use when exporting the result to a variable. This attribute is only used when var is also set. Possible values are page, request, session and application. When no value is specified this defaults to the page scope

Examples

<%-- Import imageservice taglib --%>
<%@ taglib prefix="focuspoints" uri="http://www.focuspoints.io/tags/bloomreach" %>

<%-- Resize an CMS image to the desired with and height --%>
<focuspoints:resize image="${image}" width="1280" height="360" />

<%-- Resize an CMS image to the desired with and height and store the result in the page scope --%>
<focuspoints:resize var="imageResized1280x360" image="${image}" width="1280" height="360" />

<%-- Resize a custom image to the desired with and height --%>
<focuspoints:resize url="https://path/to/my/image" filename="my-image.jpg" width="1280" height="360" />

Serving images from your own domain

When using FocusPoints the domain your images are services from will be images.focuspoints.io. If this is undesirable behavior it is possible to serve the images from your own domain by using a proxy. In order to so use the following steps:

  1. Set the FocusPoints URL in the configuration to a relative path (e.g. /images/). Either do so by setting it on ImageServiceConfigurationProperties or through the configuration property focuspoints.url depending on which configuration you use.
  2. Create a proxy pass in order to proxy all requests for the /images/ path to https://images.focuspoints.io. An example using Apache HTTPD can be found below
<Location "/images/">
	ProxyPass "https://images.focuspoints.io"
</Location>