Package com.bonitasoft.processbuilder.extension.template

Class RestApiTemplate.Builder

java.lang.Object

com.bonitasoft.processbuilder.extension.template.RestApiTemplate.Builder

Enclosing class:

RestApiTemplate

public static class RestApiTemplate.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RestApiTemplate.Builder	addMethod(RestApiTemplate.Method method)
RestApiTemplate.Builder	addMethod(String name, String httpMethod, String path)
RestApiTemplate.Builder	addMethod(String name, String displayName, String description, String httpMethod, String path, Map<String,String> queryParams, String bodyTemplate)	Adds a method with full configuration including displayName, description, and body template.
RestApiTemplate.Builder	addMethod(String name, String httpMethod, String path, Map<String,String> queryParams)
RestApiTemplate.Builder	asTemplate()	Marks this as a template definition (includes isTemplate, templateVersion, requiredFields in JSON).
RestApiTemplate.Builder	auth(AuthConfig auth)
RestApiTemplate.Builder	baseUrl(String baseUrl)
RestApiTemplate	build()
RestApiTemplate.Builder	description(String description)
RestApiTemplate.Builder	displayName(String displayName)
RestApiTemplate.Builder	header(String name, String value)
RestApiTemplate.Builder	headers(Map<String,String> headers)
RestApiTemplate.Builder	name(String name)
RestApiTemplate.Builder	requiredField(String fieldName)	Adds a required field that users must fill when using this template.
RestApiTemplate.Builder	requiredFields(String... fields)	Adds multiple required fields (varargs version).
RestApiTemplate.Builder	requiredFields(List<String> fields)	Adds multiple required fields.
RestApiTemplate.Builder	templateVersion(String version)	Sets the template version (default: "2.0").
RestApiTemplate.Builder	timeoutMs(int timeoutMs)
RestApiTemplate.Builder	verifySsl(boolean verifySsl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

name

public RestApiTemplate.Builder name(String name)

displayName

public RestApiTemplate.Builder displayName(String displayName)

description

public RestApiTemplate.Builder description(String description)

baseUrl

public RestApiTemplate.Builder baseUrl(String baseUrl)

timeoutMs

public RestApiTemplate.Builder timeoutMs(int timeoutMs)

verifySsl

public RestApiTemplate.Builder verifySsl(boolean verifySsl)

auth

public RestApiTemplate.Builder auth(AuthConfig auth)

header

public RestApiTemplate.Builder header(String name,
 String value)

headers

public RestApiTemplate.Builder headers(Map<String,String> headers)

addMethod

public RestApiTemplate.Builder addMethod(RestApiTemplate.Method method)

addMethod

public RestApiTemplate.Builder addMethod(String name,
 String httpMethod,
 String path)

addMethod

public RestApiTemplate.Builder addMethod(String name,
 String httpMethod,
 String path,
 Map<String,String> queryParams)

addMethod

public RestApiTemplate.Builder addMethod(String name,
 String displayName,
 String description,
 String httpMethod,
 String path,
 Map<String,String> queryParams,
 String bodyTemplate)

Adds a method with full configuration including displayName, description, and body template.

Parameters:

name - Method identifier

displayName - Human-readable name

description - Method description

httpMethod - HTTP method (GET, POST, PUT, DELETE, PATCH)

path - Endpoint path (can include placeholders like {{id}})

queryParams - Query parameters (can include placeholders)

bodyTemplate - Body template (can include placeholders like {{field}})

Returns:

this builder

asTemplate

public RestApiTemplate.Builder asTemplate()

Marks this as a template definition (includes isTemplate, templateVersion, requiredFields in JSON).

Returns:

this builder

templateVersion

public RestApiTemplate.Builder templateVersion(String version)

Sets the template version (default: "2.0").

Parameters:

version - Template version string

Returns:

this builder

requiredField

public RestApiTemplate.Builder requiredField(String fieldName)

Adds a required field that users must fill when using this template.

Parameters:

fieldName - Name of the required field (e.g., "baseUrl", "token", "username")

Returns:

this builder

requiredFields

public RestApiTemplate.Builder requiredFields(List<String> fields)

Adds multiple required fields.

Parameters:

fields - List of required field names

Returns:

this builder

requiredFields

public RestApiTemplate.Builder requiredFields(String... fields)

Adds multiple required fields (varargs version).

Parameters:

fields - Required field names

Returns:

this builder

build

public RestApiTemplate build()