com.streamsets.pipeline.api.service.ServiceDef Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of streamsets-datacollector-api Show documentation
StreamSets Data Collector API
The newest version!
/*
 * Copyright contributors to the StreamSets project
 * StreamSets Inc., an IBM Company 2024
 *
 * 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 com.streamsets.pipeline.api.service;

import com.streamsets.pipeline.api.StageUpgrader;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation to declare Data Collector service classes. Services must implement {@link Service} and then
 * interface specified in provides attribute.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface ServiceDef {

  /**
   * Interface describing what methods this services provides.
   *
   * @return Interface declaring this service.
   */
  Class provides();

  /**
   * Indicates the version of the stage.
   *
   * The version is used to track the configuration of a service definition and any necessary upgrade via a {@link StageUpgrader}.
   */
  int version();

  /**
   * Indicates the UI default label for the stage.
   */
  String label();

  /**
   * Indicates the UI default description for the stage.
   */
  String description() default "";

  /**
   * Indicates each stage instance should use a private classloader.
   */
  boolean privateClassLoader() default false;

  /**
   * Indicates the upgrader implementation class to use to upgrade stage configurations for older stage versions.
   */
  Class upgrader() default StageUpgrader.Default.class;

  /**
   * Defines the upgrader definition.
   * 
   * The upgrader definition is a YAML file, found in the classpath of the stage library, that declares the stage
   * configuration upgrade steps.
   * 
   * Refer to the developer documentation for details.
   */
  String upgraderDef() default "";

}