org.thales.punch.libraries.punchlang.resource

Class RemoteResourceHandlers

java.lang.Object

org.thales.punch.libraries.punchlang.resource.RemoteResourceHandlers

public final class RemoteResourceHandlers
extends Object

This class holds the per JVM static resource handlers used by some operators and available in a punchlets.

Method Summary

Modifier and Type	Method and Description
static void	addRemoteResource(String name, org.thales.punch.settings.api.ISettingsMap configuration) Create a resource handler for given configuration.
static void	addTestRemoteResource(String name, String url, String cron, boolean requiredResource, String decoder, org.thales.punch.settings.api.ISettingsMap decoderSettings) Create a resource handler for given parameters.
static void	clear() Test method to repeat tests with a fresh starting point.
static Supplier<Tuple>	computeIfAbsent(String url, Function<? super String,? extends Supplier<Tuple>> mappingFunction) This method will return the first IRemoteResourceHandler initialised in this JVM for the provided URL.
static Tuple	getRemoteResource(String resourceName) Return the object corresponding to this resource name.
static String	getRemoteResourceAsString(String resourceName) Return the String corresponding to this resource name.
static Tuple	getRemoteResourceAsTuple(String resourceName) Return the Tuple corresponding to this resource name.
static void	setRemoteResources(org.thales.punch.settings.api.ISettingsMap configuration) Create a resource handler for every resource defined in the configuration.

Methods inherited from class java.lang.Object

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

Method Detail

computeIfAbsent

public static Supplier<Tuple> computeIfAbsent(String url,
                                              Function<? super String,? extends Supplier<Tuple>> mappingFunction)

This method will return the first IRemoteResourceHandler initialised in this JVM for the provided URL.

This API is thread safe.

Parameters:

url - the resource remote URL.

mappingFunction - the mapping function to create the resource handler if not there.

Returns:

the resource handler

setRemoteResources

public static void setRemoteResources(org.thales.punch.settings.api.ISettingsMap configuration)

Create a resource handler for every resource defined in the configuration.

Parameters:

configuration - : Resources configuration

addRemoteResource

public static void addRemoteResource(String name,
                                     org.thales.punch.settings.api.ISettingsMap configuration)

Create a resource handler for given configuration.

Parameters:

name - : Resource name

configuration - : Resources configuration

addTestRemoteResource

public static void addTestRemoteResource(String name,
                                         String url,
                                         String cron,
                                         boolean requiredResource,
                                         String decoder,
                                         org.thales.punch.settings.api.ISettingsMap decoderSettings)

Create a resource handler for given parameters.

Parameters:

name - : Resource name

url - : Resource URL

cron - : Refresh frequency

requiredResource - : Is this resource required

decoder - : Tuple builder

getRemoteResource

public static Tuple getRemoteResource(String resourceName)

Return the object corresponding to this resource name.

Parameters:

resourceName - : Name of the requested resource

Returns:

Resource content (can be string or Tuple)

getRemoteResourceAsTuple

public static Tuple getRemoteResourceAsTuple(String resourceName)

Return the Tuple corresponding to this resource name. If no decoder has been set for this resource, may raise an exception.

Parameters:

resourceName - : Name of the requested resource

Returns:

Resource content as Tuple

getRemoteResourceAsString

public static String getRemoteResourceAsString(String resourceName)

Return the String corresponding to this resource name. If a decoder has been set for this resource, may raise an exception.

Parameters:

resourceName - : Name of the requested resource

Returns:

Resource content as String

clear

public static void clear()

Test method to repeat tests with a fresh starting point.