org.camunda.bpm.engine.ProcessEngine Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine Show documentation
There is a newer version: 7.22.0-alpha1
/*
 * 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.engine;

/**
 * Provides access to all the services that expose the BPM and workflow operations.
 *
 * 
 * 
 * {@link org.camunda.bpm.engine.RuntimeService}:  Allows the creation of
 * {@link org.camunda.bpm.engine.repository.Deployment}s and the starting of and searching on
 * {@link org.camunda.bpm.engine.runtime.ProcessInstance}s.
 * 
 * {@link org.camunda.bpm.engine.TaskService}:  Exposes operations to manage human
 * (standalone) {@link org.camunda.bpm.engine.task.Task}s, such as claiming, completing and
 * assigning tasks
 * 
 * {@link org.camunda.bpm.engine.IdentityService}:  Used for managing
 * {@link org.camunda.bpm.engine.identity.User}s, {@link org.camunda.bpm.engine.identity.Group}s and
 * the relations between them<
 * 
 * {@link org.camunda.bpm.engine.ManagementService}:  Exposes engine admin and
 * maintenance operations
 *  
 * {@link org.camunda.bpm.engine.HistoryService}:  Service exposing information about
 * ongoing and past process instances.
 *
 * {@link org.camunda.bpm.engine.AuthorizationService}: Service allowing
 * to manage access permissions for users and groups.
 * 
 *
 *
 * Typically, there will be only one central ProcessEngine instance needed in a
 * end-user application. Building a ProcessEngine is done through a
 * {@link ProcessEngineConfiguration} instance and is a costly operation which should be
 * avoided. For that purpose, it is advised to store it in a static field or
 * JNDI location (or something similar). This is a thread-safe object, so no
 * special precautions need to be taken.
 *
 * @author Tom Baeyens
 * @author Joram Barrez
 * @author Daniel Meyer
 */
public interface ProcessEngine extends ProcessEngineServices {

  /** the version of the process engine library */
  public static String VERSION = "fox";

  /** The name as specified in 'process-engine-name' in
   * the camunda.cfg.xml configuration file.
   * The default name for a process engine is 'default */
  String getName();

  void close();

  ProcessEngineConfiguration getProcessEngineConfiguration();
}