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

Class LoadLink

java.lang.Object

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

All Implemented Interfaces:

HalClientAction, io.wcm.caravan.pipeline.JsonPipelineAction

@ProviderType
public final class LoadLink
extends Object

Action to load a HAL link.

Constructor Summary

Constructors

Constructor	Description
LoadLink(ServiceIdExtractor serviceId, io.wcm.caravan.hal.resource.Link link, Map<String,Object> parameters)
LoadLink(String serviceId, io.wcm.caravan.hal.resource.Link link, Map<String,Object> parameters)

Method Summary

Modifier and Type	Method	Description
rx.Observable<io.wcm.caravan.pipeline.JsonPipelineOutput>	execute(io.wcm.caravan.pipeline.JsonPipelineOutput previousStepOutput, io.wcm.caravan.pipeline.JsonPipelineContext pipelineContext)
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()
String	getUrl()
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)
HalClientAction	withHttpMethod(String httpMethodToUse)

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadLink

public LoadLink(String serviceId,
                io.wcm.caravan.hal.resource.Link link,
                Map<String,Object> parameters)

Parameters:

serviceId - Service ID

link - Link to load

parameters - URI parameters

LoadLink

public LoadLink(ServiceIdExtractor serviceId,
                io.wcm.caravan.hal.resource.Link link,
                Map<String,Object> parameters)

Parameters:

serviceId - a function to extract the serviceid from a path

link - Link to load

parameters - URI parameters

Method Detail

getId

public String getId()

execute

public rx.Observable<io.wcm.caravan.pipeline.JsonPipelineOutput> execute(io.wcm.caravan.pipeline.JsonPipelineOutput previousStepOutput,
                                                                         io.wcm.caravan.pipeline.JsonPipelineContext pipelineContext)

withHttpMethod

public HalClientAction withHttpMethod(String httpMethodToUse)

Parameters:

httpMethodToUse - the HTTP method to use when loading the link

Returns:

this

getUrl

public String getUrl()

Returns:

URL of the current link and parameters.

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.