org.camunda.bpm.client.ExternalTaskClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-external-task-client Show documentation

There is a newer version: 7.23.0-alpha1

Show newest version

/*
 * 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;

import org.camunda.bpm.client.impl.ExternalTaskClientBuilderImpl;
import org.camunda.bpm.client.topic.TopicSubscriptionBuilder;

/**
 * Camunda external task client
 *
 * @author Tassilo Weidner
 */
public interface ExternalTaskClient {

  /**
   * Creates a fluent builder to configure the Camunda client
   *
   * @return builder to apply configurations on
   */
  static ExternalTaskClientBuilder create() {
    return new ExternalTaskClientBuilderImpl();
  }

  /**
   * Creates a fluent builder to create and configure a topic subscription
   *
   * @param topicName the client subscribes to
   * @return builder to apply configurations on
   */
  TopicSubscriptionBuilder subscribe(String topicName);

  /**
   * Stops continuous fetching and locking of tasks
   */
  void stop();

  /**
   * Starts continuous fetching and locking of tasks
   */
  void start();

  /**
   * @return 
   *            {@code true} if the client is actively fetching for tasks
   *           
 {@code false} if the client is not actively fetching for tasks
   *         
   */
  boolean isActive();

}