Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ActionParameterType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid parameter keys for ActionContent.parameters configuration.
- actionType() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns the value of the
actionTyperecord component. - actionType(String) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- ActionType - Enum Class in com.bonitasoft.processbuilder.enums
-
Represents the type of action to be performed on a business object.
- addEmailForUser(Set<String>, IdentityAPI, Long, boolean) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Processes a single user ID and adds email (direct or manager) to the set.
- addMethod(RestApiTemplate.Method) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- addMethod(String, String, String) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- addMethod(String, String, String, String, String, Map<String, String>, String) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
-
Adds a method with full configuration including displayName, description, and body template.
- addMethod(String, String, String, Map<String, String>) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- AI_PROVIDER - Enum constant in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Represents an AI provider configuration for integrating external AI/LLM services.
- ALERT - Enum constant in enum class com.bonitasoft.processbuilder.enums.FormContentType
-
Content type for alert-related form actions.
- API_KEY - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
API Key authentication.
- API_KEY - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.AuthType
- apiKey(String, String, RestApiKeyLocation) - Static method in interface com.bonitasoft.processbuilder.records.RestAuthConfig
-
Creates an API key authentication configuration.
- apiKeyAuth(String, String) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- ApiKeyAuth(String, String, RestApiKeyLocation) - Constructor for record class com.bonitasoft.processbuilder.records.RestAuthConfig.ApiKeyAuth
-
Creates an instance of a
ApiKeyAuthrecord class. - ApiKeyAuthConfig - Record Class in com.bonitasoft.processbuilder.extension.template.auth
-
Configuration for API Key Authentication.
- ApiKeyAuthConfig(String, String) - Constructor for record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
- ApiKeyAuthConfig(String, String, ApiKeyAuthConfig.Location) - Constructor for record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
-
Creates an instance of a
ApiKeyAuthConfigrecord class. - ApiKeyAuthConfig.Location - Enum Class in com.bonitasoft.processbuilder.extension.template.auth
- apiKeyHeader(String, String, String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Creates a generic template with API KEY in HEADER.
- apiKeyQuery(String, String, String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Creates a generic template with API KEY in QUERY parameter.
- APP_NAME - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The application name displayed in the header and title.
- applyEmailTemplate(String, String) - Static method in class com.bonitasoft.processbuilder.extension.PBHtmlUtils
-
Applies an email template by replacing the {{content}} placeholder with the provided content.
- ARCHIVED - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
Future state: The instance is moved to historical records for dashboard performance.
- ARCHIVED - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
The process definition is marked as historical and is no longer used.
- asTemplate() - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
-
Marks this as a template definition (includes isTemplate, templateVersion, requiredFields in JSON).
- ASYNCHRONOUS_TIMER_SYNCHRONIZATION_JOB - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for the asynchronous timer synchronization job.
- audience() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
-
Returns the value of the
audiencerecord component. - audience() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Returns the value of the
audiencerecord component. - audience(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.Builder
- auth() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
authrecord component. - auth() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns the value of the
authrecord component. - auth(AuthConfig) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- auth(RestAuthConfig) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- AuthConfig - Interface in com.bonitasoft.processbuilder.extension.template.auth
-
Sealed interface for REST API authentication configuration.
- AuthPipeline - Class in com.bonitasoft.processbuilder.execution
-
Pipeline for normalizing and decrypting authentication configuration.
B
- BACKGROUND_COLOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The main background color of the application.
- BASE_FONT_SIZE - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The base font size for the application.
- baseUrl() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
baseUrlrecord component. - baseUrl(String) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- basic(String, String) - Static method in interface com.bonitasoft.processbuilder.records.RestAuthConfig
-
Creates a basic authentication configuration.
- BASIC - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
HTTP Basic Authentication using username and password.
- BASIC - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.AuthType
- basicAuth(String, String) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- basicAuth(String, String, String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Creates a generic template with BASIC authentication.
- BasicAuth(String, String, boolean) - Constructor for record class com.bonitasoft.processbuilder.records.RestAuthConfig.BasicAuth
-
Creates an instance of a
BasicAuthrecord class. - BasicAuthConfig - Record Class in com.bonitasoft.processbuilder.extension.template.auth
-
Configuration for HTTP Basic Authentication.
- BasicAuthConfig(String, String) - Constructor for record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
- BasicAuthConfig(String, String, boolean) - Constructor for record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
-
Creates an instance of a
BasicAuthConfigrecord class. - BasicAuthConfig.Builder - Class in com.bonitasoft.processbuilder.extension.template.auth
- BDMAuditUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility class providing methods to automatically set creation and modification metadata on Business Data Model (BDM) objects using Java Reflection.
- BDMObjectType - Enum Class in com.bonitasoft.processbuilder.enums
-
Enumeration of BDM (Business Data Model) object types used in the Process Builder extension.
- bearer(String) - Static method in interface com.bonitasoft.processbuilder.records.RestAuthConfig
-
Creates a bearer token authentication configuration.
- BEARER - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Bearer token authentication (JWT, OAuth2 access tokens).
- BEARER - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.AuthType
- bearerAuth(String) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- bearerAuth(String, String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Creates a generic template with BEARER token authentication.
- BearerAuth(String) - Constructor for record class com.bonitasoft.processbuilder.records.RestAuthConfig.BearerAuth
-
Creates an instance of a
BearerAuthrecord class. - BearerAuthConfig - Record Class in com.bonitasoft.processbuilder.extension.template.auth
-
Configuration for Bearer Token Authentication.
- BearerAuthConfig(String) - Constructor for record class com.bonitasoft.processbuilder.extension.template.auth.BearerAuthConfig
-
Creates an instance of a
BearerAuthConfigrecord class. - BINARY - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Binary/octet-stream content type (application/octet-stream).
- body() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns the value of the
bodyrecord component. - body() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns the value of the
bodyrecord component. - body() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Returns the value of the
bodyrecord component. - body(String) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- body(String) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- BODY - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestOAuth2ClientAuthMethod
-
Client credentials sent in the request body as form parameters.
- BODY - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.ClientAuthMethod
- bodyAs(Class<T>) - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Parses the response body as a specific type.
- bodyAsJson() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Parses the response body as JSON.
- bodyTemplate() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Returns the value of the
bodyTemplaterecord component. - BONITA - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessStorageType
-
Files are stored within the Bonita BDM database and are retained indefinitely.
- BONITA_AND_DELETE - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessStorageType
-
Files are stored within the Bonita BDM database and are deleted upon process completion.
- BONITA_REMOTE - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
Bonita Remote - Connect to another Bonita instance
- bonitaRemote(String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Bonita BPM Remote Instance - Connect to another Bonita server.
- BORDER_COLOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The color used for borders.
- BORDER_RADIUS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The border radius used for buttons, cards, and input fields.
- build() - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- build() - Method in class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig.Builder
- build() - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.Builder
- build() - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig.Builder
- build() - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- build() - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- buildAllHeaders() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Builds all headers including auth headers and content type.
- buildCandidateUsers(Long, boolean, List<?>, IdentityAPI) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Builds a set of candidate user IDs for task assignation based on step user, manager, and memberships.
- builder() - Static method in record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
- builder() - Static method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
- builder() - Static method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
- builder() - Static method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
- builder(String) - Static method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
- builder(String) - Static method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Creates a new builder for RestServiceRequest.
- Builder() - Constructor for class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig.Builder
- Builder() - Constructor for class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.Builder
- Builder() - Constructor for class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig.Builder
- Builder() - Constructor for class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- buildFinalUrl(String, String) - Static method in class com.bonitasoft.processbuilder.execution.TemplateSubstitution
-
Builds a final URL by joining baseUrl and path with proper slash handling.
- buildFullUrl() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Builds the full URL including query parameters.
- buildMembershipKey(Long, Long) - Static method in class com.bonitasoft.processbuilder.extension.MembershipUtils
-
Constructs a composite membership key (Group ID$Role ID) if both IDs are present.
C
- calculateElapsedTime(long) - Static method in class com.bonitasoft.processbuilder.extension.Utils
-
Calculates the elapsed time from a given start point up to the current moment.
- calculateElapsedTime(long, long) - Static method in class com.bonitasoft.processbuilder.extension.Utils
-
Calculates the elapsed time between two given time points.
- CANCELED - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
The instance was manually terminated before completion.
- CANCELED - Enum constant in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
The step was bypassed or manually terminated.
- canLaunchProcess() - Method in record class com.bonitasoft.processbuilder.records.UserList
-
Returns the value of the
canLaunchProcessrecord component. - CATEGORY - Enum constant in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Represents a category object used for classification or grouping.
- CERTIFICATE - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Client Certificate Authentication (mTLS).
- checkPositiveIntegerInput(String, Supplier<Object>) - Static method in class com.bonitasoft.processbuilder.extension.InputValidationUtils
-
Checks if a given input parameter is a positive Integer.
- checkPositiveLongInput(String, Supplier<Object>) - Static method in class com.bonitasoft.processbuilder.extension.InputValidationUtils
-
Checks if a given input parameter is a positive Long.
- clearSessionCache() - Static method in class com.bonitasoft.processbuilder.execution.HttpExecutor
- clearTokenCache() - Static method in class com.bonitasoft.processbuilder.execution.HttpExecutor
- clientAuthMethod() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
-
Returns the value of the
clientAuthMethodrecord component. - clientAuthMethod() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Returns the value of the
clientAuthMethodrecord component. - clientAuthMethod(OAuth2ClientConfig.ClientAuthMethod) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.Builder
- clientId() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
-
Returns the value of the
clientIdrecord component. - clientId() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
-
Returns the value of the
clientIdrecord component. - clientId() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Returns the value of the
clientIdrecord component. - clientId() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
-
Returns the value of the
clientIdrecord component. - clientId(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.Builder
- clientId(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig.Builder
- clientSecret() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
-
Returns the value of the
clientSecretrecord component. - clientSecret() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
-
Returns the value of the
clientSecretrecord component. - clientSecret() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Returns the value of the
clientSecretrecord component. - clientSecret() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
-
Returns the value of the
clientSecretrecord component. - clientSecret(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.Builder
- clientSecret(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig.Builder
- collectAllUserIds(UsersConfigRecord, Function<String, T>, Function<T, Long>, Function<String[], List<M>>, IdentityAPI, Logger) - Static method in class com.bonitasoft.processbuilder.extension.TaskAssignationUtils
-
Collects all candidate user IDs based on the user configuration.
- com.bonitasoft.processbuilder.constants - package com.bonitasoft.processbuilder.constants
-
Provides non-instantiable utility classes containing application-wide static constants.
- com.bonitasoft.processbuilder.enums - package com.bonitasoft.processbuilder.enums
-
Provides enumerations (enums) for defining and managing a set of named constants used throughout the application.
- com.bonitasoft.processbuilder.execution - package com.bonitasoft.processbuilder.execution
-
Execution engine for REST and SMTP connectors.
- com.bonitasoft.processbuilder.extension - package com.bonitasoft.processbuilder.extension
-
Provides classes and utilities for extending the Bonita platform's functionality.
- com.bonitasoft.processbuilder.extension.template - package com.bonitasoft.processbuilder.extension.template
- com.bonitasoft.processbuilder.extension.template.auth - package com.bonitasoft.processbuilder.extension.template.auth
- com.bonitasoft.processbuilder.extension.template.catalog - package com.bonitasoft.processbuilder.extension.template.catalog
- com.bonitasoft.processbuilder.mapper - package com.bonitasoft.processbuilder.mapper
-
Provides mapper utilities for transforming and converting Bonita entity objects.
- com.bonitasoft.processbuilder.records - package com.bonitasoft.processbuilder.records
-
Provides Record classes (available in Java 16 and later) which serve as containers for immutable and transparent data structures.
- com.bonitasoft.processbuilder.utils - package com.bonitasoft.processbuilder.utils
- com.bonitasoft.processbuilder.validation - package com.bonitasoft.processbuilder.validation
-
Provides utilities and core logic for business data and input validation.
- COMMON_ACTION_EXECUTOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for CommonActionExecutor.
- compareValues(Comparable<?>, Comparable<?>) - Static method in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Compares two
Comparablevalues in a type-safe manner. - COMPLETED - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
The instance has successfully completed its final step.
- COMPLETED - Enum constant in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
The human task has been successfully completed by the user (e.g., the form was submitted).
- compress(String) - Static method in class com.bonitasoft.processbuilder.utils.CompressionUtils
-
Compresses a string using GZIP compression and encodes it as Base64.
- CompressionUtils - Class in com.bonitasoft.processbuilder.utils
-
Utility class for compressing and decompressing strings using GZIP compression and Base64 encoding.
- configJson() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns the value of the
configJsonrecord component. - CONFIGURATION - Enum constant in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Represents a system configuration object containing key-value settings.
- ConfigurationType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid types used to classify generic configuration entries (master data or lookup records) within the system.
- ConfigurationUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility class for safely retrieving and handling configuration values.
- ConnectorExecutionEngine - Class in com.bonitasoft.processbuilder.execution
-
Facade for executing REST connectors.
- ConnectorExecutionEngine() - Constructor for class com.bonitasoft.processbuilder.execution.ConnectorExecutionEngine
- ConnectorExecutionEngine(HttpExecutor) - Constructor for class com.bonitasoft.processbuilder.execution.ConnectorExecutionEngine
- ConnectorRequest - Record Class in com.bonitasoft.processbuilder.execution
-
Input request for the ConnectorExecutionEngine.
- ConnectorRequest(String, String, String, Map<String, String>, String, Map<String, String>, String, int, Boolean, String, Map<String, String>) - Constructor for record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Creates an instance of a
ConnectorRequestrecord class. - ConnectorRequest.Builder - Class in com.bonitasoft.processbuilder.execution
- ConnectorResponse - Record Class in com.bonitasoft.processbuilder.execution
-
Output response from the ConnectorExecutionEngine.
- ConnectorResponse(boolean, int, String, Map<String, String>, String, long, String, String) - Constructor for record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Creates an instance of a
ConnectorResponserecord class. - Constants - Class in com.bonitasoft.processbuilder.constants
-
Utility class containing all application-wide constant values.
- CONTAINER_BACKGROUND - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The background color for containers and cards.
- CONTENT_TYPE_FORM - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Form URL encoded content type.
- CONTENT_TYPE_JSON - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON content type.
- CONTENT_TYPE_JSON_UTF8 - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON content type with UTF-8 charset.
- CONTENT_TYPE_TEXT - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Plain text content type.
- CONTENT_TYPE_XML - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
XML content type.
- contentType() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns the value of the
contentTyperecord component. - contentType() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Returns the value of the
contentTyperecord component. - contentType(RestContentType) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- convertJsonNodeToObject(JsonNode) - Static method in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Converts a
JsonNodeto its corresponding Java object type. - convertStringToJsonNode(String) - Static method in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Converts a JSON string to a
JsonNode. - convertTextToHtml(String) - Static method in class com.bonitasoft.processbuilder.extension.PBHtmlUtils
-
Converts text content to HTML format with selective XSS protection.
- createOrUpdateAuditData(T, T, Class<T>, UserRecord, Long) - Static method in class com.bonitasoft.processbuilder.extension.BDMAuditUtils
-
Applies audit metadata (creation or modification) to a BDM object.
- createRecipientResolver(IdentityAPI, Long) - Static method in class com.bonitasoft.processbuilder.extension.TemplateDataResolver
-
Creates a simple resolver for recipient-only variables.
- createResolver(IdentityAPI, Long, String, Long, BiFunction<String, String, String>) - Static method in class com.bonitasoft.processbuilder.extension.TemplateDataResolver
-
Creates a complete BiFunction resolver for template variables.
- createResolverWithTaskLink(IdentityAPI, Long, String, Long) - Static method in class com.bonitasoft.processbuilder.extension.TemplateDataResolver
-
Creates a resolver with task link support.
- createStepDataResolver(Function<String, T>, Function<T, String>, Function<T, String>) - Static method in class com.bonitasoft.processbuilder.extension.TemplateDataResolver
-
Creates a step-based data extractor function.
- CRITICALITY - Enum constant in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Represents the classification key for **Process Criticality** definitions.
- CriticalityType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid criticality levels for a business process, along with their business descriptions.
- CryptoException(String) - Constructor for exception com.bonitasoft.processbuilder.extension.PasswordCrypto.CryptoException
-
Constructs a new CryptoException with the specified detail message.
- CryptoException(String, Throwable) - Constructor for exception com.bonitasoft.processbuilder.extension.PasswordCrypto.CryptoException
-
Constructs a new CryptoException with the specified detail message and cause.
- CUSTOM - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Custom authentication with user-defined headers.
- CustomAuth(Map<String, String>) - Constructor for record class com.bonitasoft.processbuilder.records.RestAuthConfig.CustomAuth
-
Creates an instance of a
CustomAuthrecord class.
D
- DataResolverType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid data resolver types used to resolve dynamic placeholders in templates.
- DAYS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The number of days parameter for delay or scheduling actions.
- decompress(String) - Static method in class com.bonitasoft.processbuilder.utils.CompressionUtils
-
Decompresses a Base64-encoded GZIP-compressed string back to its original form.
- decrypt(String) - Static method in class com.bonitasoft.processbuilder.extension.PasswordCrypto
-
Decrypts the given encrypted text using the master password from environment variable.
- decryptIfNeeded(String) - Static method in class com.bonitasoft.processbuilder.extension.PasswordCrypto
-
Decrypts the text only if it appears to be encrypted.
- decryptSensitiveFields(JsonNode) - Static method in class com.bonitasoft.processbuilder.execution.AuthPipeline
-
Decrypts sensitive fields in auth configuration using PasswordCrypto (AES/GCM).
- DEFAULT_CONNECT_TIMEOUT_MS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Default connection timeout in milliseconds (10 seconds).
- DEFAULT_JSON_HEADERS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Default headers for JSON requests.
- DEFAULT_READ_TIMEOUT_MS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Default read timeout in milliseconds (30 seconds).
- DEFAULT_REDIRECTION_NAME - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Default value returned when the redirection name cannot be determined.
- DEFAULT_TIMEOUT_MS - Static variable in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Default timeout in milliseconds (30 seconds).
- DEFAULT_USER_AGENT - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Default User-Agent value.
- DEFAULT_XML_HEADERS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Default headers for XML requests.
- DELAY - Enum constant in enum class com.bonitasoft.processbuilder.enums.FormContentType
-
Content type for delay-related form actions.
- delete() - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- DELETE - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionType
-
Represents the deletion of an existing business object.
- DELETE - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
HTTP DELETE method for removing resources.
- DELETE_BASE_SCHEMA - Static variable in class com.bonitasoft.processbuilder.constants.SchemaConstants
-
The name of the base schema used for DELETE operations.
- description() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Returns the value of the
descriptionrecord component. - description(String) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- DIGEST - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Digest Authentication.
- displayName() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
displayNamerecord component. - displayName() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Returns the value of the
displayNamerecord component. - displayName() - Method in record class com.bonitasoft.processbuilder.records.UserRecord
-
Returns the display name of the user.
- displayName(String) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- DIVIDER_COLOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The color used for dividers.
- DOCUMENTS_FOLDER - Enum constant in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Represents the classification key for **Documents Folder** definitions.
- docuSign(String, String, String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
DocuSign eSignature API.
- DOCUSIGN - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
DocuSign - Electronic signatures
- DRAFT - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
The process definition is currently being edited and is not available for execution.
- DYNAMICS_365 - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
Microsoft Dynamics 365 - ERP/CRM
- dynamics365(String, String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Microsoft Dynamics 365 Web API.
E
- email() - Method in record class com.bonitasoft.processbuilder.records.UserRecord
-
Returns the value of the
emailrecord component. - EmailRecipientsHelper - Class in com.bonitasoft.processbuilder.extension
-
Utility class for retrieving email addresses from Bonita Identity API.
- EMAILTEMPLATE - Enum constant in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
The HTML template for email body content.
- empty() - Static method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Creates an empty UsersConfigRecord with all null/empty values.
- EMPTY - Static variable in class com.bonitasoft.processbuilder.constants.Constants
-
Constant representing an empty string ("").
- ENABLED - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The enabled flag for action parameters.
- encrypt(String) - Static method in class com.bonitasoft.processbuilder.extension.PasswordCrypto
-
Encrypts the given text using the master password from environment variable.
- encryptIfNeeded(String) - Static method in class com.bonitasoft.processbuilder.extension.PasswordCrypto
-
Encrypts the text only if it does not appear to be already encrypted.
- ENDED - Enum constant in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
The step execution finished successfully, meaning all associated actions (connectors, notifications, redirections) have been successfully processed.
- ENTITY_TYPE - Enum constant in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Represents the **entity type** or classification identifier for a record.
- ENV_VAR_NAME - Static variable in class com.bonitasoft.processbuilder.extension.PasswordCrypto
-
Environment variable name for the master password.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BearerAuthConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.InvolvedUsersData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.LoadedSchema
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.ApiKeyAuth
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BasicAuth
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BearerAuth
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.CustomAuth
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.NoAuth
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.StepFieldRef
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.UserList
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.UserRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Indicates whether some other object is "equal to" this one.
- error(int, String, String, long, String) - Static method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
- error(String, long, String) - Static method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
- error(String, long, String) - Static method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Creates an error response.
- ERROR_COLOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The color indicating error states and negative feedback.
- errorMessage() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Returns the value of the
errorMessagerecord component. - errorMessage() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Returns the value of the
errorMessagerecord component. - evaluateAllConditions(JsonNode, BiFunction<String, String, String>) - Static method in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Evaluates all conditions in a JSON array, returning true only if ALL conditions are met.
- evaluateCondition(Object, String, Object) - Static method in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Evaluates a condition comparing two values using the specified operator.
- ExceptionUtils - Class in com.bonitasoft.processbuilder.extension
-
A utility class for handling logging and exception throwing.
- execute(ConnectorRequest) - Method in class com.bonitasoft.processbuilder.execution.ConnectorExecutionEngine
-
Executes a REST connector request.
- execute(RestServiceRequest) - Method in class com.bonitasoft.processbuilder.execution.HttpExecutor
-
Executes a REST service request.
- execute(String, String) - Method in class com.bonitasoft.processbuilder.extension.ExecuteSqlDatasource
-
Executes a SQL query with validated pagination parameters.
- ExecuteSqlDatasource - Class in com.bonitasoft.processbuilder.extension
-
Handles SQL datasource execution for REST API extensions.
- ExecuteSqlDatasource() - Constructor for class com.bonitasoft.processbuilder.extension.ExecuteSqlDatasource
- EXECUTION_CONNECTOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for Execution Connector.
- ExecutionConnectorType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid configuration attributes for the ExecutionConnector process.
- executionTimeMs() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Returns the value of the
executionTimeMsrecord component. - executionTimeMs() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Returns the value of the
executionTimeMsrecord component. - extractFieldFromJson(String, String, Logger) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Extracts a field value from a JSON string.
- extractFieldFromJson(String, String, Logger) - Static method in class com.bonitasoft.processbuilder.extension.TaskAssignationUtils
-
Extracts a field value from a JSON string.
- extractMembershipFromStepInput(String, Function<String, T>, Function<T, String>, Logger) - Static method in class com.bonitasoft.processbuilder.extension.TaskAssignationUtils
-
Extracts a membership ID from a step's JSON input field.
- extractMembershipRefs(JsonNode) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Extracts membership reference IDs from JSON parameters.
- extractMilliseconds(long) - Static method in class com.bonitasoft.processbuilder.extension.Utils
-
Extracts the milliseconds component (0-999) from an elapsed time.
- extractMinutes(long) - Static method in class com.bonitasoft.processbuilder.extension.Utils
-
Extracts the minutes component from an elapsed time in milliseconds.
- extractNullableTextField(JsonNode, String) - Static method in class com.bonitasoft.processbuilder.extension.InvolvedUsersParser
-
Helper method to extract a field that MUST BE PRESENT, but can have a null or empty value.
- extractRequiredTextField(JsonNode, String) - Static method in class com.bonitasoft.processbuilder.extension.InvolvedUsersParser
-
Helper method to extract a required text field from a JsonNode.
- extractSeconds(long) - Static method in class com.bonitasoft.processbuilder.extension.Utils
-
Extracts the seconds component (0-59) from an elapsed time in milliseconds.
- extractSpecificEmails(JsonNode) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Extracts specific email addresses from JSON parameters.
- extractUserIdFromFirstStep(List<T>, Function<T, Long>) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Extracts the user ID from the first element of a step results list.
- extractUserIdsFromMembershipResults(Collection<T>, Function<T, Long>) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Extracts user IDs from a collection of membership-based user list objects.
- extractUserIdsFromObjects(List<?>, String) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Extracts user IDs from a list of BDM user objects.
- extractUserIdsFromParameters(JsonNode) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Extracts user IDs from JSON parameters (RECIPIENTS_USER_IDS).
F
- FAILED - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
The instance failed due to a severe system or business error.
- FAILED - Enum constant in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
The step failed due to a system error (e.g., connector failure).
- FAVICON_URL - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The URL or base64-encoded data of the favicon.
- fieldMappingJson() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns the value of the
fieldMappingJsonrecord component. - fieldMappingJson(String) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- fieldRef() - Method in record class com.bonitasoft.processbuilder.records.StepFieldRef
-
Returns the value of the
fieldRefrecord component. - filterAssignableUsers(Set<Long>, Collection<Long>) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Filters assignable users based on candidate user IDs.
- filterValidEmails(Collection<String>) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Filters and validates a collection of email strings.
- findMostRecentInstance(Supplier<List<T>>, String, Logger) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Finds the most recent instance from a supplier result.
- findMostRecentStepInstance(Supplier<List<T>>, String) - Static method in class com.bonitasoft.processbuilder.extension.ProcessUtils
-
Finds the most recent step process instance using a search function.
- firstName() - Method in record class com.bonitasoft.processbuilder.records.UserRecord
-
Returns the value of the
firstNamerecord component. - FlowActionType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the specific action types available for configuration within a process step, such as defining a form, setting up notifications, or establishing redirections.
- followRedirects() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns the value of the
followRedirectsrecord component. - followRedirects(boolean) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- FONT_FAMILY - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The primary font family used for general text.
- FORM - Enum constant in enum class com.bonitasoft.processbuilder.enums.FlowActionType
-
Action related to defining the interface or data capture form for a step.
- FORM - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for Form configuration.
- FORM_URLENCODED - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Form URL encoded content type (application/x-www-form-urlencoded).
- formatElapsedTime(long) - Static method in class com.bonitasoft.processbuilder.extension.Utils
-
Formats elapsed time as a human-readable string with minutes, seconds, and milliseconds.
- FormContentType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid content types for the
formContentTypefield inPBFormActionContent. - FROM - Enum constant in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
The default sender email address for outgoing messages.
- fromException(Exception, long, String) - Static method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Creates an error response from an exception.
- fromJson(JsonNode) - Static method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
- fromJson(JsonNode) - Static method in record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
- fromJson(JsonNode) - Static method in record class com.bonitasoft.processbuilder.extension.template.auth.BearerAuthConfig
- fromJson(JsonNode) - Static method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
- fromJson(JsonNode) - Static method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
- fromJson(JsonNode, ObjectMapper) - Static method in interface com.bonitasoft.processbuilder.extension.template.auth.AuthConfig
-
Creates an AuthConfig from a JSON node.
- fromJson(JsonNode, Logger) - Static method in interface com.bonitasoft.processbuilder.records.RestAuthConfig
-
Parses authentication configuration from JSON.
- fromJson(JsonNode, Logger) - Static method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Parses a RestServiceRequest from JSON.
- fromKey(String) - Static method in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Retrieves a BDMObjectType enum constant by its technical key.
- fromKey(String) - Static method in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Finds a DataResolverType by its key.
- fromKey(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Finds a RecipientsType by its key value.
- fromKey(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestApiKeyLocation
-
Finds a location by its key (case-insensitive).
- fromKey(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Finds an authentication type by its key (case-insensitive).
- fromKey(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
Finds an HTTP method by its key (case-insensitive).
- fromKey(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestOAuth2ClientAuthMethod
-
Finds a method by its key (case-insensitive).
- fromMimeType(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Finds a content type by its MIME type (case-insensitive).
- fromString(String) - Static method in enum class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig.Location
- fromString(String) - Static method in enum class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.ClientAuthMethod
- fromUsersNode(JsonNode, Logger) - Static method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Parses a "users" JsonNode and creates a UsersConfigRecord.
- fullName() - Method in record class com.bonitasoft.processbuilder.records.UserRecord
-
Returns the value of the
fullNamerecord component.
G
- generateTaskLink(String, Long) - Static method in class com.bonitasoft.processbuilder.extension.TemplateDataResolver
-
Generates a task link HTML anchor tag.
- generateTaskUrl(String, Long) - Static method in class com.bonitasoft.processbuilder.extension.TemplateDataResolver
-
Generates a plain task URL (without HTML anchor).
- GENERIC - Enum constant in enum class com.bonitasoft.processbuilder.enums.ConfigurationType
-
Represents the classification key for **Generic Configuration** definitions.
- GENERIC_ENTRY - Enum constant in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Represents a **generic entry** or record, typically originating from a master data table.
- GenericEntryType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid types used to classify generic configuration entries (master data or lookup records) within the system.
- GenericType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid generic configuration types for system-wide settings.
- get() - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- get(String) - Static method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Creates a simple GET request.
- GET - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
HTTP GET method for retrieving resources.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
Retrieves all action parameters as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.ActionType
-
Retrieves all process instance states as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Retrieves all BDM object types as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.ConfigurationType
-
Retrieves all configuration types as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.CriticalityType
-
Retrieves all process instance states as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Retrieves all resolver types as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.ExecutionConnectorType
-
Retrieves all ExecutionConnector configuration attributes as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.FlowActionType
-
Retrieves all process instance states as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.FormContentType
-
Retrieves all form content types as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Retrieves all process instance states as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.GenericType
-
Retrieves all generic types as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Retrieves all process instance states as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
Retrieves all process instance states as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Retrieves all process instance states as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Retrieves all process instance states as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
Retrieves all process states as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessStorageType
-
Retrieves all process instance states as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Retrieves all recipient types as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.RestApiKeyLocation
-
Retrieves all locations as a read-only Map.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Retrieves all authentication types as a read-only Map.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Retrieves all content types as a read-only Map.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
Retrieves all HTTP methods as a read-only Map.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.RestOAuth2ClientAuthMethod
-
Retrieves all methods as a read-only Map.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
Retrieves all SMTP configuration attributes as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
Retrieves all step instance states as a read-only Map where the key is the technical key and the value is the description.
- getAllData() - Static method in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
Retrieves all theme configuration attributes as a read-only Map where the key is the technical key and the value is the description.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.ActionType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.ConfigurationType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.CriticalityType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.ExecutionConnectorType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.FlowActionType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.FormContentType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.GenericType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessStorageType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.RestApiKeyLocation
-
Retrieves all keys as a read-only List.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Retrieves all technical keys as a read-only List.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Retrieves all MIME types as a read-only List.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
Retrieves all method keys as a read-only List.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.RestOAuth2ClientAuthMethod
-
Retrieves all keys as a read-only List.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllKeysList() - Static method in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
Retrieves all technical keys as a read-only List of Strings.
- getAllTemplateDefinitions() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Returns all template definitions as a list.
- getAllTemplateNames() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Returns all available template type names.
- getAllTemplatesInfo() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Returns all template types as a map of displayName to description.
- getAuthHeaders() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.ApiKeyAuth
- getAuthHeaders() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BasicAuth
- getAuthHeaders() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BearerAuth
- getAuthHeaders() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.CustomAuth
- getAuthHeaders() - Method in interface com.bonitasoft.processbuilder.records.RestAuthConfig
-
Generates the HTTP headers required for this authentication.
- getAuthHeaders() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.NoAuth
- getAuthHeaders() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
- getAuthHeaders() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
- getAuthQueryParams() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.ApiKeyAuth
- getAuthQueryParams() - Method in interface com.bonitasoft.processbuilder.records.RestAuthConfig
-
Gets any query parameters required for this authentication.
- getAuthType() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
- getAuthType() - Method in interface com.bonitasoft.processbuilder.extension.template.auth.AuthConfig
-
Gets the authentication type identifier.
- getAuthType() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
- getAuthType() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BearerAuthConfig
- getAuthType() - Method in class com.bonitasoft.processbuilder.extension.template.auth.NoAuthConfig
- getAuthType() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
- getAuthType() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
- getAuthType() - Method in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
- getAuthType() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.ApiKeyAuth
- getAuthType() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BasicAuth
- getAuthType() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BearerAuth
- getAuthType() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.CustomAuth
- getAuthType() - Method in interface com.bonitasoft.processbuilder.records.RestAuthConfig
-
Gets the authentication type for this configuration.
- getAuthType() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.NoAuth
- getAuthType() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
- getAuthType() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
- getBoolean(JsonNode, String, boolean) - Static method in interface com.bonitasoft.processbuilder.extension.template.auth.AuthConfig
-
Helper method to get a boolean value from a JSON node with a default.
- getByCaseId(String) - Method in class com.bonitasoft.processbuilder.extension.ProcessInstance
-
Validates and retrieves a process instance by case ID.
- getById(String) - Method in class com.bonitasoft.processbuilder.extension.ProcessInstance
-
Validates and retrieves a process instance by ID.
- getCompressionRatio(String, String) - Static method in class com.bonitasoft.processbuilder.utils.CompressionUtils
-
Calculates the compression ratio as a percentage.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
Returns the description of this action parameter.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.ActionType
-
Returns the business description of this criticality type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Returns the business description of this BDM object type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.ConfigurationType
-
Gets a brief business description of the action type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.CriticalityType
-
Returns the business description of this criticality type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Returns the description of this resolver type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.ExecutionConnectorType
-
Returns the description of this configuration attribute.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.FlowActionType
-
Gets a brief business description of the action type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.FormContentType
-
Returns the description of this content type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Gets a brief business description of the action type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.GenericType
-
Returns the description of this generic type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Gets a brief business description of the action type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
Gets the human-readable description of the state.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Gets a brief description of the process purpose.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Gets a brief business description of the action type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
Gets the human-readable description of the state.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.ProcessStorageType
-
Returns the business description of this storage type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Returns the description of this recipient type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.RestApiKeyLocation
-
Gets the description.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Gets a brief description of the authentication type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Gets a brief description of the content type.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
Gets a brief description of the HTTP method.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.RestOAuth2ClientAuthMethod
-
Gets the description.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
Returns the description of this SMTP configuration attribute.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
Gets the human-readable description of the state.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
Returns the description of this theme configuration attribute.
- getDescription() - Method in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
- getDisplayName() - Method in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
- getEmailByUserId(IdentityAPI, Long) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Retrieves email for a single user ID.
- getEmailsByUserIds(IdentityAPI, Collection<Long>) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Retrieves emails for multiple user IDs in batch.
- getFilteredAssignableUsers(Long, boolean, List<?>, Collection<Long>, IdentityAPI) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Convenience method that combines building candidate users and filtering in one call.
- getFreeTemplates() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Returns all template types that are free (no credentials needed).
- getHeader(String) - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Gets a specific header value (case-insensitive).
- getJsonField(String) - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Gets a specific field from the JSON body.
- getJsonNode(JsonNode, String, Logger) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Extracts a child node from a parent JsonNode.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
Returns the unique string key associated with this action parameter.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.ActionType
-
Returns the unique string key associated with this criticality type.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Returns the unique string key associated with this BDM object type.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.ConfigurationType
-
Gets the technical key of the flow action type, typically used for internal logic and data mapping.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.CriticalityType
-
Returns the unique string key associated with this criticality type.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Returns the unique string key associated with this resolver type.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.ExecutionConnectorType
-
Returns the unique string key associated with this attribute.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.FlowActionType
-
Gets the technical key of the flow action type, typically used for internal logic and data mapping.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.FormContentType
-
Returns the unique string key associated with this content type.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Gets the technical key of the flow action type, typically used for internal logic and data mapping.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.GenericType
-
Returns the unique string key associated with this generic type.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Gets the technical key of the flow action type, typically used for internal logic and data mapping.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
Gets the technical key of the state.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Gets the human-readable, capitalized key of the process.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Gets the technical key of the flow action type, typically used for internal logic and data mapping.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
Gets the technical key of the state.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.ProcessStorageType
-
Returns the unique string key associated with this storage type.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Returns the unique string key associated with this recipient type.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.RestApiKeyLocation
-
Gets the technical key.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Gets the technical key of the authentication type.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Alias for getMimeType() to maintain consistency with other enums.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
Gets the HTTP method name.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.RestOAuth2ClientAuthMethod
-
Gets the technical key.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
Returns the unique string key associated with this SMTP attribute.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
Gets the technical key of the state.
- getKey() - Method in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
Returns the unique string key associated with this theme attribute.
- getLocation() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Gets the Location header (for redirects).
- getManagerEmailByUserId(IdentityAPI, Long) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Retrieves manager's email for a given user ID.
- getMembersShipsInputOptional() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Gets the membersShipsInput as an Optional.
- getMimeType() - Method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Gets the MIME type string.
- getNodeArrayAsStringList(JsonNode, Logger) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Extracts a list of strings from a JsonNode array.
- getNodeText(JsonNode, Logger) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Extracts a non-empty text value from a JsonNode.
- getProcessInitiator(APIAccessor, long) - Static method in class com.bonitasoft.processbuilder.extension.ProcessUtils
-
Retrieves the user who started a specific process instance.
- getRedirectionName(JsonNode) - Static method in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Retrieves the redirection name from a JSON node, supporting both old and new data structures.
- getRefStepsArray() - Method in record class com.bonitasoft.processbuilder.records.InvolvedUsersData
-
Constructs an array containing the step references (stepManagerRef and stepUserRef) after filtering out any null or empty strings
- getStepIdParameterKey() - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Gets the step ID parameter key.
- getStepManagerOptional() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Gets the stepManager as an Optional.
- getStepUserOptional() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Gets the stepUser as an Optional.
- getTargetStep(JsonNode) - Static method in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Retrieves the target step from a JSON node, supporting both old and new data structures.
- getTaskExecutor(APIAccessor, long) - Static method in class com.bonitasoft.processbuilder.extension.ProcessUtils
-
Retrieves the user who executed a specific human task instance.
- getTemplateCount() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Returns the total count of available templates.
- getTemplatesByAuthType(RestApiCatalog.AuthType) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Returns all template types filtered by authentication type.
- getTemplatesRequiringCredentials() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Returns all template types that require user credentials.
- getText(JsonNode, String, String) - Static method in interface com.bonitasoft.processbuilder.extension.template.auth.AuthConfig
-
Helper method to get a text value from a JSON node with a default.
- getTextValueByPath(JsonNode, String) - Static method in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Retrieves the text value at the specified path from a
JsonNode. - getTextValueByPath(String, String) - Static method in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Retrieves the text value at the specified path from a JSON string.
- getTokenRequestBody() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Gets the body parameters for the token request.
- getTokenRequestBody() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
-
Gets the body parameters for the token request.
- getTokenRequestHeaders() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Gets the headers for the token request (not the API request).
- getUser(Long, IdentityAPI) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Retrieves a Bonita User object by its ID.
- getUserEmail(IdentityAPI, Long) - Static method in class com.bonitasoft.processbuilder.extension.TemplateDataResolver
-
Gets the email of a user.
- getUserFirstName(IdentityAPI, Long) - Static method in class com.bonitasoft.processbuilder.extension.TemplateDataResolver
-
Gets the first name of a user.
- getUserFullName(IdentityAPI, Long) - Static method in class com.bonitasoft.processbuilder.extension.TemplateDataResolver
-
Gets the full name (first + last) of a user.
- getUserIdFromObject(Object, String) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Extracts a user ID from a BDM object using reflection.
- getUserIdsInProfile(APIAccessor, String) - Method in class com.bonitasoft.processbuilder.extension.ProcessUtils
-
Retrieves the list of user IDs associated with a specific profile.
- getUserIdsInProfile(APIAccessor, String) - Static method in class com.bonitasoft.processbuilder.extension.ProfileUtis
-
Retrieves all unique user IDs associated with a given profile name.
- getUserLastName(IdentityAPI, Long) - Static method in class com.bonitasoft.processbuilder.extension.TemplateDataResolver
-
Gets the last name of a user.
- getUserManager(Long, IdentityAPI) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Gets the manager ID of a given user.
- getUserRecord(Long, IdentityAPI) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Retrieves a UserRecord by user ID.
- getUsersByMemberships(Supplier<List<T>>, Function<T, Long>, Function<T, Long>, IdentityAPI, Logger) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Gets user IDs from memberships using a supplier for data access.
- getUsersByMemberships(List<?>, IdentityAPI) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Gets all users matching the given memberships (groups/roles).
- getUsersForMembership(Long, Long, IdentityAPI, Logger) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Gets user IDs for a specific group/role combination.
- getValidatorSchema(String, String, String) - Static method in class com.bonitasoft.processbuilder.validation.SchemaResolver
-
Loads the OpenAPI document from a resource, resolves dependencies, and prepares the
JsonSchemavalidator for a specific target schema. - getValue() - Method in enum class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig.Location
- getValue() - Method in enum class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.ClientAuthMethod
- getValue() - Method in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.AuthType
- getValueByPath(JsonNode, String) - Static method in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Safely retrieves the value of a field from a JSON structure using a dot-separated path.
- getValueByPath(String, String) - Static method in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Safely retrieves the value of a field from a JSON string using a dot-separated path.
- gitHub(String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
GitHub API - Requires Personal Access Token.
- GITHUB - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
GitHub - GitHub REST API
- groupId() - Method in record class com.bonitasoft.processbuilder.records.UserList
-
Returns the value of the
groupIdrecord component.
H
- hasAnySource() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Checks if this configuration has any user source defined.
- hasBody() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Checks if this request has a body.
- hashCode() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BearerAuthConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.InvolvedUsersData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.LoadedSchema
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.ApiKeyAuth
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BasicAuth
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BearerAuth
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.CustomAuth
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.NoAuth
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.StepFieldRef
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.UserList
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.UserRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Returns a hash code value for this object.
- hasJsonBody() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Checks if the response body contains JSON content.
- hasMemberShips() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Checks if this configuration has any static memberships.
- hasMembersShipsInput() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Checks if this configuration has a dynamic membership input reference.
- hasStepManager() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Checks if this configuration has any step manager reference.
- hasStepUser() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Checks if this configuration has any step user reference.
- HEAD - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
HTTP HEAD method for retrieving headers only.
- header(String, String) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- header(String, String) - Static method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
- header(String, String) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- header(String, String) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- HEADER - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestApiKeyLocation
-
API key is sent as an HTTP header.
- HEADER - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestOAuth2ClientAuthMethod
-
Client credentials sent as HTTP Basic Auth header.
- HEADER - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig.Location
- HEADER - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.ClientAuthMethod
- HEADER_ACCEPT - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Accept header name.
- HEADER_AUTHORIZATION - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Authorization header name.
- HEADER_CONTENT_TYPE - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Content-Type header name.
- HEADER_CORRELATION_ID - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
X-Correlation-ID header name for distributed tracing.
- HEADER_REQUEST_ID - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
X-Request-ID header name for request tracing.
- HEADER_USER_AGENT - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
User-Agent header name.
- headers() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns the value of the
headersrecord component. - headers() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
headersrecord component. - headers() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Returns the value of the
headersrecord component. - headers() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.CustomAuth
-
Returns the value of the
headersrecord component. - headers() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns the value of the
headersrecord component. - headers() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Returns the value of the
headersrecord component. - headers(Map<String, String>) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- headers(Map<String, String>) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- headers(Map<String, String>) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- HEADING_FONT_FAMILY - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The font family used for headings.
- HEALTHY - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
The optional indicator state: the process definition is fully operational and healthy.
- HIGH - Enum constant in enum class com.bonitasoft.processbuilder.enums.CriticalityType
-
Indicates severe business impact, requiring immediate attention and maximum uptime assurance.
- HOST - Enum constant in enum class com.bonitasoft.processbuilder.enums.GenericType
-
Host URL configuration for the application.
- HOURS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The number of hours parameter for delay or scheduling actions.
- HTTP_BAD_GATEWAY - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
HTTP 502 Bad Gateway.
- HTTP_BAD_REQUEST - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
HTTP 400 Bad Request.
- HTTP_BIN_BASIC_AUTH - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
HTTPBin - Basic Auth test service
- HTTP_CREATED - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
HTTP 201 Created.
- HTTP_FORBIDDEN - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
HTTP 403 Forbidden.
- HTTP_INTERNAL_ERROR - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
HTTP 500 Internal Server Error.
- HTTP_NO_CONTENT - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
HTTP 204 No Content.
- HTTP_NOT_FOUND - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
HTTP 404 Not Found.
- HTTP_OK - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
HTTP 200 OK.
- HTTP_SERVICE_UNAVAILABLE - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
HTTP 503 Service Unavailable.
- HTTP_UNAUTHORIZED - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
HTTP 401 Unauthorized.
- httpBinBasicAuth() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
HTTPBin Basic Auth test service.
- HttpExecutor - Class in com.bonitasoft.processbuilder.execution
-
HTTP execution engine with connection pooling, OAuth2 token caching, and Bonita session management.
- HttpExecutor() - Constructor for class com.bonitasoft.processbuilder.execution.HttpExecutor
- httpMethod() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Returns the value of the
httpMethodrecord component. - hubSpot(String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
HubSpot CRM API.
- HUBSPOT - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
HubSpot - CRM and Marketing Platform
I
- id() - Method in record class com.bonitasoft.processbuilder.records.UserRecord
-
Returns the value of the
idrecord component. - IdentityUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility class for common operations with Bonita Identity API.
- IN_ERROR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
The optional indicator state: the process definition has known operational issues (e.g., failed instances).
- INPUTS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Represents the initial data inputs required to start a process instance.
- InputValidationUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility class for common input parameter validation checks (e.g., positive numbers, non-null values) typically used within Bonita connectors.
- INSERT - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionType
-
Represents the creation of a new business object.
- INSTANCE - Static variable in class com.bonitasoft.processbuilder.extension.template.auth.NoAuthConfig
- InvolvedUsersData - Record Class in com.bonitasoft.processbuilder.records
-
A record to hold the parsed configuration data for finding candidate users (actors) involved in a process step.
- InvolvedUsersData(String, String, List<String>) - Constructor for record class com.bonitasoft.processbuilder.records.InvolvedUsersData
-
The compact constructor for this record.
- InvolvedUsersParser - Class in com.bonitasoft.processbuilder.extension
-
Utility class responsible for parsing JSON configuration related to involved users, actors, and assignment logic within a Bonita process extension.
- InvolvedUsersParser() - Constructor for class com.bonitasoft.processbuilder.extension.InvolvedUsersParser
- isBonitaStorage(String) - Static method in class com.bonitasoft.processbuilder.extension.StorageUtils
-
Checks if the process documents are configured for storage in the Bonita BDM database.
- isClientError() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Checks if the response indicates a client error (4xx status code).
- isEncrypted(String) - Static method in class com.bonitasoft.processbuilder.extension.PasswordCrypto
-
Checks if the given text appears to be encrypted.
- isError() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Checks if there was an error (network error or non-success HTTP status).
- isJson() - Method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Checks if this content type is JSON.
- isJsonValid(LoadedSchema) - Static method in class com.bonitasoft.processbuilder.validation.SchemaResolver
-
Performs JSON validation against the loaded schema, logging the outcome and detailed errors.
- isJsonValidForType(String, String, Object) - Static method in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Validates a JSON input against the specific schema associated with the provided object management type.
- isJsonValidForType(String, String, Object) - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Validates a JSON input against the specific schema associated with the provided ProcessOptionType.
- isJsonValidForType(String, String, Object) - Static method in class com.bonitasoft.processbuilder.validation.JsonSchemaValidator
-
Validates an input object against the schema corresponding to the given option type name.
- isLocalStorage(String) - Static method in class com.bonitasoft.processbuilder.extension.StorageUtils
-
Checks if the process documents are configured for storage on the local application server.
- isMasterPasswordConfigured() - Static method in class com.bonitasoft.processbuilder.extension.PasswordCrypto
-
Checks if the master password environment variable is configured.
- isMatchingActionAndOption(String, String, ActionType, ObjectsManagementOptionType) - Static method in class com.bonitasoft.processbuilder.validation.ProcessOptionValidator
-
Checks if the actual action and option type strings match the provided expected
ActionTypeandObjectsManagementOptionTypeenum constants. - isMatchingActionAndOption(String, String, ActionType, ProcessOptionType) - Static method in class com.bonitasoft.processbuilder.validation.ProcessOptionValidator
-
Checks if the actual action and option type strings match the provided expected
ActionTypeandProcessOptionTypeenum constants. - isRedirect() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Checks if the response was a redirect (3xx status code).
- isServerError() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Checks if the response indicates a server error (5xx status code).
- isSuccessful() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Checks if the response indicates success (2xx status code).
- isTemplate() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
isTemplaterecord component. - isTextBased() - Method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Checks if this content type is text-based (can be logged as string).
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Method in enum class com.bonitasoft.processbuilder.enums.ActionType
-
Validates a persistence ID string against the requirements of the specific action type.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ConfigurationType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.CriticalityType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ExecutionConnectorType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.FlowActionType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.FormContentType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.GenericType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessStorageType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestApiKeyLocation
-
Checks if a given string corresponds to a valid location.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Checks if a given string corresponds to a valid enum constant.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Checks if a given MIME type corresponds to a valid content type.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
Checks if a given string corresponds to a valid HTTP method.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestOAuth2ClientAuthMethod
-
Checks if a given string corresponds to a valid method.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValid(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
- isValidEmail(String) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Validates if an email string is valid (non-null and non-blank).
- isValidKey(String) - Static method in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Checks if a given key corresponds to a valid resolver type.
- isValidUserId(Long) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Validates if a userId is valid (non-null and positive).
- isXml() - Method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Checks if this content type is XML.
J
- jira(String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Jira REST API - Atlassian issue tracking.
- JIRA - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
Jira - Atlassian Jira issue tracking
- joinEmails(Collection<String>) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Joins email addresses into a comma-separated string.
- JSON - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
JSON content type (application/json).
- JSON_AUDIENCE - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for OAuth2 audience.
- JSON_AUTH - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for authentication configuration.
- JSON_AUTH_TYPE - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for authentication type.
- JSON_BODY - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for request/response body.
- JSON_CLIENT_ID - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for OAuth2 client ID.
- JSON_CLIENT_SECRET - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for OAuth2 client secret.
- JSON_CONTENT_TYPE - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for content type.
- JSON_ERROR_MESSAGE - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for error message.
- JSON_EXECUTION_TIME_MS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for execution time.
- JSON_FOLLOW_REDIRECTS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for follow redirects flag.
- JSON_HEADERS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for headers.
- JSON_KEY_NAME - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for API key name.
- JSON_KEY_VALUE - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for API key value.
- JSON_LOCATION - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for API key location.
- JSON_METHOD - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for HTTP method.
- JSON_PASSWORD - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for password.
- JSON_PLACEHOLDER - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
JSONPlaceholder - Free fake REST API for testing
- JSON_QUERY_PARAMS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for query parameters.
- JSON_SCOPE - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for OAuth2 scope.
- JSON_STATUS_CODE - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for status code.
- JSON_TIMEOUT_MS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for timeout.
- JSON_TOKEN - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for token.
- JSON_TOKEN_URL - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for OAuth2 token URL.
- JSON_URL - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for URL.
- JSON_USERNAME - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for username.
- JSON_VERIFY_SSL - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
JSON field name for verify SSL flag.
- jsonBody(Object) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- jsonInput() - Method in record class com.bonitasoft.processbuilder.records.LoadedSchema
-
Returns the value of the
jsonInputrecord component. - JsonNodeUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility class for working with Jackson
JsonNodeobjects and evaluating conditions. - jsonPlaceholder() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
JSONPlaceholder - Free fake REST API for testing.
- JsonSchemaValidator - Class in com.bonitasoft.processbuilder.validation
-
Utility class serving as the entry point for JSON Schema validation.
- JsonValidationUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility class for generic JSON structure validation checks, decoupled from the main parsing logic.
K
- keyName() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
-
Returns the value of the
keyNamerecord component. - keyName() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.ApiKeyAuth
-
Returns the value of the
keyNamerecord component. - keyValue() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
-
Returns the value of the
keyValuerecord component. - keyValue() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.ApiKeyAuth
-
Returns the value of the
keyValuerecord component.
L
- LANG - Enum constant in enum class com.bonitasoft.processbuilder.enums.GenericType
-
Language configuration for the application.
- lastName() - Method in record class com.bonitasoft.processbuilder.records.UserRecord
-
Returns the value of the
lastNamerecord component. - LoadedSchema - Record Class in com.bonitasoft.processbuilder.records
-
Record representing a fully loaded and prepared JSON Schema used for validation.
- LoadedSchema(JsonSchema, Map<String, String>, String, String) - Constructor for record class com.bonitasoft.processbuilder.records.LoadedSchema
-
Compact Canonical Constructor.
- LOCAL - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessStorageType
-
Files are stored on the local application server where the process engine is deployed and are retained indefinitely.
- LOCAL_AND_DELETE - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessStorageType
-
Files are stored on the local application server and are deleted upon process completion.
- location() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
-
Returns the value of the
locationrecord component. - location() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.ApiKeyAuth
-
Returns the value of the
locationrecord component. - logAndGetElapsedTime(long, String) - Static method in class com.bonitasoft.processbuilder.extension.Utils
-
Calculates and logs the elapsed time from a given start point up to the current moment.
- logAndThrow(Supplier<T>, String, Object...) - Static method in class com.bonitasoft.processbuilder.extension.ExceptionUtils
-
Logs a formatted error message and then throws a new instance of a specified exception.
- logAndThrowWithClass(Class<T>, String, Object...) - Static method in class com.bonitasoft.processbuilder.extension.ExceptionUtils
-
Logs an error message and then securely throws a new instance of the specified exception class.
- logAndThrowWithMessage(Function<String, T>, String, Object...) - Static method in class com.bonitasoft.processbuilder.extension.ExceptionUtils
-
Utility method to safely log an error message and subsequently throw a new exception instance containing that same formatted message.
- logElapsedTime(long, String) - Static method in class com.bonitasoft.processbuilder.extension.Utils
-
Calculates and logs the elapsed time from a given start point up to the moment of the call.
- logElapsedTimeByElapsedTime(long, String) - Static method in class com.bonitasoft.processbuilder.extension.Utils
-
Logs the given elapsed time, formatted as minutes, seconds, and milliseconds.
- LOGO_URL - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The URL or base64-encoded data of the application logo.
- lookupConfigurationValue(String, String, Supplier<String>, String, boolean) - Static method in class com.bonitasoft.processbuilder.extension.ConfigurationUtils
-
Looks up a configuration value using a provided supplier, with support for sensitive data masking.
- lookupConfigurationValue(String, Supplier<String>, String, boolean) - Static method in class com.bonitasoft.processbuilder.extension.ConfigurationUtils
-
Looks up a configuration value without entity type context.
- LOW - Enum constant in enum class com.bonitasoft.processbuilder.enums.CriticalityType
-
Indicates minimal business impact, usually involving non-urgent or supportive functions.
M
- mappedData() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Returns the value of the
mappedDatarecord component. - MASKED_VALUE - Static variable in class com.bonitasoft.processbuilder.extension.ConfigurationUtils
-
Mask used to hide sensitive values in log output.
- maskIfSensitive(String, boolean) - Static method in class com.bonitasoft.processbuilder.extension.ConfigurationUtils
-
Masks a value if it is marked as sensitive.
- MASTER_PROCESS_EXECUTION_ORCHESTRATOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for the master execution orchestrator.
- MASTER_PROCESS_LIFECYCLE_MANAGER - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for the lifecycle manager that periodically restarts the master orchestrator.
- MAX_RETRIES - Enum constant in enum class com.bonitasoft.processbuilder.enums.ExecutionConnectorType
-
The maximum number of retry attempts allowed for the connector execution.
- MAX_TIMEOUT_MS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Maximum timeout allowed in milliseconds (5 minutes).
- MEMBERSHIP - Enum constant in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Recipients determined by organizational membership (group, role, or membership).
- memberShipKey() - Method in record class com.bonitasoft.processbuilder.records.UserList
-
Returns the value of the
memberShipKeyrecord component. - memberships() - Method in record class com.bonitasoft.processbuilder.records.InvolvedUsersData
-
Returns a read-only view (unmodifiable list) of the membership references to prevent external modification of the record's internal state.
- memberShips() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Returns the value of the
memberShipsrecord component. - MEMBERSHIPS_INPUT_KEY - Static variable in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
JSON key for membersShipsInput.
- MEMBERSHIPS_KEY - Static variable in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
JSON key for memberShips.
- MembershipUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility class for constructing composite keys representing a specific Group and Role membership combination.
- MembershipUtils() - Constructor for class com.bonitasoft.processbuilder.extension.MembershipUtils
- membersShipsInput() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Returns the value of the
membersShipsInputrecord component. - MESSAGE - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The message body content for notification actions.
- MESSAGE - Enum constant in enum class com.bonitasoft.processbuilder.enums.FormContentType
-
Content type for message-related form actions.
- method() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns the value of the
methodrecord component. - method(RestHttpMethod) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- Method(String, String, String) - Constructor for record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
- Method(String, String, String, String, String, Map<String, String>, Map<String, String>, String) - Constructor for record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Creates an instance of a
Methodrecord class. - methodName() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns the value of the
methodNamerecord component. - methodName(String) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- methodOverride() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns the value of the
methodOverriderecord component. - methodOverride(String) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- methods() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
methodsrecord component. - MIN_TIMEOUT_MS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
Minimum timeout allowed in milliseconds (1 second).
- MODERATE - Enum constant in enum class com.bonitasoft.processbuilder.enums.CriticalityType
-
Indicates significant business impact, requiring standard attention and prompt resolution.
- MULTIPART_FORM_DATA - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Multipart form data content type (multipart/form-data).
N
- name() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Returns the value of the
namerecord component. - name() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
namerecord component. - name(String) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- NAME - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The name identifier for the action parameter.
- NASA_APOD - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
NASA APOD - Astronomy Picture of the Day
- nasaApod(String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
NASA APOD API - Astronomy Picture of the Day.
- NEUTRAL_COLOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The color indicating neutral or inactive states.
- noAuth(String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Creates a generic template with NO authentication.
- NoAuth() - Constructor for record class com.bonitasoft.processbuilder.records.RestAuthConfig.NoAuth
-
Creates an instance of a
NoAuthrecord class. - NoAuthConfig - Class in com.bonitasoft.processbuilder.extension.template.auth
-
Configuration for APIs that require no authentication.
- none() - Static method in interface com.bonitasoft.processbuilder.records.RestAuthConfig
-
Creates an empty/no authentication configuration.
- NONE - Enum constant in enum class com.bonitasoft.processbuilder.enums.CriticalityType
-
Indicates a purely informational or non-critical process with no business impact on failure.
- NONE - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
No authentication required.
- NONE - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.AuthType
- normalizeAuthConfig(JsonNode) - Static method in class com.bonitasoft.processbuilder.execution.AuthPipeline
-
Normalizes auth configuration JSON for backward compatibility.
- normalizeTitleCase(String) - Static method in class com.bonitasoft.processbuilder.extension.PBStringUtils
-
Normalizes the input String to Title Case format: the first letter is capitalized, and all subsequent letters are lowercased.
- NOTIFICATIONS - Enum constant in enum class com.bonitasoft.processbuilder.enums.FlowActionType
-
Action related to setting up alerts, emails, or system notifications.
- NOTIFICATIONS - Enum constant in enum class com.bonitasoft.processbuilder.enums.FormContentType
-
Content type for notification-related form actions.
- NOTIFICATIONS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for Notifications configuration.
- notion(String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Notion API - Workspace platform.
- NOTION - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
Notion - Workspace and documentation platform
- NTLM - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
NTLM Authentication for Windows-based services.
O
- OAUTH2_ACCESS_TOKEN - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
OAuth2 access token field name in response.
- OAUTH2_CLIENT - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.AuthType
- OAUTH2_CLIENT_CREDENTIALS - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
OAuth 2.0 Client Credentials grant type.
- OAUTH2_EXPIRES_IN - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
OAuth2 expires in field name in response (seconds).
- OAUTH2_GRANT_CLIENT_CREDENTIALS - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
OAuth2 grant type for client credentials.
- OAUTH2_GRANT_PASSWORD - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
OAuth2 grant type for password.
- OAUTH2_GRANT_REFRESH_TOKEN - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
OAuth2 grant type for refresh token.
- OAUTH2_PASSWORD - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
OAuth 2.0 Resource Owner Password grant type.
- OAUTH2_PASSWORD - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.AuthType
- OAUTH2_REFRESH_TOKEN - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
OAuth2 refresh token field name in response.
- OAUTH2_SCOPE - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
OAuth2 scope field name in response.
- OAUTH2_TOKEN_TYPE - Static variable in class com.bonitasoft.processbuilder.extension.RestServiceConstants
-
OAuth2 token type field name in response.
- OAuth2ClientConfig - Record Class in com.bonitasoft.processbuilder.extension.template.auth
-
Configuration for OAuth2 Client Credentials flow.
- OAuth2ClientConfig(String, String, String) - Constructor for record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
- OAuth2ClientConfig(String, String, String, String) - Constructor for record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
- OAuth2ClientConfig(String, String, String, String, String, OAuth2ClientConfig.ClientAuthMethod) - Constructor for record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
-
Creates an instance of a
OAuth2ClientConfigrecord class. - OAuth2ClientConfig.Builder - Class in com.bonitasoft.processbuilder.extension.template.auth
- OAuth2ClientConfig.ClientAuthMethod - Enum Class in com.bonitasoft.processbuilder.extension.template.auth
- oauth2ClientCredentials(String, String, String) - Static method in interface com.bonitasoft.processbuilder.records.RestAuthConfig
-
Creates an OAuth2 Client Credentials configuration.
- oauth2ClientCredentials(String, String, String, String, String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Creates a generic template with OAuth2 Client Credentials.
- OAuth2ClientCredentials(String, String, String, String, String, RestOAuth2ClientAuthMethod) - Constructor for record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Creates an instance of a
OAuth2ClientCredentialsrecord class. - oauth2Password(String, String, String, String, String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Creates a generic template with OAuth2 Password Grant.
- OAuth2Password(String, String, String, String, String, String) - Constructor for record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
-
Creates an instance of a
OAuth2Passwordrecord class. - OAuth2PasswordConfig - Record Class in com.bonitasoft.processbuilder.extension.template.auth
-
Configuration for OAuth2 Resource Owner Password Credentials flow.
- OAuth2PasswordConfig(String, String, String, String) - Constructor for record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
- OAuth2PasswordConfig(String, String, String, String, String, String) - Constructor for record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
-
Creates an instance of a
OAuth2PasswordConfigrecord class. - OAuth2PasswordConfig.Builder - Class in com.bonitasoft.processbuilder.extension.template.auth
- OBJECT - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The object parameter for action configuration.
- OBJECTS_MANAGEMENT - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for Objects Management.
- OBJECTS_MANAGEMENT_LIST - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for Objects Management List operations.
- ObjectsManagementOptionType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid option types for the object management process.
- of(String) - Static method in record class com.bonitasoft.processbuilder.extension.template.auth.BearerAuthConfig
- OP_CONTAINS - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for contains comparison.
- OP_EQUALS - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for equals comparison.
- OP_EQUALS_SYMBOL - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for equals comparison (symbol form).
- OP_GREATER_OR_EQUAL - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for greater or equal comparison.
- OP_GREATER_OR_EQUAL_SYMBOL - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for greater or equal comparison (symbol form).
- OP_GREATER_THAN - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for greater than comparison.
- OP_GREATER_THAN_SYMBOL - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for greater than comparison (symbol form).
- OP_IS_EMPTY - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for is empty check.
- OP_IS_NOT_EMPTY - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for is not empty check.
- OP_LESS_OR_EQUAL - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for less or equal comparison.
- OP_LESS_OR_EQUAL_SYMBOL - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for less or equal comparison (symbol form).
- OP_LESS_THAN - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for less than comparison.
- OP_LESS_THAN_SYMBOL - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for less than comparison (symbol form).
- OP_NOT_CONTAINS - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for not contains comparison.
- OP_NOT_EQUALS - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for not equals comparison.
- OP_NOT_EQUALS_SYMBOL - Static variable in class com.bonitasoft.processbuilder.extension.JsonNodeUtils
-
Operator constant for not equals comparison (symbol form).
- OPEN_WEATHER_MAP - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
OpenWeatherMap - Weather data API
- OPENAPI_RESOURCE_PATH - Static variable in class com.bonitasoft.processbuilder.constants.SchemaConstants
-
The path to the main resource file containing all OpenAPI/JSON Schema definitions.
- openWeatherMap(String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
OpenWeatherMap API - Weather data.
- OPTIONS - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
HTTP OPTIONS method for retrieving allowed methods.
- ORPHAN - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
The process instance is orphaned because its parent Bonita process definition was deleted.
P
- param(String, String) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- PARAMETER - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Represents a process parameter or configuration setting.
- params() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns the value of the
paramsrecord component. - params(Map<String, String>) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- parse(String) - Static method in record class com.bonitasoft.processbuilder.records.StepFieldRef
-
Parses a string in the format "step_xxx:field_yyy" and creates a StepFieldRef record.
- parseAndCollectUserIds(String, Function<String, T>, Function<T, Long>, Function<String[], List<M>>, IdentityAPI, Logger) - Static method in class com.bonitasoft.processbuilder.extension.TaskAssignationUtils
-
Complete flow: parses JSON and collects all user IDs.
- parseAndCollectUserIdsWithDynamicMembership(String, Function<String, T>, Function<T, Long>, Function<T, String>, Function<String[], List<M>>, IdentityAPI, Logger) - Static method in class com.bonitasoft.processbuilder.extension.TaskAssignationUtils
-
Complete flow with dynamic membership extraction.
- parseInvolvedUsersJson(String) - Static method in class com.bonitasoft.processbuilder.extension.InvolvedUsersParser
-
Parses the 'involvedUsers' JSON string, expecting the string to contain actor configuration (stepManager, stepUser, memberShips).
- parseJson(String) - Static method in class com.bonitasoft.processbuilder.validation.SchemaResolver
-
Parses a JSON string into a Jackson JsonNode.
- parseJson(String, Logger) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Parses a JSON string and returns the root JsonNode.
- parseJsonAndGetNode(String, String, Logger) - Static method in class com.bonitasoft.processbuilder.extension.IdentityUtils
-
Parses JSON and extracts a specific node by key.
- parseMembersShipsInput() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Parses the membersShipsInput into a StepFieldRef.
- parseStringToLong(String, String) - Static method in class com.bonitasoft.processbuilder.extension.InputValidationUtils
-
Parses a String input to a Long value with comprehensive validation and logging.
- parseStringToPositiveLong(String, String) - Static method in class com.bonitasoft.processbuilder.extension.InputValidationUtils
-
Parses a String input to a positive Long value with comprehensive validation and logging.
- parseUsersConfig(String, Logger) - Static method in class com.bonitasoft.processbuilder.extension.TaskAssignationUtils
-
Parses JSON content and extracts the user configuration for task assignation.
- parseUsersNode(String, Logger) - Static method in class com.bonitasoft.processbuilder.extension.TaskAssignationUtils
-
Parses JSON content and returns the "users" node directly.
- password() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
-
Returns the value of the
passwordrecord component. - password() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
-
Returns the value of the
passwordrecord component. - password() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BasicAuth
-
Returns the value of the
passwordrecord component. - password() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
-
Returns the value of the
passwordrecord component. - password(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig.Builder
- password(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig.Builder
- PASSWORD - Enum constant in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
The password for SMTP server authentication.
- PasswordCrypto - Class in com.bonitasoft.processbuilder.extension
-
Utility class for secure password encryption and decryption.
- PasswordCrypto.CryptoException - Exception in com.bonitasoft.processbuilder.extension
-
Exception thrown when cryptographic operations fail.
- patch() - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- PATCH - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
HTTP PATCH method for partial updates.
- path() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Returns the value of the
pathrecord component. - PAUSED - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
Future state: The instance has been manually suspended and is awaiting restart.
- PB_ACTION - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBAction BDM object.
- PB_ACTION_CONTENT - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBActionContent BDM object.
- PB_ADMINISTRATOR_PROFILE - Static variable in class com.bonitasoft.processbuilder.constants.Constants
-
Profile name constant for the PB Administrator profile.
- PB_CATEGORY - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBCategory BDM object.
- PB_DATA_PROCESS_INSTANCE - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBDataProcessInstance BDM object.
- PB_ENTITY_TYPE - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBEntityType BDM object.
- PB_FILES - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBFiles BDM object.
- PB_GENERIC_ENTRY - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBGenericEntry BDM object.
- PB_PROCESS - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBProcess BDM object.
- PB_PROCESS_INSTANCE - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBProcessInstance BDM object.
- PB_PROCESS_MANAGER_PROFILE - Static variable in class com.bonitasoft.processbuilder.constants.Constants
-
Profile name constant for the PB Process Manager profile.
- PB_RUNNING_INSTANCE - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBRunningInstance BDM object.
- PB_SMTP - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBSmtp BDM object.
- PB_STEP_PROCESS_INSTANCE - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBStepProcessInstance BDM object.
- PB_STEPS - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBSteps BDM object.
- PB_USER_LIST - Enum constant in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Represents a PBUserList BDM object.
- PB_USER_PROFILE - Static variable in class com.bonitasoft.processbuilder.constants.Constants
-
Profile name constant for the PB User profile.
- PBHtmlUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility class providing HTML manipulation methods for email content processing.
- pBProcessPersistenceId() - Method in record class com.bonitasoft.processbuilder.records.UserList
-
Returns the value of the
pBProcessPersistenceIdrecord component. - PBStringUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility class providing common String manipulation methods, focusing on normalization and case formatting.
- PDF - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
PDF content type (application/pdf).
- PENDING - Enum constant in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
The step is a user task awaiting assignment or completion by an actor.
- persistenceId() - Method in record class com.bonitasoft.processbuilder.records.UserList
-
Returns the value of the
persistenceIdrecord component. - post() - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- POST - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
HTTP POST method for creating resources.
- postJson(String, String) - Static method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Creates a POST request with JSON body.
- preemptive() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
-
Returns the value of the
preemptiverecord component. - preemptive() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BasicAuth
-
Returns the value of the
preemptiverecord component. - preemptive(boolean) - Method in class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig.Builder
- prepareEmailContent(String, String) - Static method in class com.bonitasoft.processbuilder.extension.PBHtmlUtils
-
Prepares email content by converting text to HTML and applying the email template.
- PRIMARY_COLOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The primary brand color used throughout the application.
- printRelevantValidationErrors(ProcessingReport, Map<String, String>) - Static method in class com.bonitasoft.processbuilder.validation.SchemaResolver
-
Logs the relevant validation errors (ERROR/FATAL) by descending into the 'allOf' structure.
- PROC_EXECUTION_CONNECTOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ConfigurationType
-
Represents the classification key for **Process Execution Connector** definitions.
- PROCESS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for generic Process operations.
- PROCESS_BUILDER_INITIALIZATION - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for Process Builder initialization.
- PROCESS_EXECUTION - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for Process Execution.
- PROCESS_STORAGE - Enum constant in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Represents the classification key for **Process Storage** definitions.
- ProcessInstance - Class in com.bonitasoft.processbuilder.extension
-
Handles process instance operations for REST API extensions.
- ProcessInstance() - Constructor for class com.bonitasoft.processbuilder.extension.ProcessInstance
- ProcessInstanceStateType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the possible lifecycle states for a Process Instance (PBProcessInstance).
- processMembershipBasedRecipients(IdentityAPI, Collection<T>, Function<T, Long>) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Processes membership-based recipients and retrieves their email addresses.
- processMemberships(List<String>, Function<String[], List<M>>, IdentityAPI, Logger) - Static method in class com.bonitasoft.processbuilder.extension.TaskAssignationUtils
-
Processes a list of membership references and returns matching user IDs.
- ProcessNameType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the names of the configurable process definitions.
- ProcessOptionType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid option types for a process.
- ProcessOptionValidator - Class in com.bonitasoft.processbuilder.validation
-
Utility class providing validation methods for checking if action and option type strings match predefined enum constants.
- processSingleMembership(String, Function<String[], List<M>>, IdentityAPI, Logger) - Static method in class com.bonitasoft.processbuilder.extension.TaskAssignationUtils
-
Processes a single membership reference and returns matching user IDs.
- ProcessStateType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the possible lifecycle states for a Process Definition (PBProcess).
- processStepBasedRecipients(IdentityAPI, List<T>, Function<T, Long>, boolean) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Processes step-based recipients and retrieves their email addresses.
- processStepManager(UsersConfigRecord, Function<String, T>, Function<T, Long>, IdentityAPI, Logger) - Static method in class com.bonitasoft.processbuilder.extension.TaskAssignationUtils
-
Processes the stepManager configuration and returns the manager's user ID.
- processStepUser(UsersConfigRecord, Function<String, T>, Function<T, Long>, Logger) - Static method in class com.bonitasoft.processbuilder.extension.TaskAssignationUtils
-
Processes the stepUser configuration and returns the user ID.
- ProcessStorageType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid storage types for process-related files, along with their business descriptions.
- processUsersRecipients(IdentityAPI, JsonNode) - Static method in class com.bonitasoft.processbuilder.extension.EmailRecipientsHelper
-
Processes user IDs from parameters and returns their emails.
- ProcessUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility class providing common process and BDM (Business Data Model) operations.
- ProfileUtis - Class in com.bonitasoft.processbuilder.extension
-
Utility class for retrieving user information based on Bonita profiles.
- put() - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- PUT - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
HTTP PUT method for replacing resources.
Q
- QUERY - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig.Location
- QUERY_PARAM - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestApiKeyLocation
-
API key is sent as a query parameter in the URL.
- queryParam(String, String) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- queryParam(String, String) - Static method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
- queryParam(String, String) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- queryParams() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns the value of the
queryParamsrecord component. - queryParams() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Returns the value of the
queryParamsrecord component. - queryParams() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns the value of the
queryParamsrecord component. - queryParams(Map<String, String>) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- queryParams(Map<String, String>) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- QueryParamValidator - Class in com.bonitasoft.processbuilder.extension
-
Utility class for validating query parameters in REST API extensions.
R
- RECIPIENT_EMAIL - Enum constant in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Resolves to the email address of the recipient user.
- RECIPIENT_FIRSTNAME - Enum constant in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Resolves to the first name of the recipient user.
- RECIPIENT_LASTNAME - Enum constant in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Resolves to the last name of the recipient user.
- RECIPIENTS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The recipients configuration object for notification actions.
- RECIPIENTS_MEMBERSHIP_IDS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The list of membership identifiers for notification recipients.
- RECIPIENTS_SPECIFIC_EMAILS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The list of specific email addresses for notification recipients.
- RECIPIENTS_STEP_ID - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The step identifier used to resolve dynamic recipients.
- RECIPIENTS_TYPE - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The type of recipients selection (e.g., static, dynamic, step-based).
- RECIPIENTS_USER_IDS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The list of user identifiers for notification recipients.
- RecipientsType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid recipient types for notification actions in process workflows.
- REDIRECTIONS - Enum constant in enum class com.bonitasoft.processbuilder.enums.FlowActionType
-
Action related to defining post-task navigation and flow redirection.
- REDIRECTIONS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for Redirections configuration.
- refMemberShip() - Method in record class com.bonitasoft.processbuilder.records.UserList
-
Returns the value of the
refMemberShiprecord component. - requestUrl() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Returns the value of the
requestUrlrecord component. - requiredField(String) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
-
Adds a required field that users must fill when using this template.
- requiredFields() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
requiredFieldsrecord component. - requiredFields(String...) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
-
Adds multiple required fields (varargs version).
- requiredFields(List<String>) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
-
Adds multiple required fields.
- requiresCredentials() - Method in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Checks if this authentication type requires credentials (username/password).
- requiresCredentials() - Method in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
- requiresOAuth2TokenExchange() - Method in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Checks if this authentication type requires OAuth2 token exchange.
- resolve(JsonNode) - Static method in class com.bonitasoft.processbuilder.execution.AuthPipeline
-
Full pipeline: normalize → decrypt → parse.
- resolveTemplateVariables(String, BiFunction<String, String, String>) - Static method in class com.bonitasoft.processbuilder.extension.PBStringUtils
-
Resolves and replaces all variables in the format
{{refStep:dataName}}within a template string. - responseBody() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Returns the value of the
responseBodyrecord component. - responseHeaders() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Returns the value of the
responseHeadersrecord component. - REST_API_CONNECTOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for REST API Connector.
- REST_API_TEMPLATES - Enum constant in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Represents the classification key for **REST API Templates** definitions.
- REST_APIS - Enum constant in enum class com.bonitasoft.processbuilder.enums.FlowActionType
-
Action related to REST APIs configuration and execution.
- REST_APIS - Enum constant in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Represents the classification key for **REST APIs** definitions.
- REST_APIS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for REST APIs configuration and execution.
- REST_COUNTRIES - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
REST Countries - Country information API
- RestApiCatalog - Class in com.bonitasoft.processbuilder.extension.template.catalog
-
Catalog of predefined REST API templates.
- RestApiCatalog.AuthType - Enum Class in com.bonitasoft.processbuilder.extension.template.catalog
-
Enum representing authentication types used by templates.
- RestApiCatalog.TemplateType - Enum Class in com.bonitasoft.processbuilder.extension.template.catalog
-
Enum representing all available REST API template types in the catalog.
- RestApiKeyLocation - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines where an API key should be placed in REST requests.
- RestApiTemplate - Record Class in com.bonitasoft.processbuilder.extension.template
-
Represents a REST API template configuration.
- RestApiTemplate(String, String, String, String, int, boolean, AuthConfig, Map<String, String>, List<RestApiTemplate.Method>, boolean, String, List<String>) - Constructor for record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Creates an instance of a
RestApiTemplaterecord class. - RestApiTemplate.Builder - Class in com.bonitasoft.processbuilder.extension.template
- RestApiTemplate.Method - Record Class in com.bonitasoft.processbuilder.extension.template
-
Represents a method/endpoint in the REST API.
- RestAuthConfig - Interface in com.bonitasoft.processbuilder.records
-
Sealed interface representing authentication configuration for REST services.
- RestAuthConfig.ApiKeyAuth - Record Class in com.bonitasoft.processbuilder.records
-
API Key authentication configuration.
- RestAuthConfig.BasicAuth - Record Class in com.bonitasoft.processbuilder.records
-
HTTP Basic Authentication configuration.
- RestAuthConfig.BearerAuth - Record Class in com.bonitasoft.processbuilder.records
-
Bearer token authentication configuration.
- RestAuthConfig.CustomAuth - Record Class in com.bonitasoft.processbuilder.records
-
Custom authentication with user-defined headers.
- RestAuthConfig.NoAuth - Record Class in com.bonitasoft.processbuilder.records
-
No authentication configuration.
- RestAuthConfig.OAuth2ClientCredentials - Record Class in com.bonitasoft.processbuilder.records
-
OAuth 2.0 Client Credentials authentication configuration.
- RestAuthConfig.OAuth2Password - Record Class in com.bonitasoft.processbuilder.records
-
OAuth 2.0 Resource Owner Password authentication configuration.
- RestAuthenticationType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the supported authentication types for REST service calls.
- RestContentType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the supported content types for REST service requests and responses.
- restCountries() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
REST Countries API - Country information.
- RestHttpMethod - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the supported HTTP methods for REST service calls.
- RestOAuth2ClientAuthMethod - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines how OAuth2 client credentials are sent to the token endpoint.
- RestServiceConstants - Class in com.bonitasoft.processbuilder.extension
-
Constants for REST service execution.
- RestServiceRequest - Record Class in com.bonitasoft.processbuilder.records
-
Represents a REST service request configuration.
- RestServiceRequest(String, RestHttpMethod, Map<String, String>, Map<String, String>, String, RestContentType, RestAuthConfig, int, boolean, boolean) - Constructor for record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Compact constructor with validation and defaults.
- RestServiceRequest.Builder - Class in com.bonitasoft.processbuilder.records
-
Builder class for constructing RestServiceRequest instances.
- RestServiceResponse - Record Class in com.bonitasoft.processbuilder.records
-
Represents a REST service response.
- RestServiceResponse(int, Map<String, String>, String, RestContentType, long, String, String) - Constructor for record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Compact constructor with defaults.
- roleId() - Method in record class com.bonitasoft.processbuilder.records.UserList
-
Returns the value of the
roleIdrecord component. - RUNNING - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
The instance is currently active and processing steps.
- RUNNING - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
The process definition is active and ready to be instantiated.
- RUNNING - Enum constant in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
The step is currently being executed or is waiting for execution in the engine.
S
- salesforce(String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Salesforce REST API.
- SALESFORCE - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
Salesforce - CRM Platform
- SAP_BUSINESS_ONE - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
SAP Business One - SMB ERP
- SAP_S4HANA - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
SAP S/4HANA - ERP System
- sapBusinessOne(String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
SAP Business One Service Layer.
- sapS4Hana(String, String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
SAP S/4HANA OData API.
- SAVE_COLOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The color used for save actions.
- SCHEMA_COMPONENTS_PREFIX - Static variable in class com.bonitasoft.processbuilder.constants.SchemaConstants
-
The prefix used for internal references to components within the schema file.
- SchemaConstants - Class in com.bonitasoft.processbuilder.constants
-
Utility class containing constant values related to OpenAPI/JSON Schema configuration and resource paths within the application.
- SchemaResolver - Class in com.bonitasoft.processbuilder.validation
-
Utility class responsible for loading, resolving, and validating JSON data against OpenAPI (Swagger) schema definitions.
- scope() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
-
Returns the value of the
scoperecord component. - scope() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
-
Returns the value of the
scoperecord component. - scope() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Returns the value of the
scoperecord component. - scope() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
-
Returns the value of the
scoperecord component. - scope(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.Builder
- scope(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig.Builder
- searchAndValidateId(String, Function<Long, T>, String) - Static method in class com.bonitasoft.processbuilder.extension.ProcessUtils
-
Searches for a BDM object by its persistence ID, handling the ID conversion from String to Long.
- searchBDM(String, Function<Long, T>, String) - Static method in class com.bonitasoft.processbuilder.extension.ProcessUtils
-
Searches for a BDM object by its persistence ID string, handling conversion and validation.
- searchBDMList(Long, Function<Long, List<T>>, String) - Static method in class com.bonitasoft.processbuilder.extension.ProcessUtils
-
Searches for a list of BDM objects by a persistence ID, handling validation and error handling.
- searchById(Long, Function<Long, T>, String) - Static method in class com.bonitasoft.processbuilder.extension.ProcessUtils
-
Searches for a BDM object using a provided search function (closure/lambda).
- searchByStringKey(String, Function<String, T>, String) - Static method in class com.bonitasoft.processbuilder.extension.ProcessUtils
-
Searches for a BDM object by a string key or reference, handling validation and error handling.
- SECTION_BACKGROUND - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The background color for highlighted sections.
- sendGrid(String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
SendGrid Email API.
- SENDGRID - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
SendGrid - Email delivery service
- SERVICE_CONNECTOR_ACTION_RUNNER - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Deprecated, for removal: This API element is subject to removal in a future version.
- serviceNow(String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
ServiceNow REST API.
- SERVICENOW - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
ServiceNow - IT Service Management
- slack(String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Slack Web API - Team communication.
- SLACK - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
Slack - Team communication platform
- SMTP - Enum constant in enum class com.bonitasoft.processbuilder.enums.ConfigurationType
-
Represents the classification key for **SMTP Configuration** definitions.
- SMTP_CONNECTOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for SMTP Connector.
- SMTP_HOST - Enum constant in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
The SMTP server hostname or IP address used for sending emails.
- SMTP_PORT - Enum constant in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
The port number used to connect to the SMTP server.
- SmtpType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid SMTP configuration attributes for email server settings.
- SPECIFIC - Enum constant in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Recipients specified as explicit email addresses.
- SSL - Enum constant in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
Indicates whether SSL encryption is enabled for the SMTP connection.
- STARTTLS - Enum constant in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
Indicates whether STARTTLS encryption is enabled for the SMTP connection.
- STATUS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Represents the status or state of the process execution lifecycle.
- statusCode() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Returns the value of the
statusCoderecord component. - statusCode() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Returns the value of the
statusCoderecord component. - STEP_MANAGER_KEY - Static variable in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
JSON key for stepManager.
- STEP_MANAGERS - Enum constant in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Recipients resolved as the managers of users who executed a specific step.
- STEP_STATUS - Enum constant in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Resolves to the current status of a specific step.
- STEP_USER_KEY - Static variable in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
JSON key for stepUser.
- STEP_USER_NAME - Enum constant in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Resolves to the username assigned to a specific step.
- STEP_USERS - Enum constant in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Recipients resolved from users who executed a specific process step.
- StepFieldRef - Record Class in com.bonitasoft.processbuilder.records
-
A record representing a parsed reference to a step and field.
- StepFieldRef(String, String) - Constructor for record class com.bonitasoft.processbuilder.records.StepFieldRef
-
Compact constructor for validation.
- stepManager() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Returns the value of the
stepManagerrecord component. - stepManagerRef() - Method in record class com.bonitasoft.processbuilder.records.InvolvedUsersData
-
Returns the value of the
stepManagerRefrecord component. - StepProcessInstanceStateType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the possible lifecycle states for a Process Step Instance (PBStepProcessInstance).
- stepRef() - Method in record class com.bonitasoft.processbuilder.records.StepFieldRef
-
Returns the value of the
stepRefrecord component. - STEPS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Represents a step or stage in the process workflow, typically linked to a task or action.
- stepUser() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Returns the value of the
stepUserrecord component. - stepUserRef() - Method in record class com.bonitasoft.processbuilder.records.InvolvedUsersData
-
Returns the value of the
stepUserRefrecord component. - STOPPED - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
The process definition has been disabled and cannot be instantiated.
- STORAGE_ROOT_DEFAULT - Enum constant in enum class com.bonitasoft.processbuilder.enums.GenericType
-
Default storage root directory configuration.
- StorageUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility methods for handling process storage logic based purely on storage name strings.
- SUBJECT - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The subject line for email notification actions.
- substitute(String, Map<String, ?>) - Static method in class com.bonitasoft.processbuilder.execution.TemplateSubstitution
-
Substitutes all {{param}} occurrences in template with values from params map.
- success() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Returns the value of the
successrecord component. - success(int, String, Map<String, String>, long, String) - Static method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
- success(int, String, Map<String, String>, long, String, String) - Static method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
- success(int, Map<String, String>, String, RestContentType, long, String) - Static method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Creates a successful response.
- SUCCESS_COLOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The color indicating success states and positive feedback.
- supportsBody() - Method in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
Checks if this HTTP method typically supports a request body.
T
- TARGET_STEP - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
The target step reference for redirection or flow actions.
- targetSchemaName() - Method in record class com.bonitasoft.processbuilder.records.LoadedSchema
-
Returns the value of the
targetSchemaNamerecord component. - TASK_LINK - Enum constant in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Resolves to a clickable HTML link to the task.
- TaskAssignationUtils - Class in com.bonitasoft.processbuilder.extension
-
Utility class for task assignation operations.
- TECHNICAL_CASE_CANCELLATION - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for technical case cancellation.
- templateAbstractEmailValidation() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Abstract Email Validation.
- templateAlfresco() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Alfresco Content Services.
- templateAlphaVantage() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Alpha Vantage - Financial data.
- templateApiKey() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: REST API - API Key.
- templateBasicAuth() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: REST API - Basic Authentication.
- templateBearerToken() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: REST API - Bearer Token.
- templateBonitaUniversal() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Bonita BPM Universal (30 methods).
- templateClearbit() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Clearbit - Data enrichment API.
- templateCompaniesHouseUK() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Companies House UK - UK company registry.
- templateCustomHeaders() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: REST API - Custom Headers.
- TemplateDataResolver - Class in com.bonitasoft.processbuilder.extension
-
Utility class for resolving template variables in notification messages.
- templateDocuSign() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: DocuSign eSignature.
- templateExchangeRate() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: ExchangeRate-API - Free currency rates.
- templateGoogleDrive() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Google Drive API.
- templateHubSpot() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: HubSpot CRM.
- templateIPGeolocation() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: IP-API - Free IP geolocation.
- templateJira() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Jira Cloud.
- templateJsonPlaceholder() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: JSONPlaceholder - Free test API.
- templateMicrosoftGraph() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Microsoft Graph API.
- templateNoAuth() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: REST API - No Authentication.
- templateNumVerify() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: NumVerify - Phone validation.
- templateOAuth2ClientCredentials() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: REST API - OAuth2 Client Credentials.
- templateOAuth2Password() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: REST API - OAuth2 Password Grant.
- templateOneDrive() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Microsoft OneDrive.
- templateOpenWeatherMap() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: OpenWeatherMap - Weather data API.
- templateRestCountries() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: REST Countries - Free countries API.
- templateSalesforce() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Salesforce CRM.
- templateSapS4Hana() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: SAP S/4HANA OData API.
- templateServiceNow() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: ServiceNow ITSM.
- templateSlack() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Slack Web API.
- templateStripe() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: Stripe Payments.
- TemplateSubstitution - Class in com.bonitasoft.processbuilder.execution
-
Substitutes {{param}} placeholders in template strings with actual values.
- templateVersion() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
templateVersionrecord component. - templateVersion(String) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
-
Sets the template version (default: "2.0").
- templateVIESVat() - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Template: VIES VAT Validation - EU VAT validation.
- TEST - Static variable in class com.bonitasoft.processbuilder.constants.Constants
-
Constant representing a general test string.
- TEST_REST_API_CONFIGURATION - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Process definition for testing REST API configurations.
- TEXT_COLOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The primary text color used for general content.
- TEXT_HTML - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
HTML content type (text/html).
- TEXT_PLAIN - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Plain text content type (text/plain).
- THEME - Enum constant in enum class com.bonitasoft.processbuilder.enums.ConfigurationType
-
Represents the classification key for **Theme Configuration** definitions.
- ThemeType - Enum Class in com.bonitasoft.processbuilder.enums
-
Defines the valid theme configuration attributes for application visual customization.
- timeout(int) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- timeoutMs() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns the value of the
timeoutMsrecord component. - timeoutMs() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
timeoutMsrecord component. - timeoutMs() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns the value of the
timeoutMsrecord component. - timeoutMs(int) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
- timeoutMs(int) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- titles() - Method in record class com.bonitasoft.processbuilder.records.LoadedSchema
-
Accessor method for the map of titles.
- toJson(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
- toJson(ObjectMapper) - Method in interface com.bonitasoft.processbuilder.extension.template.auth.AuthConfig
-
Converts this configuration to a JSON node for storage.
- toJson(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
- toJson(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BearerAuthConfig
- toJson(ObjectMapper) - Method in class com.bonitasoft.processbuilder.extension.template.auth.NoAuthConfig
- toJson(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
- toJson(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
- toJson(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
- toJson(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Converts this template to JSON format for storage in PBConfiguration.configValue.
- toJsonEncrypted(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
- toJsonEncrypted(ObjectMapper) - Method in interface com.bonitasoft.processbuilder.extension.template.auth.AuthConfig
-
Converts this configuration to a JSON node with sensitive fields encrypted.
- toJsonEncrypted(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
- toJsonEncrypted(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BearerAuthConfig
- toJsonEncrypted(ObjectMapper) - Method in class com.bonitasoft.processbuilder.extension.template.auth.NoAuthConfig
- toJsonEncrypted(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
- toJsonEncrypted(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
- toJsonEncrypted(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Converts this template to JSON format with encrypted sensitive fields.
- toJsonString(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Converts this template to a JSON string for storage.
- toJsonStringEncrypted(ObjectMapper) - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Converts this template to a JSON string with encrypted sensitive fields.
- token() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BearerAuthConfig
-
Returns the value of the
tokenrecord component. - token() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BearerAuth
-
Returns the value of the
tokenrecord component. - tokenUrl() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
-
Returns the value of the
tokenUrlrecord component. - tokenUrl() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
-
Returns the value of the
tokenUrlrecord component. - tokenUrl() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Returns the value of the
tokenUrlrecord component. - tokenUrl() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
-
Returns the value of the
tokenUrlrecord component. - tokenUrl(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.Builder
- tokenUrl(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig.Builder
- toLongIds(List<User>) - Static method in class com.bonitasoft.processbuilder.mapper.UserMapper
-
Converts a list of Bonita User objects into a list containing only their Long identifiers.
- toLowerSnakeCase(String) - Static method in class com.bonitasoft.processbuilder.extension.PBStringUtils
-
Converts a string from human-readable format (e.g., spaces) to
snake_caseformat. - toString() - Method in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Returns a string representation of this enum constant.
- toString() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BearerAuthConfig
-
Returns a string representation of this record class.
- toString() - Method in class com.bonitasoft.processbuilder.extension.template.auth.NoAuthConfig
- toString() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Method
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.InvolvedUsersData
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.LoadedSchema
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.ApiKeyAuth
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BasicAuth
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BearerAuth
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.CustomAuth
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.NoAuth
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.StepFieldRef
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.UserList
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.UserRecord
-
Returns a string representation of this record class.
- toString() - Method in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Returns a string representation of this record class.
- toSummary() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Returns a summary of the response for logging.
- toUpperSnakeCase(String) - Static method in class com.bonitasoft.processbuilder.extension.PBStringUtils
-
Converts a string from human-readable format (e.g., spaces) to
snake_caseformat. - TRUST_CERTIFICATE - Enum constant in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
Indicates whether to trust the server certificate without validation.
U
- UPDATE - Enum constant in enum class com.bonitasoft.processbuilder.enums.ActionType
-
Represents the modification of an existing business object.
- url() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns the value of the
urlrecord component. - url() - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Returns the value of the
urlrecord component. - userId() - Method in record class com.bonitasoft.processbuilder.records.UserList
-
Returns the value of the
userIdrecord component. - UserList - Record Class in com.bonitasoft.processbuilder.records
-
Record representing a minimal set of user and membership data defined for a **process definition**.
- UserList(Long, Boolean, String, String, Long, Long, Long, Long) - Constructor for record class com.bonitasoft.processbuilder.records.UserList
-
Compact constructor to perform validation or canonicalization, if needed.
- UserMapper - Class in com.bonitasoft.processbuilder.mapper
-
Utility class for converting and mapping collections of Bonita User entities to various data structures such as identifier lists.
- username() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
-
Returns the value of the
usernamerecord component. - username() - Method in record class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig
-
Returns the value of the
usernamerecord component. - username() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.BasicAuth
-
Returns the value of the
usernamerecord component. - username() - Method in record class com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password
-
Returns the value of the
usernamerecord component. - username(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig.Builder
- username(String) - Method in class com.bonitasoft.processbuilder.extension.template.auth.OAuth2PasswordConfig.Builder
- userName() - Method in record class com.bonitasoft.processbuilder.records.UserRecord
-
Returns the value of the
userNamerecord component. - USERNAME - Enum constant in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
The username for SMTP server authentication.
- UserRecord - Record Class in com.bonitasoft.processbuilder.records
-
A record representing a generic user in the system.
- UserRecord(Long, String, String, String, String, String) - Constructor for record class com.bonitasoft.processbuilder.records.UserRecord
-
Creates an instance of a
UserRecordrecord class. - USERS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Represents a user or a list of users involved in a process instance.
- USERS - Enum constant in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Recipients specified as a list of user identifiers.
- USERS_KEY - Static variable in record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
JSON key for the users node.
- UsersConfigRecord - Record Class in com.bonitasoft.processbuilder.records
-
A record representing the user configuration for task assignation.
- UsersConfigRecord(String, String, List<String>, String) - Constructor for record class com.bonitasoft.processbuilder.records.UsersConfigRecord
-
Compact constructor ensuring memberShips is immutable.
- usesStaticToken() - Method in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Checks if this authentication type uses a static token.
- Utils - Class in com.bonitasoft.processbuilder.extension
-
Utility class providing common String manipulation methods, focusing on normalization and case formatting.
V
- validateActionAndDelete(T, String, Long, String) - Static method in class com.bonitasoft.processbuilder.extension.ProcessUtils
-
Combines the check for a DELETE action with the validation that the BDM object exists.
- validateField(JsonNode, String, Predicate<JsonNode>, String) - Static method in class com.bonitasoft.processbuilder.extension.JsonValidationUtils
-
A utility method to validate the existence and type of a specific field in a JSON node.
- validateInputParameters(String, String) - Method in class com.bonitasoft.processbuilder.extension.ExecuteSqlDatasource
-
Validates input parameters for SQL datasource execution.
- validateMandatoryLong(String, String) - Static method in class com.bonitasoft.processbuilder.extension.QueryParamValidator
-
Validates that a mandatory query parameter is a valid long value.
- validateMemberships(JsonNode) - Static method in class com.bonitasoft.processbuilder.extension.JsonValidationUtils
-
Validates that the 'memberShips' node is a JSON array and that all elements within the array are non-empty strings (membership references).
- validateNumerical(String, String) - Static method in class com.bonitasoft.processbuilder.extension.QueryParamValidator
-
Validates that a query parameter is a numerical value (integer).
- ValidationException - Exception in com.bonitasoft.processbuilder.extension
-
Exception thrown when validation of input parameters fails.
- ValidationException(String) - Constructor for exception com.bonitasoft.processbuilder.extension.ValidationException
-
Constructs a new ValidationException with the specified detail message.
- ValidationException(String, Throwable) - Constructor for exception com.bonitasoft.processbuilder.extension.ValidationException
-
Constructs a new ValidationException with the specified detail message and cause.
- validator() - Method in record class com.bonitasoft.processbuilder.records.LoadedSchema
-
Returns the value of the
validatorrecord component. - valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ActionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ConfigurationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.CriticalityType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ExecutionConnectorType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.FlowActionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.FormContentType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.GenericType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessStorageType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestApiKeyLocation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.RestOAuth2ClientAuthMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig.Location
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.ClientAuthMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.AuthType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.ActionParameterType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.ActionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.BDMObjectType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.ConfigurationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.CriticalityType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.DataResolverType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.ExecutionConnectorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.FlowActionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.FormContentType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.GenericEntryType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.GenericType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessNameType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessOptionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessStateType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.ProcessStorageType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.RecipientsType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.RestApiKeyLocation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.RestAuthenticationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.RestHttpMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.RestOAuth2ClientAuthMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.SmtpType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig.Location
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig.ClientAuthMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.AuthType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verifySsl() - Method in record class com.bonitasoft.processbuilder.execution.ConnectorRequest
-
Returns the value of the
verifySslrecord component. - verifySsl() - Method in record class com.bonitasoft.processbuilder.extension.template.RestApiTemplate
-
Returns the value of the
verifySslrecord component. - verifySsl() - Method in record class com.bonitasoft.processbuilder.records.RestServiceRequest
-
Returns the value of the
verifySslrecord component. - verifySsl(boolean) - Method in class com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder
- verifySsl(boolean) - Method in class com.bonitasoft.processbuilder.records.RestServiceRequest.Builder
- verifySsl(Boolean) - Method in class com.bonitasoft.processbuilder.execution.ConnectorRequest.Builder
W
- WAIT_TIME_SECONDS - Enum constant in enum class com.bonitasoft.processbuilder.enums.ExecutionConnectorType
-
The waiting time in seconds before each retry attempt.
- WARNING_COLOR - Enum constant in enum class com.bonitasoft.processbuilder.enums.ThemeType
-
The color indicating warning states and cautionary feedback.
- withBody(String) - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Creates a copy of this response with a different body.
- withError(String) - Method in record class com.bonitasoft.processbuilder.records.RestServiceResponse
-
Creates a copy of this response with a different error message.
- workday(String, String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Workday REST API.
- WORKDAY - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
Workday - HCM Platform
X
- XML - Enum constant in enum class com.bonitasoft.processbuilder.enums.RestContentType
-
XML content type (application/xml).
Z
- zendesk(String, String, String) - Static method in class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog
-
Zendesk Support API.
- ZENDESK - Enum constant in enum class com.bonitasoft.processbuilder.extension.template.catalog.RestApiCatalog.TemplateType
-
Zendesk - Customer service platform
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
ProcessNameType.COMMON_ACTION_EXECUTORinstead. This process is replaced by CommonActionExecutor.