WebhookCommonConfig.java

/*
 * Copyright 2017 StreamSets Inc.
 *
 * Licensed under the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.datacollector.config;

import com.streamsets.pipeline.api.ConfigDef;
import com.streamsets.pipeline.api.ValueChooserModel;
import com.streamsets.pipeline.lib.el.RecordEL;

import java.util.HashMap;
import java.util.Map;

public abstract class WebhookCommonConfig {
  private static final String DEFAULT_CONTENT_TYPE = "application/json";

  @ConfigDef(
      required = false,
      type = ConfigDef.Type.STRING,
      label = "Webhook URL",
      description = "The Webhook HTTP resource URL",
      elDefs = RecordEL.class,
      displayPosition = 200
  )
  public String webhookUrl = "";

  @ConfigDef(
      required = false,
      type = ConfigDef.Type.MAP,
      label = "Headers",
      defaultValue = "{}",
      description = "Headers to include in the request",
      displayPosition = 210,
      group = "NOTIFICATIONS"
  )
  public Map<String, String> headers = new HashMap<>();

  @ConfigDef(
      required = true,
      type = ConfigDef.Type.MODEL,
      label = "HTTP Method",
      defaultValue = "POST",
      description = "HTTP method to send",
      displayPosition = 220,
      group = "NOTIFICATIONS"
  )
  @ValueChooserModel(HttpMethodChooserValues.class)
  public HttpMethod httpMethod = HttpMethod.POST;

  @ConfigDef(
      required = false,
      type = ConfigDef.Type.STRING,
      label = "Content Type",
      defaultValue = DEFAULT_CONTENT_TYPE,
      description = "Content-Type header to be sent with the request; used if that header is not already present",
      displayPosition = 250,
      dependsOn = "httpMethod",
      evaluation = ConfigDef.Evaluation.EXPLICIT,
      triggeredByValue = { "POST", "PUT", "DELETE"},
      group = "NOTIFICATIONS"
  )
  public String contentType = DEFAULT_CONTENT_TYPE;

  @ConfigDef(
      required = true,
      type = ConfigDef.Type.MODEL,
      label = "Authentication Type",
      defaultValue = "NONE",
      displayPosition = 260,
      group = "NOTIFICATIONS"
  )
  @ValueChooserModel(AuthenticationTypeChooserValues.class)
  public AuthenticationType authType = AuthenticationType.NONE;

  @ConfigDef(
      required = true,
      type = ConfigDef.Type.STRING,
      label = "Username",
      displayPosition = 270,
      group = "NOTIFICATIONS",
      dependsOn = "authType",
      triggeredByValue = { "BASIC", "DIGEST", "UNIVERSAL" }
  )
  public String username;

  @ConfigDef(
      required = true,
      type = ConfigDef.Type.STRING,
      label = "Password",
      displayPosition = 280,
      group = "NOTIFICATIONS",
      dependsOn = "authType",
      triggeredByValue = { "BASIC", "DIGEST", "UNIVERSAL" }
  )
  public String password;

}