Package io.wcm.caravan.pipeline.extensions.hal.client.action

Class EmbedLinks

java.lang.Object

io.wcm.caravan.pipeline.extensions.hal.client.action.AbstractEmbedLinks

io.wcm.caravan.pipeline.extensions.hal.client.action.EmbedLinks

All Implemented Interfaces:

HalClientAction, io.wcm.caravan.pipeline.JsonPipelineAction

@ProviderType
public final class EmbedLinks
extends AbstractEmbedLinks

Action to load one or all links of the main HAL resource and insert the content as embedded resource(s).

Constructor Summary

Constructors

Constructor	Description
EmbedLinks(ServiceIdExtractor serviceId, String relation, Map<String,Object> parameters)
EmbedLinks(String serviceId, String relation, Map<String,Object> parameters)

Method Summary

Modifier and Type	Method	Description
io.wcm.caravan.pipeline.cache.CacheStrategy	getCacheStrategy()
List<io.wcm.caravan.pipeline.JsonPipelineExceptionHandler>	getExceptionHandlers()
com.google.common.collect.Multimap<String,String>	getHttpHeaders()
String	getId()
org.slf4j.Logger	getLogger()
boolean	hasLogger()
HalClientAction	setCacheStrategy(io.wcm.caravan.pipeline.cache.CacheStrategy value)
HalClientAction	setExceptionHandlers(List<io.wcm.caravan.pipeline.JsonPipelineExceptionHandler> value)
HalClientAction	setHttpHeaders(com.google.common.collect.Multimap<String,String> value)
HalClientAction	setLogger(org.slf4j.Logger value)

Methods inherited from class io.wcm.caravan.pipeline.extensions.hal.client.action.AbstractEmbedLinks

execute, getRelation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmbedLinks

public EmbedLinks(String serviceId,
                  String relation,
                  Map<String,Object> parameters)

Parameters:

serviceId - Service ID

relation - Link relation to embed

parameters - URI parameters

EmbedLinks

public EmbedLinks(ServiceIdExtractor serviceId,
                  String relation,
                  Map<String,Object> parameters)

Parameters:

serviceId - function to extract Service ID from a given request URL

relation - Link relation to embed

parameters - URI parameters

Method Detail

getId

public String getId()

Specified by:

getId in interface io.wcm.caravan.pipeline.JsonPipelineAction

Overrides:

getId in class AbstractEmbedLinks

setCacheStrategy

public HalClientAction setCacheStrategy(io.wcm.caravan.pipeline.cache.CacheStrategy value)

Specified by:

setCacheStrategy in interface HalClientAction

Parameters:

value - Caching strategy

Returns:

This HAL client action

setExceptionHandlers

public HalClientAction setExceptionHandlers(List<io.wcm.caravan.pipeline.JsonPipelineExceptionHandler> value)

Specified by:

setExceptionHandlers in interface HalClientAction

Parameters:

value - Exception Handlers

Returns:

This HAL client action

setLogger

public HalClientAction setLogger(org.slf4j.Logger value)

Specified by:

setLogger in interface HalClientAction

Parameters:

value - Logger

Returns:

This HAL client action

setHttpHeaders

public HalClientAction setHttpHeaders(com.google.common.collect.Multimap<String,String> value)

Specified by:

setHttpHeaders in interface HalClientAction

Parameters:

value - HTTP headers

Returns:

This HAL client action

getCacheStrategy

public io.wcm.caravan.pipeline.cache.CacheStrategy getCacheStrategy()

Returns:

Returns the cacheStrategy.

getExceptionHandlers

public List<io.wcm.caravan.pipeline.JsonPipelineExceptionHandler> getExceptionHandlers()

Returns:

Returns the exceptionHandlers.

getLogger

public org.slf4j.Logger getLogger()

Returns:

Current Logger

hasLogger

public boolean hasLogger()

Returns:

True if has a logger

getHttpHeaders

public com.google.common.collect.Multimap<String,String> getHttpHeaders()

Returns:

Returns the httpHeaders.