CustomVariableProvider

  • CustomVariableProvider is an interface for providing custom variables within an application.

  • The getValue method is the public method of this interface, which returns a String value based on a map of parameters.

  • The getValue method can handle parameters of various types, including String, Double, Boolean, Map, and List values.

  • The getValue method is called from a background thread during event processing and the container reuses a cached instance of the CustomVariableProvider object.
public interface CustomVariableProvider

Callback that is provided by the application to provide a custom variable.

Public Method Summary

abstract String
getValue(Map<String, Object> parameters)
getValue(Map) is given a map of named parameters (the map may contain String, Double, Boolean, Map, or List values).

Public Methods

public abstract String getValue (Map<String, Object> parameters)

getValue(Map) is given a map of named parameters (the map may contain String, Double, Boolean, Map, or List values). It should return a String which is the calculated value of the variable.

This function will be called from a background thread during event processing. The container will cache one instance of this object and reuse it.

Returns
  • the value of the custom variable requested