org.camunda.bpm.engine.spring.annotations.ProcessEngineComponent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine-spring-6 Show documentation

There is a newer version: 7.23.0-alpha2

Show newest version

/*
 * Copyright 2011 the original author or authors
 *
 * 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.engine.spring.annotations;


import java.lang.annotation.*;

/**
 * Indicates that the given bean is an process engine handler. A process engine handler is a bean
 * that is so annotated to respond to events ("states") in a Camunda Platform process.
 * Generically, it is a class that has been adapted to be usable in a Camunda Platform process.
 *
 * 
 * For example, suppose we have registered a BPMN process that has
 * the following declaration:
 * 

 * 
 * <service-task camunda:expression = "myBean" id = "confirm-receipt" />
 * 
 * 

 * This is a state that will be entered from Camunda Platform and execution will flow through to the bean
 * registered in the context as "myBean." To subscribe to that, a POJO need only implement
 * (optionally) {@link ProcessEngineComponent} and, on a method, add
 * {@link State} to indicate that the method in particular is
 * tasked with responding to a state. If applied to a bean and there are no {@link org.camunda.bpm.engine.annotations.ProcessEngineComponent}
 * annotations present, then one option might be to automatically enlist all public methods
 * as handlers for states whose IDs or names are inferred from the method name:
 * 

 * public void confirmReceipt(..) would be treated the same as
 * 
 * @State( "confirm-receipt") public void confirmReceipt (..),
 *
 * @author Josh Long
 * @since 1.0
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
//@Component
public @interface ProcessEngineComponent {
	String processKey() default "";
}