org.camunda.bpm.client.topic.TopicSubscriptionBuilder Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.camunda.bpm.client.topic;
import java.util.Map;
import org.camunda.bpm.client.exception.ExternalTaskClientException;
import org.camunda.bpm.client.task.ExternalTaskHandler;
/**
* A fluent builder to configure the topic subscription
*
* @author Tassilo Weidner
*/
public interface TopicSubscriptionBuilder {
/**
* @param lockDuration
* - in milliseconds to lock the external tasks
*
- must be greater than zero
*
- the default lock duration is 20 seconds (20,000 milliseconds)
*
- overrides the lock duration configured on bootstrapping the client
*
* @return the builder
*/
TopicSubscriptionBuilder lockDuration(long lockDuration);
/**
* @param handler which will be executed for the external task
* @return the builder
*/
TopicSubscriptionBuilder handler(ExternalTaskHandler handler);
/**
* @param variableNames of variables which are supposed to be retrieved
* @return the builder
*/
TopicSubscriptionBuilder variables(String... variableNames);
/**
* @param localVariables
* whether or not variables from greater scope than the external task
* should be fetched. false means all variables visible
* in the scope of the external task will be fetched,
* true means only local variables (to the scope of the
* external task) will be fetched
* @return the builder
*/
TopicSubscriptionBuilder localVariables(boolean localVariables);
/**
* @param businessKey to filter for external tasks that are supposed to be fetched and locked
* @return the builder
*/
TopicSubscriptionBuilder businessKey(String businessKey);
/**
* @param processDefinitionId to filter for external tasks that are supposed to be fetched and locked
* @return the builder
*/
TopicSubscriptionBuilder processDefinitionId(String processDefinitionId);
/**
* @param processDefinitionIds to filter for external tasks that are supposed to be fetched and locked
* @return the builder
*/
TopicSubscriptionBuilder processDefinitionIdIn(String... processDefinitionIds);
/**
* @param processDefinitionKey to filter for external tasks that are supposed to be fetched and locked
* @return the builder
*/
TopicSubscriptionBuilder processDefinitionKey(String processDefinitionKey);
/**
* @param processDefinitionKeys to filter for external tasks that are supposed to be fetched and locked
* @return the builder
*/
TopicSubscriptionBuilder processDefinitionKeyIn(String... processDefinitionKeys);
/**
* @param processDefinitionKeys to filter for external tasks that are supposed to be fetched and locked
* @return the builder
*/
TopicSubscriptionBuilder processDefinitionVersionTag(String processDefinitionVersionTag);
/**
* @param processVariables of which the external tasks to be retrieved are related to
*
* @return the builder
*/
TopicSubscriptionBuilder processVariablesEqualsIn(Map processVariables);
/**
* @param processVariables of which the external tasks to be retrieved are related to
* When called more than once, retrieves tasks related to ANY of the given processVariables
* In such cases, consider using processVariablesEqualsIn(Map) instead
* @return the builder
*/
TopicSubscriptionBuilder processVariableEquals(String name, Object value);
/**
* Filter for external tasks without tenant
* @return the builder
*/
TopicSubscriptionBuilder withoutTenantId();
/**
* @param tenantIds to filter for external tasks that are supposed to be fetched and locked
* @return the builder
*/
TopicSubscriptionBuilder tenantIdIn(String... tenantIds);
/**
* @param includeExtensionProperties
* whether or not to include custom extension properties for fetched
* external tasks. true means all extensionProperties
* defined in the external task activity will be provided.
* false means custom extension properties are not
* available within the external-task-client. The default is
* false.
* @return the builder
*/
TopicSubscriptionBuilder includeExtensionProperties(boolean includeExtensionProperties);
/**
* Release the topic subscription for being executed asynchronously
*
* @throws ExternalTaskClientException
*
* - if topic name is null or an empty string
*
- if lock duration is not greater than zero
*
- if external task handler is null
*
- if topic name has already been subscribed
*
* @return the builder
*/
TopicSubscription open();
}