Interface RuntimeExtension
-
@ConsumerType public interface RuntimeExtension
ARuntimeExtension
represents a HTL runtime construct that provides some processing capabilities for the variousdata-sly-*
block elements.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FORMAT
The name of the runtime function that will process string formatting.static java.lang.String
I18N
The name of the runtime function that will process i18n.static java.lang.String
INCLUDE
The name of the runtime function that will perform script execution delegation.static java.lang.String
JOIN
The name of the runtime function that will process join operations on arrays.static java.lang.String
NAME
For OSGi environments this is the name of the service registration property indicating theRuntimeExtension
name.static java.lang.String
RESOURCE
The name of the runtime function that will perform resource inclusion in the rendering process.static java.lang.String
URI_MANIPULATION
The name of the runtime function that will provide URI manipulation support.static java.lang.String
USE
The name of the runtime function that will provide the support for loading Use-API objects.static java.lang.String
XSS
The name of the runtime function that will provide XSS escaping and filtering support.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Object
call(RenderContext renderContext, java.lang.Object... arguments)
Call theRuntimeExtension
-
-
-
Field Detail
-
FORMAT
static final java.lang.String FORMAT
The name of the runtime function that will process string formatting. The function will receive the following parameters:
- the format String (e.g. 'Hello {0}, welcome to {1}')
- an array of objects that will replace the format placeholders
For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#122-format.
- See Also:
- Constant Field Values
-
I18N
static final java.lang.String I18N
The name of the runtime function that will process i18n. The function will receive the following parameters:
- the String to translate
- optional: locale information
- optional: hint information
- optional (not part of the specification): basename information; for more details see
ResourceBundle.getBundle(String, java.util.Locale)
For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#123-i18n.
- See Also:
- Constant Field Values
-
JOIN
static final java.lang.String JOIN
The name of the runtime function that will process join operations on arrays. The function will receive the following parameters:
- the array of objects to join (e.g. [1, 2, 3])
- the join string (e.g. ';')
For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#124-array-join.
- See Also:
- Constant Field Values
-
URI_MANIPULATION
static final java.lang.String URI_MANIPULATION
The name of the runtime function that will provide URI manipulation support. The function will receive the following parameters:
- optional: a URI string to process
- optional: a Map containing URI manipulation options
For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#125-uri-manipulation.
- See Also:
- Constant Field Values
-
XSS
static final java.lang.String XSS
The name of the runtime function that will provide XSS escaping and filtering support. The function will receive the following parameters:
- the original string to escape / filter
- the context to be applied
For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#121-display-context.
- See Also:
- Constant Field Values
-
INCLUDE
static final java.lang.String INCLUDE
The name of the runtime function that will perform script execution delegation. The function will receive the following parameters:
- optional: the relative or absolute path of the script to execute
- optional: a Map of options to perform script include processing
For more details about the supported options check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#228-include.
- See Also:
- Constant Field Values
-
RESOURCE
static final java.lang.String RESOURCE
The name of the runtime function that will perform resource inclusion in the rendering process. The function will receive the following parameters:
- optional: a relative or absolute path of the resource to be included
- optional: a Map containing the resource processing options
For more details about the supported options check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#229-resource.
- See Also:
- Constant Field Values
-
USE
static final java.lang.String USE
The name of the runtime function that will provide the support for loading Use-API objects. The function will receive the following parameters:
- an identifier that allows to discover the Use-API object that needs to be loaded
- optional: a Map of the arguments that are passed to the Use-API object for initialisation or to provide context
For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#221-use.
- See Also:
- Constant Field Values
-
NAME
static final java.lang.String NAME
For OSGi environments this is the name of the service registration property indicating theRuntimeExtension
name.- See Also:
- Constant Field Values
-
-
Method Detail
-
call
java.lang.Object call(RenderContext renderContext, java.lang.Object... arguments)
Call theRuntimeExtension
- Parameters:
renderContext
- the runtime contextarguments
- the call arguments- Returns:
- an extension instance
-
-