org.camunda.bpm.ProcessEngineService Maven / Gradle / Ivy

Go to download

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.23.0-alpha2

/* Licensed under the Apache License, Version 2.0 (the "License");
 * 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;

import java.util.List;
import java.util.Set;

import org.camunda.bpm.engine.ProcessEngine;

/**
 * The {@link ProcessEngineService} provides access to the list of Managed Process Engines.
 * 
 * Users of this class may look up an instance of the service through a lookup strategy
 * appropriate for the platform they are using (Examples: Jndi, OSGi Service Registry ...)
 * 
 * @author Daniel Meyer
 */
public interface ProcessEngineService {
  
  /**
   * 
   * @return the default process engine.
   */
  public ProcessEngine getDefaultProcessEngine();

  /**
   * @return all {@link ProcessEngine ProcessEngines} managed by the camunda BPM platform.
   */
  public List getProcessEngines();

  /**
   * 
   * @return the names of all {@link ProcessEngine ProcessEngines} managed by the camunda BPM platform.
   */
  public Set getProcessEngineNames();
  
  /**
   * 
   * @return the {@link ProcessEngine} for the given name or null if no such process engine exists.
   */
  public ProcessEngine getProcessEngine(String name);
  
}