org.apache.nifi.annotation.behavior

Annotation Type Stateful

@Documented
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
public @interface Stateful

Annotation that a Processor, ReportingTask, or Controller Service can use to indicate that the component makes use of the StateManager. This annotation provides the user with a description of what information is being stored so that the user is able to understand what is shown to them and know what they are clearing should they choose to clear the state. Additionally, the UI will not show any state information to users if this annotation is not present.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	description Provides a description of what information is being stored in the StateManager
Scope[]	scopes Indicates the Scope(s) associated with the State that is stored and retrieved.

Element Detail

description

public abstract java.lang.String description

Provides a description of what information is being stored in the StateManager

scopes

public abstract Scope[] scopes

Indicates the Scope(s) associated with the State that is stored and retrieved.