Class ECtransSetup

java.lang.Object
ecmwf.common.ectrans.ECtransSetup
All Implemented Interfaces:
Serializable
public final class ECtransSetup extends Object implements Serializable
The Class ECtransSetup.
See Also:

  • Field Details

  • Constructor Details

    • ECtransSetup

      public ECtransSetup(String moduleName)
      Instantiates a new ectrans setup.
      Parameters:
      moduleName - the module name

    • ECtransSetup

      public ECtransSetup(String moduleName, String data, Pair<?>... parameters)
      Instantiates a new ectrans setup.
      Parameters:
      moduleName - the module name
      data - the data
      parameters - the parameters

  • Method Details

    • replace

      public ECtransSetup replace(Pair<?>... parameters)
      Allow getting a new instance with the added parameters provided.
      Parameters:
      parameters - the parameters
      Returns:
      the ectrans setup

    • setData

      public void setData(String data)
      Sets the data.
      Parameters:
      data - the new data

    • remove

      public String remove(String name)
      Removes the.
      Parameters:
      name - the name
      Returns:
      the string

    • remove

      public String remove(ECtransOptionDefinition option)
      Removes the.
      Parameters:
      option - the option
      Returns:
      the string

    • removeAll

      public void removeAll(String moduleName)
      Removes all parameters for the specified module name. This is used to clean a host.
      Parameters:
      moduleName - the module name

    • removeAll

      public void removeAll(ECtransGroups.Module module)
      Removes all parameters for the specified module name. This is used to clean a host.
      Parameters:
      module - the module

    • matches

      public boolean matches(String name, String value, String defaultRegex)
      Matches.
      Parameters:
      name - the name
      value - the value
      defaultRegex - the default regex
      Returns:
      true, if successful

    • matches

      public boolean matches(ECtransOptionDefinition options, String value)
      Matches.
      Parameters:
      options - the options
      value - the value
      Returns:
      true, if successful

    • matches

      public boolean matches(ECtransOptionDefinition option, String value, String defaultRegex)
      Matches.
      Parameters:
      option - the option
      value - the value
      defaultRegex - the default regex
      Returns:
      true, if successful

    • get

      public String get(String name, String defaultValue)
      Gets the.
      Parameters:
      name - the name
      defaultValue - the default value
      Returns:
      the string

    • get

      public String get(ECtransOptionDefinition option, String defaultValue)
      Gets the.
      Parameters:
      option - the option
      defaultValue - the default value
      Returns:
      the string

    • getDuration

      public Duration getDuration(ECtransOptionDefinition option)
      Gets the.
      Parameters:
      option - the option
      Returns:
      the duration

    • get

      public Duration get(ECtransOptionDefinition option, Duration defaultValue)
      Gets the.
      Parameters:
      option - the option
      defaultValue - the default value
      Returns:
      the duration

    • getPeriod

      public Period getPeriod(ECtransOptionDefinition option)
      Gets the.
      Parameters:
      option - the option
      Returns:
      the period

    • get

      public Period get(ECtransOptionDefinition option, Period defaultValue)
      Gets the.
      Parameters:
      option - the option
      defaultValue - the default value
      Returns:
      the period

    • get

      public ByteSize get(ECtransOptionDefinition option, ByteSize defaultValue)
      Gets the.
      Parameters:
      option - the option
      defaultValue - the default value
      Returns:
      the byte size

    • getList

      public String[] getList(String name, String... defaultValues)
      Gets the list.
      Parameters:
      name - the name
      defaultValues - the default values
      Returns:
      the list

    • getOptions

      public Options getOptions(ECtransOptionDefinition option)
      Gets the.
      Parameters:
      option - the option
      Returns:
      the options

    • getOptions

      public Options getOptions(ECtransOptionDefinition option, String delimiters)
      Gets the.
      Parameters:
      option - the option
      delimiters - the delimiters
      Returns:
      the options

    • getOptions

      public Options getOptions(ECtransOptionDefinition option, String key, String delimiters)
      Gets the.
      Parameters:
      option - the option
      key - the key
      delimiters - the delimiters
      Returns:
      the options

    • getOptions

      public Options getOptions(String name, String key, String delimiters)
      Gets the.
      Parameters:
      name - the name
      key - the key
      delimiters - the delimiters
      Returns:
      the options

    • getDuration

      public Duration getDuration(String name)
      Gets duration.
      Parameters:
      name - the name
      Returns:
      the duration

    • getDuration

      public Duration getDuration(String name, Duration defaultValue)
      Gets duration.
      Parameters:
      name - the name
      defaultValue - the default value
      Returns:
      the duration

    • getDuration

      public Duration getDuration(String moduleName, String name, Duration defaultValue)
      Gets the duration.
      Parameters:
      moduleName - the module name
      name - the name
      defaultValue - the default value
      Returns:
      the duration

    • getPeriod

      public Period getPeriod(String name)
      Gets the period.
      Parameters:
      name - the name
      Returns:
      the period

    • getPeriod

      public Period getPeriod(String name, Period defaultValue)
      Gets the period.
      Parameters:
      name - the name
      defaultValue - the default value
      Returns:
      the period

    • getPeriod

      public Period getPeriod(String moduleName, String name, Period defaultValue)
      Gets the period.
      Parameters:
      moduleName - the module name
      name - the name
      defaultValue - the default value
      Returns:
      the period

    • getByteSize

      public ByteSize getByteSize(String name)
      Gets byte size.
      Parameters:
      name - the name
      Returns:
      the long

    • getByteSize

      public ByteSize getByteSize(String name, ByteSize defaultValue)
      Gets byte size.
      Parameters:
      name - the name
      defaultValue - the default value
      Returns:
      the long

    • getByteSize

      public ByteSize getByteSize(String moduleName, String name, ByteSize defaultValue)
      Gets byte size.
      Parameters:
      moduleName - the module name
      name - the name
      defaultValue - the default value
      Returns:
      the long

    • getBooleanList

      public List<Boolean> getBooleanList(ECtransOptionDefinition option)
      Gets the list of booleans.
      Parameters:
      option - the option
      Returns:
      the list of booleans

    • getBoolean

      public boolean getBoolean(ECtransOptionDefinition option)
      Gets the boolean.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • getBoolean

      public boolean getBoolean(ECtransOptionDefinition option, org.graalvm.polyglot.Value bindings)
      Gets the boolean.
      Parameters:
      option - the option
      bindings - the bindings
      Returns:
      the object of type class

    • getBooleanObject

      public Boolean getBooleanObject(ECtransOptionDefinition option)
      Gets the boolean object.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • getBooleanObject

      public Boolean getBooleanObject(ECtransOptionDefinition option, org.graalvm.polyglot.Value bindings)
      Gets the boolean object.
      Parameters:
      option - the option
      bindings - the bindings
      Returns:
      the object of type class

    • getOptionalBoolean

      public Optional<Boolean> getOptionalBoolean(ECtransOptionDefinition option)
      Gets the optional boolean.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • setBooleanIfPresent

      public void setBooleanIfPresent(ECtransOptionDefinition option, Consumer<? super Boolean> action)
      Sets the optional boolean if present.
      Parameters:
      option - the option
      action - the action

    • getStringList

      public List<String> getStringList(ECtransOptionDefinition option)
      Gets list of strings.
      Parameters:
      option - the option
      Returns:
      the list of strings

    • getString

      public String getString(ECtransOptionDefinition option)
      Gets the string.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • getChecksumAlgorithm

      public Checksum.Algorithm getChecksumAlgorithm()
      Gets the checksum algorithm currently configured via "ectrans.checksumAlgorithm", defaulting to MD5 if unset or invalid.
      Returns:
      the checksum algorithm

    • getChecksumExtension

      public String getChecksumExtension(ECtransOptionDefinition legacyMd5ExtOption)
      Gets the extension to use for the checksum sidecar file written by transfer modules such as FTP/FTPS/SFTP. Resolution order: the common "ectrans.checksumExt" option if set, then (only when the configured checksum algorithm is MD5) the module-specific legacy extension option (e.g. "ftp.md5Ext"), and finally the default extension for the configured algorithm (e.g. ".sha256").
      Parameters:
      legacyMd5ExtOption - the module-specific legacy md5Ext option (e.g. HOST_FTP_MD5_EXT)
      Returns:
      the checksum extension

    • getString

      public String getString(ECtransOptionDefinition option, org.graalvm.polyglot.Value bindings)
      Gets the string.
      Parameters:
      option - the option
      bindings - the bindings
      Returns:
      the object of type class

    • getOptionalString

      public Optional<String> getOptionalString(ECtransOptionDefinition option)
      Gets the optional string.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • getOptionalString

      public Optional<String> getOptionalString(ECtransOptionDefinition option, org.graalvm.polyglot.Value bindings)
      Gets the optional string.
      Parameters:
      option - the option
      bindings - the bindings
      Returns:
      the object of type class

    • setStringIfPresent

      public void setStringIfPresent(ECtransOptionDefinition option, Consumer<? super String> action)
      Sets the optional string if present.
      Parameters:
      option - the option
      action - the action

    • getIntegerList

      public List<Integer> getIntegerList(ECtransOptionDefinition option)
      Gets the lif of integers.
      Parameters:
      option - the option
      Returns:
      the list of integers

    • getInteger

      public Integer getInteger(ECtransOptionDefinition option)
      Gets the integer.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • getInteger

      public Integer getInteger(ECtransOptionDefinition option, org.graalvm.polyglot.Value bindings)
      Gets the integer.
      Parameters:
      option - the option
      bindings - the bindings
      Returns:
      the object of type class

    • getOptionalInteger

      public Optional<Integer> getOptionalInteger(ECtransOptionDefinition option)
      Gets the optional integer.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • setIntegerIfPresent

      public void setIntegerIfPresent(ECtransOptionDefinition option, Consumer<? super Integer> action)
      Sets the optional integer if present.
      Parameters:
      option - the option
      action - the action

    • getLongList

      public List<Long> getLongList(ECtransOptionDefinition option)
      Gets the list of longs.
      Parameters:
      option - the option
      Returns:
      the list of longs

    • getLong

      public Long getLong(ECtransOptionDefinition option)
      Gets the long.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • getLong

      public Long getLong(ECtransOptionDefinition option, org.graalvm.polyglot.Value bindings)
      Gets the long.
      Parameters:
      option - the option
      bindings - the bindings
      Returns:
      the object of type class

    • getOptionalLong

      public Optional<Long> getOptionalLong(ECtransOptionDefinition option)
      Gets the optional long.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • setLongIfPresent

      public void setLongIfPresent(ECtransOptionDefinition option, Consumer<? super Long> action)
      Sets the optional long if present.
      Parameters:
      option - the option
      action - the action

    • getDoubleList

      public List<Double> getDoubleList(ECtransOptionDefinition option)
      Gets the list of doubles.
      Parameters:
      option - the option
      Returns:
      the list of doubles

    • getDouble

      public Double getDouble(ECtransOptionDefinition option)
      Gets the double.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • getDouble

      public Double getDouble(ECtransOptionDefinition option, org.graalvm.polyglot.Value bindings)
      Gets the double.
      Parameters:
      option - the option
      bindings - the bindings
      Returns:
      the object of type class

    • getOptionalDouble

      public Optional<Double> getOptionalDouble(ECtransOptionDefinition option)
      Gets the optional double.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • setDoubleIfPresent

      public void setDoubleIfPresent(ECtransOptionDefinition option, Consumer<? super Double> action)
      Sets the optional double if present.
      Parameters:
      option - the option
      action - the action

    • getByteSizeList

      public List<ByteSize> getByteSizeList(ECtransOptionDefinition option)
      Gets the list of byte sizes.
      Parameters:
      option - the option
      Returns:
      the list of byte sizes

    • getByteSize

      public ByteSize getByteSize(ECtransOptionDefinition option)
      Gets the byte size.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • getByteSize

      public ByteSize getByteSize(ECtransOptionDefinition option, org.graalvm.polyglot.Value bindings)
      Gets the byte size.
      Parameters:
      option - the option
      bindings - the bindings
      Returns:
      the object of type class

    • getOptionalByteSize

      public Optional<ByteSize> getOptionalByteSize(ECtransOptionDefinition option)
      Gets the optional byte size.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • setByteSizeIfPresent

      public void setByteSizeIfPresent(ECtransOptionDefinition option, Consumer<? super ByteSize> action)
      Sets the optional byte size if present.
      Parameters:
      option - the option
      action - the action

    • getOptionalDuration

      public Optional<Duration> getOptionalDuration(ECtransOptionDefinition option)
      Gets the optional duration.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • getOptionalDuration

      public Optional<Duration> getOptionalDuration(ECtransOptionDefinition option, org.graalvm.polyglot.Value bindings)
      Gets the optional duration.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • setDurationIfPresent

      public void setDurationIfPresent(ECtransOptionDefinition option, Consumer<? super Duration> action)
      Sets the optional duration if present.
      Parameters:
      option - the option
      action - the action

    • getOptionalPeriod

      public Optional<Period> getOptionalPeriod(ECtransOptionDefinition option)
      Gets the optional period.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • setPeriodIfPresent

      public void setPeriodIfPresent(ECtransOptionDefinition option, Consumer<? super Period> action)
      Sets the optional period if present.
      Parameters:
      option - the option
      action - the action

    • getTimeRangeList

      public List<TimeRange> getTimeRangeList(ECtransOptionDefinition option)
      Gets the list of time ranges.
      Parameters:
      option - the option
      Returns:
      the list of time ranges

    • getTimeRange

      public TimeRange getTimeRange(ECtransOptionDefinition option)
      Gets the time range.
      Parameters:
      option - the option
      Returns:
      the time range

    • getTimeRange

      public TimeRange getTimeRange(ECtransOptionDefinition option, org.graalvm.polyglot.Value bindings)
      Gets the time range.
      Parameters:
      option - the option
      bindings - the bindings
      Returns:
      the time range

    • getOptionalTimeRange

      public Optional<TimeRange> getOptionalTimeRange(ECtransOptionDefinition option)
      Gets the optional time range.
      Parameters:
      option - the option
      Returns:
      the object of type class

    • setTimeRangeIfPresent

      public void setTimeRangeIfPresent(ECtransOptionDefinition option, Consumer<? super TimeRange> action)
      Sets the optional time range if present.
      Parameters:
      option - the option
      action - the action

    • getScriptLanguage

      public String getScriptLanguage()
      Get the script language.
      Returns:
      the script language

    • getScriptContent

      public String getScriptContent()
      Get the resolved underlying script content, or null if empty.
      Returns:
      the script content

    • isOptionDefined

      public static boolean isOptionDefined(ECtransOptionDefinition option, String content)
      Basic check to see if the option is declared in the script content. This is less costly than creating the script manager directly, but does not guarantee it really exists. This will have to be checked at a later stage with the script manager.
      Parameters:
      option - the option
      content - the content
      Returns:
      true, if successful

    • get

      public boolean get(ECtransOptionDefinition option, boolean defaultValue)
      Gets the.
      Parameters:
      option - the option
      defaultValue - the default value
      Returns:
      the true, if successful

    • get

      public long get(ECtransOptionDefinition option, long defaultValue)
      Gets the.
      Parameters:
      option - the option
      defaultValue - the default value
      Returns:
      the result

    • get

      public int get(ECtransOptionDefinition option, int defaultValue)
      Gets the.
      Parameters:
      option - the option
      defaultValue - the default value
      Returns:
      the result

    • exists

      public boolean exists(String name)
      Check if the parameter exists in the current module. If the parameter is related to a function then the function is not executed.
      Parameters:
      name - the name
      Returns:
      true, if exists

    • set

      public void set(ECtransOptionDefinition option, String value)
      Sets the.
      Parameters:
      option - the option
      value - the value

    • set

      public void set(ECtransOptionDefinition option, ByteSize value)
      Sets the.
      Parameters:
      option - the option
      value - the value

    • set

      public void set(ECtransOptionDefinition option, boolean value)
      Sets the.
      Parameters:
      option - the option
      value - the value

    • set

      public void set(ECtransOptionDefinition option, long value)
      Sets the.
      Parameters:
      option - the option
      value - the value

    • set

      public void set(ECtransOptionDefinition option, int value)
      Sets the.
      Parameters:
      option - the option
      value - the value

    • set

      public void set(ECtransOptionDefinition option, double value)
      Sets the.
      Parameters:
      option - the option
      value - the value

    • set

      public void set(String name, String value)
      Allow setting the aliases.
      Parameters:
      name - the name
      value - the value

    • set

      public void set(String name, int value)
      Sets the int.
      Parameters:
      name - the name
      value - the value

    • set

      public void set(String name, double value)
      Sets the double.
      Parameters:
      name - the name
      value - the value

    • standardize

      public void standardize(ECtransOptionDefinition option, boolean removeIfSameAsDefault)
      Normalize the representation of the data and remove option with same value as default value if required.
      Parameters:
      option - the option
      removeIfSameAsDefault - remove if same as default value

    • getProperties

      public String getProperties(boolean secured)
      Gets the sorted properties.
      Parameters:
      secured - if true then the private fields are hidden
      Returns:
      the script

    • getScript

      public String getScript()
      Gets the script if the engine exists.
      Returns:
      the script

    • getData

      public String getData()
      Gets the data (sorted properties and script if engine exists).
      Returns:
      the data

    • get

      public int get(String name, int defaultValue)
      Gets the.
      Parameters:
      name - the name
      defaultValue - the default value
      Returns:
      the int

    • getModuleName

      public String getModuleName()
      Gets the module name.
      Returns:
      the module name

    • remove

      public String remove(ECtransOptions option)

    • matches

      public boolean matches(ECtransOptions options, String value)

    • matches

      public boolean matches(ECtransOptions option, String value, String defaultRegex)

    • get

      public String get(ECtransOptions option, String defaultValue)

    • getDuration

      public Duration getDuration(ECtransOptions option)

    • get

      public Duration get(ECtransOptions option, Duration defaultValue)

    • getPeriod

      public Period getPeriod(ECtransOptions option)

    • get

      public Period get(ECtransOptions option, Period defaultValue)

    • get

      public ByteSize get(ECtransOptions option, ByteSize defaultValue)

    • getOptions

      public Options getOptions(ECtransOptions option)

    • getOptions

      public Options getOptions(ECtransOptions option, String delimiters)

    • getOptions

      public Options getOptions(ECtransOptions option, String key, String delimiters)

    • getBooleanList

      public List<Boolean> getBooleanList(ECtransOptions option)

    • getBoolean

      public boolean getBoolean(ECtransOptions option)

    • getBoolean

      public boolean getBoolean(ECtransOptions option, org.graalvm.polyglot.Value bindings)

    • getBooleanObject

      public Boolean getBooleanObject(ECtransOptions option)

    • getBooleanObject

      public Boolean getBooleanObject(ECtransOptions option, org.graalvm.polyglot.Value bindings)

    • getOptionalBoolean

      public Optional<Boolean> getOptionalBoolean(ECtransOptions option)

    • setBooleanIfPresent

      public void setBooleanIfPresent(ECtransOptions option, Consumer<? super Boolean> action)

    • getStringList

      public List<String> getStringList(ECtransOptions option)

    • getString

      public String getString(ECtransOptions option)

    • getChecksumExtension

      public String getChecksumExtension(ECtransOptions legacyMd5ExtOption)

    • getString

      public String getString(ECtransOptions option, org.graalvm.polyglot.Value bindings)

    • getOptionalString

      public Optional<String> getOptionalString(ECtransOptions option)

    • getOptionalString

      public Optional<String> getOptionalString(ECtransOptions option, org.graalvm.polyglot.Value bindings)

    • setStringIfPresent

      public void setStringIfPresent(ECtransOptions option, Consumer<? super String> action)

    • getIntegerList

      public List<Integer> getIntegerList(ECtransOptions option)

    • getInteger

      public Integer getInteger(ECtransOptions option)

    • getInteger

      public Integer getInteger(ECtransOptions option, org.graalvm.polyglot.Value bindings)

    • getOptionalInteger

      public Optional<Integer> getOptionalInteger(ECtransOptions option)

    • setIntegerIfPresent

      public void setIntegerIfPresent(ECtransOptions option, Consumer<? super Integer> action)

    • getLongList

      public List<Long> getLongList(ECtransOptions option)

    • getLong

      public Long getLong(ECtransOptions option)

    • getLong

      public Long getLong(ECtransOptions option, org.graalvm.polyglot.Value bindings)

    • getOptionalLong

      public Optional<Long> getOptionalLong(ECtransOptions option)

    • setLongIfPresent

      public void setLongIfPresent(ECtransOptions option, Consumer<? super Long> action)

    • getDoubleList

      public List<Double> getDoubleList(ECtransOptions option)

    • getDouble

      public Double getDouble(ECtransOptions option)

    • getDouble

      public Double getDouble(ECtransOptions option, org.graalvm.polyglot.Value bindings)

    • getOptionalDouble

      public Optional<Double> getOptionalDouble(ECtransOptions option)

    • setDoubleIfPresent

      public void setDoubleIfPresent(ECtransOptions option, Consumer<? super Double> action)

    • getByteSizeList

      public List<ByteSize> getByteSizeList(ECtransOptions option)

    • getByteSize

      public ByteSize getByteSize(ECtransOptions option)

    • getByteSize

      public ByteSize getByteSize(ECtransOptions option, org.graalvm.polyglot.Value bindings)

    • getOptionalByteSize

      public Optional<ByteSize> getOptionalByteSize(ECtransOptions option)

    • setByteSizeIfPresent

      public void setByteSizeIfPresent(ECtransOptions option, Consumer<? super ByteSize> action)

    • getOptionalDuration

      public Optional<Duration> getOptionalDuration(ECtransOptions option)

    • getOptionalDuration

      public Optional<Duration> getOptionalDuration(ECtransOptions option, org.graalvm.polyglot.Value bindings)

    • setDurationIfPresent

      public void setDurationIfPresent(ECtransOptions option, Consumer<? super Duration> action)

    • getOptionalPeriod

      public Optional<Period> getOptionalPeriod(ECtransOptions option)

    • setPeriodIfPresent

      public void setPeriodIfPresent(ECtransOptions option, Consumer<? super Period> action)

    • getTimeRangeList

      public List<TimeRange> getTimeRangeList(ECtransOptions option)

    • getTimeRange

      public TimeRange getTimeRange(ECtransOptions option)

    • getTimeRange

      public TimeRange getTimeRange(ECtransOptions option, org.graalvm.polyglot.Value bindings)

    • getOptionalTimeRange

      public Optional<TimeRange> getOptionalTimeRange(ECtransOptions option)

    • setTimeRangeIfPresent

      public void setTimeRangeIfPresent(ECtransOptions option, Consumer<? super TimeRange> action)

    • isOptionDefined

      public static boolean isOptionDefined(ECtransOptions option, String content)

    • get

      public boolean get(ECtransOptions option, boolean defaultValue)

    • get

      public long get(ECtransOptions option, long defaultValue)

    • get

      public int get(ECtransOptions option, int defaultValue)

    • set

      public void set(ECtransOptions option, String value)

    • set

      public void set(ECtransOptions option, ByteSize value)

    • set

      public void set(ECtransOptions option, boolean value)

    • set

      public void set(ECtransOptions option, long value)

    • set

      public void set(ECtransOptions option, int value)

    • set

      public void set(ECtransOptions option, double value)

    • standardize

      public void standardize(ECtransOptions option, boolean removeIfSameAsDefault)