Index (tias-executor-api 1.10.0 API)

A B C D E F G H I J L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

acceptsJson() - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the header "Accept" to the value "application/json".
add(String, Object) - Method in interface com.technia.tias.executor.api.ConverterAPI.SetProperties: Adds a key/value property.
addEndingPage() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFMergeSettings: Adds a title page
addEndingPage(LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFMergeSettings: Shorter variant for adding an ending page, this method does not allow any additional configuration.
addImage() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermarksSettings: Adds an image based watermark
addJobTags(String...) - Method in interface com.technia.tias.executor.api.JobAPI: Adds extra tags to the current job.
addText() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermarksSettings: Adds a text based watermark
addTitlePage() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFMergeSettings: Adds a title page
addTitlePage(LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFMergeSettings: Shorter variant for adding a title page, this method does not allow any additional configuration.
agentCredentials() - Method in interface com.technia.tias.executor.api.JobRequestMessage
align(String, String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermark: Instead of position the watermark by coordinates, one can align the watermark on the page horizontally and vertically.
and() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Completes the pdf conversion setting configuration
and() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFMergeDocument: Return the ConverterAPI.PDFMergeSettings when done.
and() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFMergeSettings: Completes the pdf conversion setting configuration
and() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFSignSettings: Completes the sign settings and returns the request instance
and() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermark: Completes the configuration of this watermark and returns the parent watermark settings.
and() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermarksSettings: Completes the watermark configuration
and() - Method in interface com.technia.tias.executor.api.ConverterAPI.SetProperties: Completes the set properties configuration
and() - Method in interface com.technia.tias.executor.api.HttpAPI.MultiPartRequestBuilder: Completes the building of the request body and returns the request builder.
and() - Method in interface com.technia.tias.executor.api.HttpAPI.PostParamsBuilder: Completes the addition of post-parameters and returns the parent request builder to be used to configure the request further with.
and() - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Returns the parent request builder.
apply(String) - Method in interface com.technia.tias.executor.api.MacroResolver: Resolves any macros in the input string and returns the resolved value.
applyProperties(boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFMergeDocument: Controls if properties will be transferred to the document that will be merged also.
archiveMode(int) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies the PDF/Archive mode level.
attribute(String, String) - Method in interface com.technia.tias.executor.api.XmlWriter: Write an attribute to the currently open start tag.
attribute(String, String, String) - Method in interface com.technia.tias.executor.api.XmlWriter: Write a namespace associated attribute to the currently open start tag-
attribute(String, String, String, String) - Method in interface com.technia.tias.executor.api.XmlWriter: Write a namespace associated attribute to the currently open start tag-
authorization() - Method in interface com.technia.tias.executor.api.SourceEvent: Returns the authorization value.
authorization(String) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the header "Authorization" to the given value
awaitDSExchangeJob(String, boolean) - Method in interface com.technia.tias.executor.api.JobAPI: When requesting exchange export or import jobs via the DS Enterprise Exchange API, such job is created asynchronously.
awaitingReply(boolean) - Method in interface com.technia.tias.executor.api.ExecutionResult: Sets the awaitingReply flag.

B

base(String) - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Sets the base url.
base64Decode(String) - Method in interface com.technia.tias.executor.api.UtilitiesAPI: Decodes a base64 encoded String into a byte array.
base64DecodeToString(String, String) - Method in interface com.technia.tias.executor.api.UtilitiesAPI: Decodes a base 64 encoded string into a string.
base64Encode(byte[]) - Method in interface com.technia.tias.executor.api.UtilitiesAPI: Encodes an array of bytes into a base 64 encoded string.
base64Encode(String, String) - Method in interface com.technia.tias.executor.api.UtilitiesAPI: Encodes a string into a base64 representation.
body() - Method in interface com.technia.tias.executor.api.HttpAPI.Response: Gives access to the raw body data as a byte array.
body(String, String) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the body text to be sent
bodyFromBlob(String, byte[]) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets a blob / byte array as body
bodyFromFile(String, LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the body content to be sent from the content of the given file.
bodyText() - Method in interface com.technia.tias.executor.api.HttpAPI.Response: Returns the body as a string
BOOLEAN - Enum constant in enum class com.technia.tias.executor.api.XmlAPI.XPathReturnType: Declares that a given XPath expression returns a boolean value
build() - Method in class com.technia.tias.executor.api.ByteArrayData.ByteArrayDataBuilder: Builds the final immutable ByteArrayData instance.
build() - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Completes the building process and returns the immutable Request object that can be used to perform the HTTP call.
build() - Method in interface com.technia.tias.executor.api.JobAPI.JobRequestBuilder: Builds the immutable JobRequest that is used to perform the actual job request with
build() - Method in class com.technia.tias.executor.api.StringData.StringDataBuilder: Builds the final immutable StringData instance.
ByteArrayData - Class in com.technia.tias.executor.api: Data implementation holding binary content as a byte array in memory.
ByteArrayData(byte[], String, Charset, String, String, DataType) - Constructor for class com.technia.tias.executor.api.ByteArrayData: Constructs a new immutable ByteArrayData instance.
ByteArrayData.ByteArrayDataBuilder - Class in com.technia.tias.executor.api: Builder for ByteArrayData instances.

C

callTimeout(long) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the timeout in milliseconds for the complete calls.
cancelled(boolean) - Method in interface com.technia.tias.executor.api.ExecutionResult: Sets the cancelled flag.
cdata(String) - Method in interface com.technia.tias.executor.api.XmlWriter
change(UUID, String, DataType) - Method in interface com.technia.tias.executor.api.DataStorage: This function allows renaming and/or re-typing a specific file.
changePermissionPassword(String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: This is the password that allows the user to access some permissions
changeRule(int) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies the change allowed to the document.
charset - Variable in class com.technia.tias.executor.api.InMemoryData.DataBuilder: Charset value (nullable)
charset() - Method in interface com.technia.tias.executor.api.HttpAPI.ResponseInfo: The character set for the response data, if known and the response data represents character based data.
charset(String) - Method in class com.technia.tias.executor.api.InMemoryData.DataBuilder: The character set for the data
charset(Charset) - Method in class com.technia.tias.executor.api.InMemoryData.DataBuilder: The character set for the data.
close() - Method in interface com.technia.tias.executor.api.XmlWriter: Closes this writer.
code(Integer) - Method in interface com.technia.tias.executor.api.ExecutionResult: Associates the code with the execution result.
com.technia.tias.executor.annotation - package com.technia.tias.executor.annotation
com.technia.tias.executor.api - package com.technia.tias.executor.api: This package contains API that is used by TIF Cloud Executors.
comment(String) - Method in interface com.technia.tias.executor.api.XmlWriter
compass() - Method in interface com.technia.tias.executor.api.DsxUrls: Returns the compass URL
compress(LocalFileAPI.LocalFile, String, String) - Method in interface com.technia.tias.executor.api.LocalFileAPI: Creates a compressed archive, e.g.
configData() - Method in interface com.technia.tias.executor.api.ExecutionContext: Optional configuration data attached with the execution of the job.
configuration() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns the configuration object related to this execution.
configuration(String) - Method in interface com.technia.tias.executor.api.JobAPI.JobRequestBuilder: Specify what configuration to be used for the new job
Configuration - Interface in com.technia.tias.executor.api: Represents a Configuration instance
configurationId() - Method in interface com.technia.tias.executor.api.JobRequestMessage
configurationResolver() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object that can be used to obtain content of other configurations.
ConfigurationResolver - Interface in com.technia.tias.executor.api: The configuration resolver is used to resolve other Configuration instances.
ConfigurationValidator - Interface in com.technia.tias.executor.api: Custom executors can implement this interface in order to provide validation capabilities.
ConfigurationValidator.ValidationResult - Record Class in com.technia.tias.executor.api: Holds the result from a validation call.
connectTimeout(long) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the default connect timeout in milliseconds for new connections.
contains(String) - Method in interface com.technia.tias.executor.api.HttpAPI.Headers: True if there is a header with the given name
containsParam(String) - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Returns true if this UrlBuilder contains a parameter with the given name
content() - Method in interface com.technia.tias.executor.api.Configuration: Returns the content of the configuration.
content() - Method in interface com.technia.tias.executor.api.InputData: Returns the data as a byte array.
contentAsString() - Method in interface com.technia.tias.executor.api.InputData: Tries to convert the data into a string, assuming the bytes stored contains character based data.
contentEncoding() - Method in interface com.technia.tias.executor.api.DataRef: Returns the content encoding (if known)
contentLength() - Method in interface com.technia.tias.executor.api.HttpAPI.ResponseInfo: Returns the size of the response body in bytes.
contentType - Variable in class com.technia.tias.executor.api.InMemoryData.DataBuilder: Content type value (nullable)
contentType() - Method in interface com.technia.tias.executor.api.DataRef: Returns the content type (if known)
contentType() - Method in interface com.technia.tias.executor.api.HttpAPI.ResponseInfo: Returns the content type for the response, if known.
contentType(String) - Method in class com.technia.tias.executor.api.InMemoryData.DataBuilder: Specifies the content type
converterAPI() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an API object, which provides conversion capabilities.
ConverterAPI - Interface in com.technia.tias.executor.api: The converter API contains various methods for converting files between different formats.
ConverterAPI.PDFConversionRequest - Interface in com.technia.tias.executor.api: Contains various methods to configure the PDF conversion request.
ConverterAPI.PDFConversionResult - Interface in com.technia.tias.executor.api: Holds the result of the PDF conversion
ConverterAPI.PDFConversionSettings - Interface in com.technia.tias.executor.api: Configures the PDF conversion itself.
ConverterAPI.PDFMergeDocument - Interface in com.technia.tias.executor.api: Contains information about a document to be merged
ConverterAPI.PDFMergeSettings - Interface in com.technia.tias.executor.api: Contains methods that allows you to merge the main document with for example a title page and/or ending page.
ConverterAPI.PDFSignSettings - Interface in com.technia.tias.executor.api: Specify PDF signing settings
ConverterAPI.PDFWatermark<T> - Interface in com.technia.tias.executor.api: Contains common settings for both image and text based watermarks.
ConverterAPI.PDFWatermarkImage - Interface in com.technia.tias.executor.api: Contains Image based watermark specific settings
ConverterAPI.PDFWatermarksSettings - Interface in com.technia.tias.executor.api: Defines watermark settings
ConverterAPI.PDFWatermarkText - Interface in com.technia.tias.executor.api: Contains text based watermark specific settings.
ConverterAPI.SetProperties - Interface in com.technia.tias.executor.api: Used to declare properties to be set on a document
convertToPDF() - Method in interface com.technia.tias.executor.api.ConverterAPI: Obtains the PDF converter API.
create(String) - Method in interface com.technia.tias.executor.api.LocalFileAPI: Creates a new LocalFile instance that can be used to store data in a temporary / local file.
Credentials - Interface in com.technia.tias.executor.api: Holds some secret credentials data.

D

data() - Method in interface com.technia.tias.executor.api.ExecutionInput: Returns the input data if available.
data(byte[]) - Method in class com.technia.tias.executor.api.ByteArrayData.ByteArrayDataBuilder: Sets the data
data(byte[], String, String) - Method in interface com.technia.tias.executor.api.ExecutionResult: Associates some binary data with the result.
data(byte[], String, String, String) - Method in interface com.technia.tias.executor.api.ExecutionResult: Associates some binary data with the result.
data(String) - Method in class com.technia.tias.executor.api.StringData.StringDataBuilder: Sets the data
data(String, String) - Method in interface com.technia.tias.executor.api.ExecutionResult: Associates some data with the result.
data(String, String, String) - Method in interface com.technia.tias.executor.api.ExecutionResult: Associates some data with the result.
Data - Interface in com.technia.tias.executor.api: A Data instance holds data associated with a job.
DataBuilder() - Constructor for class com.technia.tias.executor.api.InMemoryData.DataBuilder
DataRef - Interface in com.technia.tias.executor.api: A Data reference is a reference to o Data instance.
dataStorage() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object that provides functionality related to storage of data instances.
DataStorage - Interface in com.technia.tias.executor.api: API for reading and storing Data instances.
dataType - Variable in class com.technia.tias.executor.api.InMemoryData.DataBuilder: Specifies type (INBOUND, OUTBOUND, OTHER).
dataType() - Method in interface com.technia.tias.executor.api.DataRef: Returns the type of data this is, one of INBOUND, OUTBOUND or OTHER is returns
dataType(DataType) - Method in class com.technia.tias.executor.api.InMemoryData.DataBuilder: DataType of this data.
dataType(String) - Method in class com.technia.tias.executor.api.InMemoryData.DataBuilder: Specify data type as a string.
DataType - Enum Class in com.technia.tias.executor.api: A Data object is associated with a type, such as if the data is representing outbound data, inbound data or some other kind of data such as generated / converted data.
debug(String, Object...) - Method in interface com.technia.tias.executor.api.ExecutorLogger: Logs a message with the DEBUG level.
delete() - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile: Deletes this file
delete(String) - Method in interface com.technia.tias.executor.api.DataStorage: Deletes a data instance by its name
delete(String) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the request method to DELETE with the specified URL
delete(UUID) - Method in interface com.technia.tias.executor.api.DataStorage: Deletes a data instance by its ID
DELETE - Enum constant in enum class com.technia.tias.executor.api.HttpAPI.Method
description - Variable in class com.technia.tias.executor.api.InMemoryData.DataBuilder: Optional description
description() - Method in interface com.technia.tias.executor.api.DataRef: Returns the description (if known)
description(String) - Method in class com.technia.tias.executor.api.InMemoryData.DataBuilder: The optional description for this data.
detailedMessage() - Method in record class com.technia.tias.executor.api.ConfigurationValidator.ValidationResult: Returns the value of the detailedMessage record component.
detailedMessage(String) - Method in interface com.technia.tias.executor.api.ExecutionResult: Associates a more detailed description or stack trace etc that is helpful to understand the error.
documentEnd() - Method in interface com.technia.tias.executor.api.XmlWriter: Write the end of the document.
documentOpenPassword(String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: If set to a non null value enforces encrypted PDF file with a user password being set.
documentStart() - Method in interface com.technia.tias.executor.api.XmlWriter: Write the start of the document.
documentStart(String, String) - Method in interface com.technia.tias.executor.api.XmlWriter: Write the start of the document.
download(LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.HttpAPI.Request: Performs the request and stores the response body into the given file reference.
download(String, String, boolean) - Method in interface com.technia.tias.executor.api.DsxAPI.DocumentHelperService: Downloads or check-outs the given file into a local-file
drive() - Method in interface com.technia.tias.executor.api.DsxUrls: Returns the 3d-drive URL
dsxAPI() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object that provides access to the 3D-Experience REST API.
DsxAPI - Interface in com.technia.tias.executor.api: API to access the DS REST API.
DsxAPI.DocumentHelperService - Interface in com.technia.tias.executor.api: This service helps out when working with documents and files from TIAS.
dsxUrls() - Method in interface com.technia.tias.executor.api.Environment: Returns all configured DSX URLs
DsxUrls - Interface in com.technia.tias.executor.api: Holds various DSX URLs that is required to know when accessing the DS tenant.
dtd(String) - Method in interface com.technia.tias.executor.api.XmlWriter: Writes a doc type decl.

E

embedStandardFonts(Boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies whether to embed the 14 standard PDF fonts or not.
emptyElement(String) - Method in interface com.technia.tias.executor.api.XmlWriter: Write an empty element.
enableCopyingOfContent(Boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies that the pages and the document content can be extracted to be used in other documents (copy and paste).
enableTextAccessForAccessibilityTools(Boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies that the document content can be extracted to be used in accessibility applications.
encoding() - Method in interface com.technia.tias.executor.api.InputData: The encoding used when converting string based data into bytes.
endElement() - Method in interface com.technia.tias.executor.api.XmlWriter: Close the current tag.
entityRef(String) - Method in interface com.technia.tias.executor.api.XmlWriter
environment() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an environment object that provides functionality to obtain environment variables, secret variables and some other DSX related properties as declared from the Administration UI.
Environment - Interface in com.technia.tias.executor.api: Holds environmental data that is needed in the Executor.
equals(Object) - Method in record class com.technia.tias.executor.api.ConfigurationValidator.ValidationResult: Indicates whether some other object is "equal to" this one.
error(String, Object...) - Method in interface com.technia.tias.executor.api.ExecutorLogger: Logs a message with the error level.
eventClass() - Method in interface com.technia.tias.executor.api.SourceEvent: Returns the event class.
eventMappingId() - Method in interface com.technia.tias.executor.api.JobRequestMessage
eventType() - Method in interface com.technia.tias.executor.api.SourceEvent: Returns the event type.
exchange() - Method in interface com.technia.tias.executor.api.DsxUrls: Returns the exchange URL
execute(ExecutionContext) - Method in interface com.technia.tias.executor.api.Executor: Performs the execution of the Job based upon the provided context input.
ExecutionContext - Interface in com.technia.tias.executor.api: When executing an integration job, the ExecutionContext provides access to various services and APIs needed to conduct for example HTTP calls, performing JSON serialization or deserialization, access data from the 3DEXPERIENCE platform via the DSX-REST API's or performing some conversion or other computation.
ExecutionException - Exception Class in com.technia.tias.executor.api: Execution exception can be thrown from an executor in order to capture execution exceptions.
ExecutionException() - Constructor for exception class com.technia.tias.executor.api.ExecutionException: Default constructor.
ExecutionException(String) - Constructor for exception class com.technia.tias.executor.api.ExecutionException: Constructs a new ExecutionException with the given data.
ExecutionException(String, Throwable) - Constructor for exception class com.technia.tias.executor.api.ExecutionException: Constructs a new ExecutionException with the given data.
ExecutionException(String, Throwable, boolean, boolean) - Constructor for exception class com.technia.tias.executor.api.ExecutionException: Constructs a new ExecutionException with the given data.
ExecutionException(String, Throwable, boolean, long) - Constructor for exception class com.technia.tias.executor.api.ExecutionException: Constructs a new ExecutionException with the given data.
ExecutionException(Throwable) - Constructor for exception class com.technia.tias.executor.api.ExecutionException: Constructs a new ExecutionException with the given data.
ExecutionException(Throwable, boolean, long) - Constructor for exception class com.technia.tias.executor.api.ExecutionException: Constructs a new ExecutionException with the given data.
ExecutionInput - Interface in com.technia.tias.executor.api: Contains methods to access all necessary input data for the current Job.
ExecutionResult - Interface in com.technia.tias.executor.api: Holds the result of the job execution.
Executor - Interface in com.technia.tias.executor.api: An Executor is responsible for executing the logic of an integration job in the TIF Cloud platform.
ExecutorLogger - Interface in com.technia.tias.executor.api: A logger that is used to associate messages of different kind to a job.
exists() - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile: Returns true if the file actually exists.
exists(String) - Method in interface com.technia.tias.executor.api.LocalFileAPI: Checks if there is a local file with the given name.
exit() - Method in interface com.technia.tias.executor.api.ExecutionContext: Calling exit will terminate any further execution of the ongoing job-executor.
exportBookmarks(Boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies if bookmarks are exported to PDF.
exportBookmarksToPDFDestination(Boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies that the bookmarks contained in the source file should be exported to the PDF file as Named Destination (see PDF 1.4 section 8.2.1).
exportFormFields(Boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies whether form fields are exported as widgets or only their fixed print representation is exported.
exportNotes(Boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies if notes are exported to PDF.
extension() - Method in interface com.technia.tias.executor.api.ExecutionContext: For executor implementations part of a TIF extension, this API provides access to metadata from the extension itself.
ExtensionInfo - Interface in com.technia.tias.executor.api: This API provides the executing code with details of the extension, which the code belongs to.
extract(LocalFileAPI.LocalFile, String) - Method in interface com.technia.tias.executor.api.LocalFileAPI: Tries to extract a compressed file into a directory with the given name.

F

failed(boolean) - Method in interface com.technia.tias.executor.api.ExecutionResult: Sets the failed flag.
file() - Method in interface com.technia.tias.executor.api.HttpAPI.LocalFileDownloadResponse: Returns the local file, which contains the response data.
file(LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFMergeDocument: Sets the file to be used for the merge operation.
file(String, String, byte[]) - Method in interface com.technia.tias.executor.api.HttpAPI.MultiPartRequestBuilder: Adds a file to be uploaded.
file(String, String, LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.HttpAPI.MultiPartRequestBuilder: Adds a file to be uploaded.
file(String, String, InputStream) - Method in interface com.technia.tias.executor.api.HttpAPI.MultiPartRequestBuilder: Adds a file to be uploaded.
fileName() - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile
filterElements(NodeList) - Method in interface com.technia.tias.executor.api.XmlAPI: From the provided NodeList argument, filter out Element nodes only
firstHeader(String) - Method in interface com.technia.tias.executor.api.ExecutionInput: Returns the first header value associated with the given name.
firstParam(String) - Method in interface com.technia.tias.executor.api.ExecutionInput: Returns the first parameter value associated with the given name.
followRedirects(boolean) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Specifies whether or not to follow redirects
fontColor(String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermarkText: Sets the font color
fontName(String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermarkText: The name of the font to be used.
fontSize(int) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermarkText: Declares the size of the font
fontStyle(String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermarkText: Declares the font-style to be used
forceFieldUpdate(boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.SetProperties: Set to true to force update of fields in Word documents.
fromString(String) - Static method in enum class com.technia.tias.executor.api.DataType: Safe parsing a string into a DataType value.
fromString(String) - Static method in enum class com.technia.tias.executor.api.HttpAPI.Method
fromString(String) - Static method in enum class com.technia.tias.executor.api.XmlAPI.XPathReturnType: Safe parse of a string into a ReturnType instance without throwing any exception, which the valueOf does.

G

generateBasicAuthToken(String, String) - Method in interface com.technia.tias.executor.api.HttpAPI: Convenient method to generate a Basic authentication token.
get(String) - Method in interface com.technia.tias.executor.api.Environment: Returns the value of the environment variable with the given name.
get(String) - Method in interface com.technia.tias.executor.api.HttpAPI.Headers: Returns the first header with the given name.
get(String) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the request method to GET with the specified URL
get(String) - Method in interface com.technia.tias.executor.api.LocalFileAPI: Retrieves a local file with the given name.
get(String, String) - Method in interface com.technia.tias.executor.api.Environment: Returns the value of the environment variable with the given name.
GET - Enum constant in enum class com.technia.tias.executor.api.HttpAPI.Method
getAll(String) - Method in interface com.technia.tias.executor.api.HttpAPI.Headers: Returns all headers with the given name
getBytes() - Method in class com.technia.tias.executor.api.InMemoryData
getCode() - Method in interface com.technia.tias.executor.api.ExecutionResult: The result code set on the result.
getConfiguration(String) - Method in interface com.technia.tias.executor.api.ConfigurationResolver: Resolves a configuration with the given name.
getContentAsString() - Method in interface com.technia.tias.executor.api.Data: Tries to convert the data into a String using the encoding as specified via the Data.getContentEncoding() method.
getContentAsString() - Method in class com.technia.tias.executor.api.InMemoryData
getContentEncoding() - Method in interface com.technia.tias.executor.api.Data: Returns the content encoding if known.
getContentEncoding() - Method in class com.technia.tias.executor.api.InMemoryData: Returns the content encoding.
getContentType() - Method in interface com.technia.tias.executor.api.Data: Returns the content type of the data, if known.
getContentType() - Method in class com.technia.tias.executor.api.InMemoryData: Returns the content type.
getDescription() - Method in interface com.technia.tias.executor.api.Data: Returns the description for this data instance, if known.
getDescription() - Method in class com.technia.tias.executor.api.InMemoryData: Returns a description of the data.
getDetailedMessage() - Method in interface com.technia.tias.executor.api.ExecutionResult: Detailed message to be associated with this job result, typically used when a job is failed.
getDocumentHelperService() - Method in interface com.technia.tias.executor.api.DsxAPI: Returns the document helper service that simplifies working with files stored in the DS File Store.
getDSXTenantName() - Method in interface com.technia.tias.executor.api.Environment: Returns the name of the DSX tenant.
getEnvVariables() - Method in interface com.technia.tias.executor.api.Environment: Returns the names of the environment variables.
getErrorMessage() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionResult: If the PDF conversion failed, this method should provide error details.
getExchangeService() - Method in interface com.technia.tias.executor.api.DsxAPI: Returns the Exchange service provider
getFileContent(String, String) - Method in interface com.technia.tias.executor.api.DsxAPI.DocumentHelperService: Returns the content of a file as a byte-array.
getHeaders() - Method in interface com.technia.tias.executor.api.ExecutionInput: Returns the optional headers that may have been passed along when the job was invoked.
getInputStream() - Method in interface com.technia.tias.executor.api.Data: This method returns an InputStream from which you can read all the bytes of this data instance.
getInputStream() - Method in class com.technia.tias.executor.api.InMemoryData: Returns an inputstream that contains the bytes representing the data.
getMacroResolver() - Method in interface com.technia.tias.executor.api.Environment: Returns a macro resolver that can resolve dynamic values from the environment OR secrets.
getMessage() - Method in interface com.technia.tias.executor.api.ExecutionResult: Typically if the job is marked as being failed, then this method returns the message giving some brief information about the problem.
getName() - Method in interface com.technia.tias.executor.api.Data: Returns the name of this data instance.
getName() - Method in class com.technia.tias.executor.api.InMemoryData: Returns the name of this data.
getOutputProps() - Method in interface com.technia.tias.executor.api.XmlAPI.TransformResult: Returns the output properties.
getParameters() - Method in interface com.technia.tias.executor.api.ExecutionInput: Returns all optional parameters passed along when the job was created.
getParams(String) - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Returns the parameters with the given name, if any.
getParentJobId() - Method in interface com.technia.tias.executor.api.ExecutionInput: If this job was triggered by another job, then the ID of that parent job is available from this method.
getRaw() - Method in interface com.technia.tias.executor.api.HttpAPI.ParamValue: Returns the raw value
getResult() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionResult: Returns the file holding the converted PDF file.
getResult(String) - Method in interface com.technia.tias.executor.api.XmlAPI.TransformResult: Returns the result as a string
getRetryAttempt() - Method in interface com.technia.tias.executor.api.ExecutionInput: If this is a retry attempt, this method will return the attempt no.
getRetryDelay() - Method in exception class com.technia.tias.executor.api.ExecutionException: Returns the minimum delay to wait until retrying again.
getSecret(String) - Method in interface com.technia.tias.executor.api.Environment: Returns the value of a secret variable.
getSize() - Method in interface com.technia.tias.executor.api.Data: Returns the size of the data content if known.
getSize() - Method in class com.technia.tias.executor.api.InMemoryData: Returns the size of this data.
getSource() - Method in interface com.technia.tias.executor.api.XmlAPI.TransformResult: Returns the transformation result as a Source object.
getSpaceService() - Method in interface com.technia.tias.executor.api.DsxAPI: Returns the space service.
getStream() - Method in interface com.technia.tias.executor.api.XmlAPI.TransformResult: Returns a stream, from which the transformation result can be read.
getTenantSession() - Method in interface com.technia.tias.executor.api.DsxAPI: Deprecated.
This method will be removed! Use the getTenantSession taking an argument.
getTenantSession(AppService) - Method in interface com.technia.tias.executor.api.DsxAPI: Returns a session to the specified AppService.
getTenantSession(String) - Method in interface com.technia.tias.executor.api.DsxAPI: Returns the session to be used for a particular DS application.
getType() - Method in interface com.technia.tias.executor.api.Data: Returns the type for this data instance, if known.
getType() - Method in class com.technia.tias.executor.api.InMemoryData: Returns the type of data, e.g.
getUrl() - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Returns the URL, without any query string parameters.
getURLEncoded() - Method in interface com.technia.tias.executor.api.HttpAPI.ParamValue: Returns the URL encoded value that is used when transmitting the value
getVariables() - Method in interface com.technia.tias.executor.api.ExecutionInput: Returns all optional variables that were resolved when the job was created.

H

hashCode() - Method in record class com.technia.tias.executor.api.ConfigurationValidator.ValidationResult: Returns a hash code value for this object.
HEAD - Enum constant in enum class com.technia.tias.executor.api.HttpAPI.Method
header(String) - Method in interface com.technia.tias.executor.api.ExecutionInput: Returns the headers associated with the given name.
header(String, String) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Adds a header with the given name and value.
header(String, String...) - Method in interface com.technia.tias.executor.api.JobAPI.JobRequestBuilder: Associates a header name / value (or values) with the new job.
headers() - Method in interface com.technia.tias.executor.api.HttpAPI.ResponseInfo: Returns the response headers.
headers(String, Collection<String>) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Adds a header with the given name and values.
headers(Map<String, String>) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the headers as provided from the map argument
httpAPI() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object that provides functionality to perform HTTP(S) calls from the executor.
HttpAPI - Interface in com.technia.tias.executor.api: A simple http API that can be used to invoke remote services in an easy fashion.
HttpAPI.Headers - Interface in com.technia.tias.executor.api: Headers API
HttpAPI.LocalFileDownloadResponse - Interface in com.technia.tias.executor.api: Represents a response, where the data is kept in a LocalFile.
HttpAPI.Method - Enum Class in com.technia.tias.executor.api: Represents the available Http Methods
HttpAPI.MultiPartRequestBuilder - Interface in com.technia.tias.executor.api: Builder used to create multi-part form-data requests, e.g.
HttpAPI.ParamValue - Interface in com.technia.tias.executor.api: Represents a query string parameter value
HttpAPI.PostParamsBuilder - Interface in com.technia.tias.executor.api: Declares common methods for adding parameters to be part of the POST request.
HttpAPI.Request - Interface in com.technia.tias.executor.api: Request API
HttpAPI.RequestBuilder - Interface in com.technia.tias.executor.api: API for building a request.
HttpAPI.Response - Interface in com.technia.tias.executor.api: Standard HTTP response API
HttpAPI.ResponseInfo - Interface in com.technia.tias.executor.api: Contains common response related information
HttpAPI.UrlBuilder - Interface in com.technia.tias.executor.api: API for building a URL.

I

id() - Method in interface com.technia.tias.executor.api.Configuration: Returns the internal ID of the configuration.
id() - Method in interface com.technia.tias.executor.api.Credentials: The ID of the credentials
id() - Method in interface com.technia.tias.executor.api.DataRef: Returns the ID of the referenced Data instance
image(LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermarkImage: Configures what image to be used as watermark.
INBOUND - Enum constant in enum class com.technia.tias.executor.api.DataType: Specifies inbound data
inboundData() - Method in class com.technia.tias.executor.api.InMemoryData.DataBuilder: Shorthand method for setting the dataType to inbound.
info(String, Object...) - Method in interface com.technia.tias.executor.api.ExecutorLogger: Logs a message with the info level.
InMemoryData - Class in com.technia.tias.executor.api: An in-memory representation of a Data instance.
InMemoryData(byte[], String, Charset, String, String, DataType) - Constructor for class com.technia.tias.executor.api.InMemoryData: Constructs a new immutable instance.
InMemoryData(Data) - Constructor for class com.technia.tias.executor.api.InMemoryData: Constructs a new instance from another Data instance.
InMemoryData.DataBuilder<T> - Class in com.technia.tias.executor.api: Base class for various builder implementation that builds Data instances
input() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object holding any input data available to the job.
input(byte[], String, String) - Method in interface com.technia.tias.executor.api.JobAPI.JobRequestBuilder: Associate some input data with the new job
InputData - Interface in com.technia.tias.executor.api: Represents the input data that for example is passed along when a job is being created.
inputFile(LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionRequest: Specifies what input file to be used
inputPassword(String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Special use case when input file is a PDF file and the input file is password protected.
inputStream() - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile
installedBuildNumber() - Method in interface com.technia.tias.executor.api.ExtensionInfo: Returns the build number of the installed extension.
installedMajorVersion() - Method in interface com.technia.tias.executor.api.ExtensionInfo: Returns the major version of the installed extension.
installedMinorVersion() - Method in interface com.technia.tias.executor.api.ExtensionInfo: Returns the minor version of the installed extension.
installedVersion() - Method in interface com.technia.tias.executor.api.ExtensionInfo: Deprecated.
isAwaitingReply() - Method in interface com.technia.tias.executor.api.ExecutionResult: If the job has been marked as awaiting a reply from some other system, this method will return true.
isCancelled() - Method in interface com.technia.tias.executor.api.ExecutionResult: Returns the cancellation flag.
isDebugEnabled() - Method in interface com.technia.tias.executor.api.ExecutorLogger: Tells if debug logging is enabled
isFailed() - Method in interface com.technia.tias.executor.api.ExecutionResult: If the job failed, this method returns true.
isProcessingReply() - Method in interface com.technia.tias.executor.api.ExecutionInput: Returns true if we are processing a reply, e.g.
isRetry() - Method in interface com.technia.tias.executor.api.ExecutionInput: Returns true if this execution is a retry attempt, e.g.
isRetryable() - Method in exception class com.technia.tias.executor.api.ExecutionException: Returns true if the failure is of a kind that could be recovered at a later time by retrying the operation.
isSuccessful() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionResult: Contains information if the PDF conversion was successful or not.

J

jobAPI() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object that provides functionality related to Job handling within TIAS.
JobAPI - Interface in com.technia.tias.executor.api: Contains various methods for spawning new jobs or request information from other jobs.
JobAPI.JobRequest - Interface in com.technia.tias.executor.api: Job request is the object used to perform the actual job-request with.
JobAPI.JobRequestBuilder - Interface in com.technia.tias.executor.api: This builder is used to build/setup new JobRequest instances.
jobId() - Method in interface com.technia.tias.executor.api.JobRequestMessage: Returns the ID of the job itself.
jobName() - Method in interface com.technia.tias.executor.api.JobRequestMessage
jobRequestMessage() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object that describes the job-request it-self.
JobRequestMessage - Interface in com.technia.tias.executor.api: Contains data from the job request message.
jobTag(String) - Method in interface com.technia.tias.executor.api.JobAPI.JobRequestBuilder: Adds a job-tag to be associated with the new job.
jpegQuality(Integer) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies quality of the JPG export.
jsonAPI() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object that provides functionality related to converting objects back/forth JSON representation.
JsonAPI - Interface in com.technia.tias.executor.api: Contains various common JSON related tasks such as serialize and deserialize JSON data.
jsonBody(String) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the body to the given content and using content-type "application/json".

L

list() - Method in interface com.technia.tias.executor.api.DataStorage: Lists all data associated with the current job.
list() - Method in interface com.technia.tias.executor.api.LocalFileAPI: Lists all files and returns them in a List
load() - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile: Reads all bytes from the file into memory.
load(String) - Method in interface com.technia.tias.executor.api.DataStorage: Loads data by its name.
load(UUID) - Method in interface com.technia.tias.executor.api.DataStorage: Loads data by its ID.
loadDataFrom(UUID, String) - Method in interface com.technia.tias.executor.api.JobAPI: Loads a data instance from another job with the given name.
loadText(String) - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile: Loads the content of the file as a text.
localFileAPI() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object that allows working wil local file resource.
LocalFileAPI - Interface in com.technia.tias.executor.api: API for storing/handling files temporarily during a job execution.
LocalFileAPI.LocalFile - Interface in com.technia.tias.executor.api: LocalFile API
logger() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns a logger, which the executor may use in order to associate log-data with the current job.

M

MacroResolver - Interface in com.technia.tias.executor.api: A macro resolver is capable of resolving dynamic values from a string.
maxImageResolution(Long) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Sets the max image resolution value in DPI.
merge() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionRequest: Returns an object that can be used to configure merge of PDF document, like adding title pages and/or ending pages.
message() - Method in record class com.technia.tias.executor.api.ConfigurationValidator.ValidationResult: Returns the value of the message record component.
message(String) - Method in interface com.technia.tias.executor.api.ExecutionResult: Associates the specified message with the execution result.
method(HttpAPI.Method) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the request method to use
method(String) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the request method to use
multiPartRequest() - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Creates a builder for creation of multipart form-data requests.

N

name - Variable in class com.technia.tias.executor.api.InMemoryData.DataBuilder: Defines the name of the data instance.
name() - Method in interface com.technia.tias.executor.api.Configuration: Returns the name of the configuration.
name() - Method in interface com.technia.tias.executor.api.DataRef: Returns the name
name() - Method in interface com.technia.tias.executor.api.ExtensionInfo: Returns the name of the extension.
name() - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile
name(String) - Method in class com.technia.tias.executor.api.InMemoryData.DataBuilder: The name for this data.
names() - Method in interface com.technia.tias.executor.api.HttpAPI.Headers: Returns the names of the headers.
newBuilder() - Static method in class com.technia.tias.executor.api.ByteArrayData: Creates a new ByteArrayDataBuilder instance
newBuilder() - Static method in class com.technia.tias.executor.api.StringData: Returns a new builder instance.
newByteArrayDataBuilder() - Method in interface com.technia.tias.executor.api.DataStorage: Creates and return a new byte array data builder instance
newJob() - Method in interface com.technia.tias.executor.api.JobAPI
newRequestBuilder() - Method in interface com.technia.tias.executor.api.HttpAPI: Creates a new request builder to be used for building up new requests.
newRequestBuilder(String) - Method in interface com.technia.tias.executor.api.HttpAPI: Creates a new request builder instance, populating the builder with all settings defined in the destination with the given name.
newStringDataBuilder() - Method in interface com.technia.tias.executor.api.DataStorage: Creates and return a new string data builder instance
newWriter(LocalFileAPI.LocalFile, String) - Method in interface com.technia.tias.executor.api.XmlAPI: Creates a new xml writer that can be used to write XML data to the given file.
newWriter(Appendable) - Method in interface com.technia.tias.executor.api.XmlAPI: Creates a new xml writer that can be used to write XML data into an appendable.
NODE - Enum constant in enum class com.technia.tias.executor.api.XmlAPI.XPathReturnType: Declares that a given XPath expression returns a single node.
NODESET - Enum constant in enum class com.technia.tias.executor.api.XmlAPI.XPathReturnType: Declares that a given XPath expression returns a set of nodes.
NUMBER - Enum constant in enum class com.technia.tias.executor.api.XmlAPI.XPathReturnType: Declares that a given XPath expression returns a numeric value

O

objectId() - Method in interface com.technia.tias.executor.api.SourceEvent: Returns the identifier of the source object causing the event to be fired.
objectRef() - Method in interface com.technia.tias.executor.api.SourceEvent: Returns the source as a referable instance
objectRelativePath() - Method in interface com.technia.tias.executor.api.SourceEvent: Returns the relative path to the source object causing the event
objectSource() - Method in interface com.technia.tias.executor.api.SourceEvent: Returns the source to the source object causing the event
objectType() - Method in interface com.technia.tias.executor.api.SourceEvent: Returns the type of the source object causing the event
OPTIONS - Enum constant in enum class com.technia.tias.executor.api.HttpAPI.Method
OTHER - Enum constant in enum class com.technia.tias.executor.api.DataType: Used for data that neither can be categorized as inbound nor outbound data.
otherData() - Method in class com.technia.tias.executor.api.InMemoryData.DataBuilder: Shorthand method for setting the dataType to other.
OUTBOUND - Enum constant in enum class com.technia.tias.executor.api.DataType: Specifies outbound data
outboundData() - Method in class com.technia.tias.executor.api.InMemoryData.DataBuilder: Shorthand method for setting the dataType to outbound.
outputStream() - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile

P

pageLocation(String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermark: Specifies the page location for a watermark.
param(String) - Method in interface com.technia.tias.executor.api.ExecutionInput: Returns the parameter associated with the given name.
param(String, HttpAPI.ParamValue) - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Special variant where the value is provided as a ParamValue instance.
param(String, Object) - Method in interface com.technia.tias.executor.api.HttpAPI.MultiPartRequestBuilder: Adds a post parameter/value to be sent along with the request.
param(String, Object) - Method in interface com.technia.tias.executor.api.HttpAPI.PostParamsBuilder: Adds a name/value pair.
param(String, String) - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Adds a parameter with the given name/value.
param(String, String...) - Method in interface com.technia.tias.executor.api.JobAPI.JobRequestBuilder: Associates a param name / value (or values) with the new job.
params(String, HttpAPI.ParamValue...) - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Special variant where the values are provided as ParamValue instances.
params(String, Object...) - Method in interface com.technia.tias.executor.api.HttpAPI.PostParamsBuilder: Adds a parameter with the given name and given values.
params(String, String...) - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Adds a parameter with the given name and values.
params(String, List<Object>) - Method in interface com.technia.tias.executor.api.HttpAPI.PostParamsBuilder: Adds a parameter with the given name and given values.
passport() - Method in interface com.technia.tias.executor.api.DsxUrls: Returns the passport URL
password(String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFSignSettings: The password for the PFX
patch(String) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the request method to PATCH with the specified URL
PATCH - Enum constant in enum class com.technia.tias.executor.api.HttpAPI.Method
path() - Method in interface com.technia.tias.executor.api.ExecutionInput: For example, if the job was invoked via a REST call then this method returns the path used.
path() - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile
path(String) - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Appends some path to the existing URL
pdf() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionRequest: Returns the PDF conversion settings object allowing configuration of the PDF conversion/export.
perform() - Method in interface com.technia.tias.executor.api.HttpAPI.Request: Performs the request and waits for the response
perform() - Method in interface com.technia.tias.executor.api.JobAPI.JobRequest: Performs the job request and returns the ID of the new job.
perform(LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionRequest: Performs the PDF conversion according to configured behavior.
pfxFile(LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFSignSettings: If a personal information exchange file is being used for the certificates, you need to define what the name of this file is.
pfxType(String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFSignSettings: Specifies the type of PFX, for example "pkcs12" or similar.
position(float, float) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermark: Declares an absolute position of the watermark on the page using X/Y coordinates.
post(String) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the request method to POST with the specified URL
POST - Enum constant in enum class com.technia.tias.executor.api.HttpAPI.Method
postParams() - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder
prettyPrint(Source) - Method in interface com.technia.tias.executor.api.XmlAPI: Generate a pretty formatted string of the XML source
prettyPrint(Document) - Method in interface com.technia.tias.executor.api.XmlAPI: Generate a pretty formatted string of the DOM document
prettyPrint(Document, Writer) - Method in interface com.technia.tias.executor.api.XmlAPI: Writes the DOM document in a pretty format to the given writer.
prettyPrint(Node) - Method in interface com.technia.tias.executor.api.XmlAPI: Generate a pretty formatted string of the DOM node
prettyPrint(Node, Writer) - Method in interface com.technia.tias.executor.api.XmlAPI: Writes the DOM node in a pretty format to the given writer.
printingRule(int) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies what printing is allowed.
privateKeyFile(LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFSignSettings: The private key must be provided in PEM format, and be a RSA private key
properties() - Method in interface com.technia.tias.executor.api.Configuration: Returns the properties of this configuration.
properties() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionRequest: Returns the set-properties object allowing to configure the setting of properties on the input file prior to the PDF conversion takes place.
property(String) - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns the value of the property by first querying the underlying configuration for a property with the given key.
publicKeyFile(LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFSignSettings: If using a X.509 certificate, point out the public key file using this.
put(String) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the request method to PUT with the specified URL
PUT - Enum constant in enum class com.technia.tias.executor.api.HttpAPI.Method

R

readTimeout(long) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the read timeout in milliseconds for new connections.
readValue(String, Class<T>) - Method in interface com.technia.tias.executor.api.JsonAPI: Tries to convert a JSON string into a Java object of the given type.
reduceImageResolution(Boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies if the resolution of each image is reduced to the resolution specified by the ConverterAPI.PDFConversionSettings.maxImageResolution(Long).
released() - Method in interface com.technia.tias.executor.api.ExtensionInfo: Returns true if the installed extension is a RELEASED version.
removeParam(String) - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Removes a parameter with the given name
removeParams() - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Removes all query string parameters associated with this builder.
replacePathVariables(Map<String, Object>) - Method in interface com.technia.tias.executor.api.HttpAPI.UrlBuilder: Replaces path variables like ${VARIABLE_1} from values in the given map.
requestMethod() - Method in interface com.technia.tias.executor.api.HttpAPI.ResponseInfo: Returns the actual method used when the request was performed
requestURL() - Method in interface com.technia.tias.executor.api.HttpAPI.ResponseInfo: Returns the requested URL
resolveInput(UUID) - Method in interface com.technia.tias.executor.api.JobAPI: Resolves the input for another job with the given ID.
result() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object allowing to specify the result/outcome of the execution of this job.
rotate(int) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermark: Defines the rotation in degrees of the image.

S

save(byte[]) - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile: Saves the bytes into the file.
saveLocal(Data, String) - Method in interface com.technia.tias.executor.api.LocalFileAPI: Saves a data instance as a local file
saveText(String, String) - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile: Saves the text to the file using either the specified charset, or UTF-8 if not specified, to convert the String into bytes.
scale(float) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermark: Defines scaling of image.
securityContext() - Method in interface com.technia.tias.executor.api.JobRequestMessage
selectNodes(Node, String) - Method in interface com.technia.tias.executor.api.XmlAPI: Evaluates an XPath expression starting from the given node and returns a list of matched nodes.
selectValue(Node, String, XmlAPI.XPathReturnType) - Method in interface com.technia.tias.executor.api.XmlAPI: Evaluates an XPath expression starting from the given node and returns the result as a string.
selectValues(Node, String, XmlAPI.XPathReturnType) - Method in interface com.technia.tias.executor.api.XmlAPI: Evaluates an XPath expression starting from the given node and returns the result as a list of strings.
self() - Method in class com.technia.tias.executor.api.InMemoryData.DataBuilder
serialize(Object) - Method in interface com.technia.tias.executor.api.JsonAPI: Serializes a Java object into a JSON string representation.
serialize(Document) - Method in interface com.technia.tias.executor.api.XmlAPI: Serializes a DOM document into a string representation
serialize(Document, LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.XmlAPI: Serializes a DOM document into a file
serialize(Document, OutputStream) - Method in interface com.technia.tias.executor.api.XmlAPI: Serializes a DOM document into an output stream
serialize(Document, Writer) - Method in interface com.technia.tias.executor.api.XmlAPI: Serializes a DOM document into a writer.
setJobDescription(String) - Method in interface com.technia.tias.executor.api.JobAPI: Sets the job-description for the current running job.
sign() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionRequest: Returns the sign settings allowing you to configure any PDF digital signature
size() - Method in interface com.technia.tias.executor.api.DataRef: Returns the size of the data
size() - Method in interface com.technia.tias.executor.api.InputData: Returns the size of the input data, e.g.
size() - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile
source() - Method in interface com.technia.tias.executor.api.JobRequestMessage
sourceEvent() - Method in interface com.technia.tias.executor.api.JobRequestMessage
SourceEvent - Interface in com.technia.tias.executor.api: Contains data from the source event that triggered this job.
space() - Method in interface com.technia.tias.executor.api.DsxUrls: Returns the 3d-space URL
startElement(String) - Method in interface com.technia.tias.executor.api.XmlWriter: Write a start element.
startElement(String, String) - Method in interface com.technia.tias.executor.api.XmlWriter
startElement(String, String, String) - Method in interface com.technia.tias.executor.api.XmlWriter
startElement(String, Map<String, String>) - Method in interface com.technia.tias.executor.api.XmlWriter: Write a start element with attributes.
state() - Method in interface com.technia.tias.executor.api.SourceEvent: If the event was a status changed event, this method returns the state of the object.
statusCode() - Method in interface com.technia.tias.executor.api.HttpAPI.ResponseInfo: Returns the HTTP status code
statusMessage() - Method in interface com.technia.tias.executor.api.HttpAPI.ResponseInfo: Returns the HTTP status message
store(Data) - Method in interface com.technia.tias.executor.api.DataStorage: Stores the given data
stream() - Method in interface com.technia.tias.executor.api.InputData: Returns the data as an stream.
STRING - Enum constant in enum class com.technia.tias.executor.api.XmlAPI.XPathReturnType: Declares that a given XPath expression returns a string value
StringData - Class in com.technia.tias.executor.api: Data implementation for String based data.
StringData(String, String, Charset, String, String, DataType) - Constructor for class com.technia.tias.executor.api.StringData: Constructs a new immutable StringData instance.
StringData.StringDataBuilder - Class in com.technia.tias.executor.api: Builder for StringData instances.
succeeded() - Method in interface com.technia.tias.executor.api.HttpAPI.ResponseInfo: This method returns true in case the HTTP status code is 2xx.
swym() - Method in interface com.technia.tias.executor.api.DsxUrls: Returns the swym URL

T

text(String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFWatermarkText: Defines the text to be used
text(String) - Method in interface com.technia.tias.executor.api.XmlWriter: Writes the specified text.
textElement(String, String) - Method in interface com.technia.tias.executor.api.XmlWriter: Write a text element.
textElement(String, Map<String, String>, String) - Method in interface com.technia.tias.executor.api.XmlWriter: Write a text element with attributes.
toData(String, String, String, String) - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile: Converts this instance to a Data instance to be used with the data storage API and having its data-type set to OTHER.
toDOM(LocalFileAPI.LocalFile) - Method in interface com.technia.tias.executor.api.XmlAPI: Parses a file containing XML data into a DOM Document
toDOM(String) - Method in interface com.technia.tias.executor.api.XmlAPI: Parses a string containing XML data into a DOM Document
toMap() - Method in interface com.technia.tias.executor.api.HttpAPI.Headers: Returns all headers copied into a new map.
toOutboundData(String, String, String, String) - Method in interface com.technia.tias.executor.api.LocalFileAPI.LocalFile: Converts this instance to a Data instance to be used with the data storage API and having its data-type set to OUTBOUND.
toSource(String) - Method in interface com.technia.tias.executor.api.XmlAPI: Creates a Source representation of the XML data held in the given String.
toSource(Document) - Method in interface com.technia.tias.executor.api.XmlAPI: Creates a Source representation of the XML DOM tree.
toString() - Method in record class com.technia.tias.executor.api.ConfigurationValidator.ValidationResult: Returns a string representation of this record class.
transform(Source, Source, LocalFileAPI.LocalFile, Map<String, ?>) - Method in interface com.technia.tias.executor.api.XmlAPI: Transforms the XML data using an XSLT stylesheet into the given file.
transform(Source, Source, Map<String, ?>) - Method in interface com.technia.tias.executor.api.XmlAPI: Transforms XML data using an XSLT stylesheet into another format.
tsaURL(String) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFSignSettings: Allows to configure a custom TSA URL to be used over the default.
type() - Method in interface com.technia.tias.executor.api.Configuration: Returns the type of the configuration
type() - Method in interface com.technia.tias.executor.api.InputData: Returns the content type representing the data, if known.

U

uiConfigDefinition() - Method in interface com.technia.tias.executor.api.ExtensionInfo: Returns the UI configuration definition itself.
uiConfigValues() - Method in interface com.technia.tias.executor.api.ExtensionInfo: Returns the UI configuration values entered via the admin UI screen or screens related to the Extension.
updateExcelFieldRefs(boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.SetProperties: Set to true to iterate cells in the Excel spreadsheet to update links/refs to document properties.
uploadFileVersion(LocalFileAPI.LocalFile, String, String, String, String, boolean) - Method in interface com.technia.tias.executor.api.DsxAPI.DocumentHelperService: Creates a new version of an existing file.
uploadNew(LocalFileAPI.LocalFile, String, String, String) - Method in interface com.technia.tias.executor.api.DsxAPI.DocumentHelperService: Uploads the local file as a new file into the given Document object.
url() - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Returns an url builder, which helps you construct complex URLs.
url(String) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Specifies the URL to be used.
useLosslessCompression(Boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Specifies if graphics are exported to PDF using a lossless compression eg.
user() - Method in interface com.technia.tias.executor.api.SourceEvent: Returns the 3DX user
useTaggedPDF(Boolean) - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionSettings: Determines if PDF are created by using special tags also known as Tagged PDF.
UtilitiesAPI - Interface in com.technia.tias.executor.api: This API provides various methods commonly used by job execution code.
utilsAPI() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object that provides miscellaneous utility functions related to commonly used tasks done as part of executing a Job.

V

valid() - Method in record class com.technia.tias.executor.api.ConfigurationValidator.ValidationResult: Returns the value of the valid record component.
validate(Configuration, ConfigurationResolver) - Method in interface com.technia.tias.executor.api.ConfigurationValidator: Performs validation check on the given Configuration.
ValidationResult(boolean, String, String) - Constructor for record class com.technia.tias.executor.api.ConfigurationValidator.ValidationResult: Creates an instance of a ValidationResult record class.
valueOf(String) - Static method in enum class com.technia.tias.executor.api.DataType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.technia.tias.executor.api.HttpAPI.Method: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.technia.tias.executor.api.XmlAPI.XPathReturnType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.technia.tias.executor.api.DataType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.technia.tias.executor.api.HttpAPI.Method: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.technia.tias.executor.api.XmlAPI.XPathReturnType: Returns an array containing the constants of this enum class, in the order they are declared.
variable(String) - Method in interface com.technia.tias.executor.api.ExecutionInput: Returns the variable associated with the given name.

W

warning(String, Object...) - Method in interface com.technia.tias.executor.api.ExecutorLogger: Logs a message with the warning level.
watermark() - Method in interface com.technia.tias.executor.api.ConverterAPI.PDFConversionRequest: Returns the watermark settings allowing you to configure watermarks to be applied on the generated PDF document.
writeNamespace(String, String) - Method in interface com.technia.tias.executor.api.XmlWriter
writeTimeout(long) - Method in interface com.technia.tias.executor.api.HttpAPI.RequestBuilder: Sets the default write timeout in milliseconds for new connections.
writeValue(Object, OutputStream) - Method in interface com.technia.tias.executor.api.JsonAPI: Converts a Java object into a JSON string representation and writes the bytes of this string encoded with UTF-8 encoding to the given OutputStream.

X

xmlAPI() - Method in interface com.technia.tias.executor.api.ExecutionContext: Returns an object that provides functionality related to XML document parsing, transformation and processing.
XmlAPI - Interface in com.technia.tias.executor.api: Contains various methods to perform XML / XSLT / XPATH related operations.
XmlAPI.TransformResult - Interface in com.technia.tias.executor.api: Represents a result from an XML transformation.
XmlAPI.XPathReturnType - Enum Class in com.technia.tias.executor.api: Declares different kind of XPath return types.
XmlWriter - Interface in com.technia.tias.executor.api: Writes XML documents.

A B C D E F G H I J L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form