org.thales.punch.libraries.punchlang.api

Class AbstractRemoteResourceHandlerBuilder<T>

java.lang.Object

org.thales.punch.libraries.punchlang.api.AbstractRemoteResourceHandlerBuilder<T>

Direct Known Subclasses:

RemoteResourceHandlerBuilder, S3ResourceHandlerBuilder

public abstract class AbstractRemoteResourceHandlerBuilder<T>
extends Object

So called remote handlers are in charge of loading, once or periodically, remote resource files and transform them in tuples.

This abstract class provides most of the logic at play. Checkout out the S3 or the plain HTTP or file remote handlers that extends this common part.

Author:

dimi

Field Summary

Fields

Modifier and Type	Field and Description
protected IResourceBuilder	builder
protected String	cron
protected org.thales.punch.libraries.metrics.api.IMetricContext	metricsContext
protected boolean	requiredResource
protected boolean	silent

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteResourceHandlerBuilder() Ctor

Method Summary

Modifier and Type	Method and Description
abstract Supplier<Tuple>	getTupleSupplier()
T	setCronExpression(String cron) The optional CRON expression to refresh your resource.
T	setMetricContext(org.thales.punch.libraries.metrics.api.IMetricContext metricsContext)
T	setRequiredResource(boolean requiredResource) Indicate if the resource is absolutely required for the processing
T	setResourceTupleBuilder(IResourceBuilder builder) Set the tuple builder.
T	setSilent(boolean silent) Indicate if the resource is absolutely required for the processing

Methods inherited from class java.lang.Object

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

Field Detail

builder

protected IResourceBuilder builder

cron

protected String cron

requiredResource

protected boolean requiredResource

silent

protected boolean silent

metricsContext

protected org.thales.punch.libraries.metrics.api.IMetricContext metricsContext

Constructor Detail

AbstractRemoteResourceHandlerBuilder

public AbstractRemoteResourceHandlerBuilder()

Ctor

Method Detail

getTupleSupplier

public abstract Supplier<Tuple> getTupleSupplier()

Returns:

the resource tuple supplier. This may launch a thread if you requested a periodic refresh.

setResourceTupleBuilder

public T setResourceTupleBuilder(IResourceBuilder builder)

Set the tuple builder. The builder will received the fetched resource as String, and must convert it in a tuple in some way.

Parameters:

builder - your builder

Returns:

this builder

setCronExpression

public T setCronExpression(String cron)

The optional CRON expression to refresh your resource.

Parameters:

cron - the CRON expression

Returns:

this builder

setRequiredResource

public T setRequiredResource(boolean requiredResource)

Indicate if the resource is absolutely required for the processing

Parameters:

requiredResource - true means that failure during the initial resource load at startup time will not be considered as a failure (and a PunchUncheckedException will be thrown).

Returns:

this instance

setSilent

public T setSilent(boolean silent)

Indicate if the resource is absolutely required for the processing

Parameters:

requiredResource - true means that failure during the initial resource load at startup time will not be considered as a failure (and a PunchUncheckedException will be thrown).

Returns:

this instance

setMetricContext

public T setMetricContext(org.thales.punch.libraries.metrics.api.IMetricContext metricsContext)

Parameters:

metricsContext - a metric context to publish useful loading metrics.

Returns:

this builder