mod/designtool/designtool-web/src/main/java/org/apache/nifi/web/api/dto/FlowConfigurationDTO.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * Modifications to the original nifi code for the ONAP project are made
  18  * available under the Apache License, Version 2.0
  19  */
  20 package org.apache.nifi.web.api.dto;
  21
  22 import io.swagger.annotations.ApiModelProperty;
  23 import org.apache.nifi.web.api.dto.util.TimeAdapter;
  24
  25 import javax.xml.bind.annotation.XmlType;
  26 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
  27 import java.util.Date;
  28
  29 /**
  30  * Details for the controller configuration.
  31  */
  32 @XmlType(name = "flowConfiguration")
  33 public class FlowConfigurationDTO {
  34
  35     private Boolean supportsManagedAuthorizer;
  36     private Boolean supportsConfigurableAuthorizer;
  37     private Boolean supportsConfigurableUsersAndGroups;
  38     private Long autoRefreshIntervalSeconds;
  39
  40     private Date currentTime;
  41     private Integer timeOffset;
  42
  43     private Long defaultBackPressureObjectThreshold;
  44     private String defaultBackPressureDataSizeThreshold;
  45
  46     private String dcaeDistributorApiHostname;
  47
  48     /**
  49      * @author Renu
  50      * @return getter and setter for dcae distributor api hostname. This value is read only
  51      */
  52     @ApiModelProperty(
  53             value = "Whether it picks up configurable host address.",
  54             readOnly = true
  55     )
  56     public String getDcaeDistributorApiHostname() {
  57         return dcaeDistributorApiHostname;
  58     }
  59
  60     public void setDcaeDistributorApiHostname(String dcaeDistributorApiHostname) {
  61         this.dcaeDistributorApiHostname = dcaeDistributorApiHostname;
  62     }
  63
  64     /**
  65      * @return interval in seconds between the automatic NiFi refresh requests. This value is read only
  66      */
  67     @ApiModelProperty(
  68             value = "The interval in seconds between the automatic NiFi refresh requests.",
  69             readOnly = true
  70     )
  71     public Long getAutoRefreshIntervalSeconds() {
  72         return autoRefreshIntervalSeconds;
  73     }
  74
  75     public void setAutoRefreshIntervalSeconds(Long autoRefreshIntervalSeconds) {
  76         this.autoRefreshIntervalSeconds = autoRefreshIntervalSeconds;
  77     }
  78
  79     /**
  80      * @return whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups,
  81      * and policies in the UI. This value is read only
  82      */
  83     @ApiModelProperty(
  84             value = "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.",
  85             readOnly = true
  86     )
  87     public Boolean getSupportsManagedAuthorizer() {
  88         return supportsManagedAuthorizer;
  89     }
  90
  91     public void setSupportsManagedAuthorizer(Boolean supportsManagedAuthorizer) {
  92         this.supportsManagedAuthorizer = supportsManagedAuthorizer;
  93     }
  94
  95     /**
  96      * @return whether this NiFi supports configurable users and groups. This value is read only
  97      */
  98     @ApiModelProperty(
  99             value = "Whether this NiFi supports configurable users and groups.",
 100             readOnly = true
 101     )
 102     public Boolean getSupportsConfigurableUsersAndGroups() {
 103         return supportsConfigurableUsersAndGroups;
 104     }
 105
 106     public void setSupportsConfigurableUsersAndGroups(Boolean supportsConfigurableUsersAndGroups) {
 107         this.supportsConfigurableUsersAndGroups = supportsConfigurableUsersAndGroups;
 108     }
 109
 110     /**
 111      * @return whether this NiFi supports a configurable authorizer. This value is read only
 112      */
 113     @ApiModelProperty(
 114             value = "Whether this NiFi supports a configurable authorizer.",
 115             readOnly = true
 116     )
 117     public Boolean getSupportsConfigurableAuthorizer() {
 118         return supportsConfigurableAuthorizer;
 119     }
 120
 121     public void setSupportsConfigurableAuthorizer(Boolean supportsConfigurableAuthorizer) {
 122         this.supportsConfigurableAuthorizer = supportsConfigurableAuthorizer;
 123     }
 124
 125     /**
 126      * @return current time on the server
 127      */
 128     @XmlJavaTypeAdapter(TimeAdapter.class)
 129     @ApiModelProperty(
 130             value = "The current time on the system.",
 131             dataType = "string"
 132     )
 133     public Date getCurrentTime() {
 134         return currentTime;
 135     }
 136
 137     public void setCurrentTime(Date currentTime) {
 138         this.currentTime = currentTime;
 139     }
 140
 141     /**
 142      * @return time offset of the server
 143      */
 144     @ApiModelProperty(
 145             value = "The time offset of the system."
 146     )
 147     public Integer getTimeOffset() {
 148         return timeOffset;
 149     }
 150
 151     public void setTimeOffset(Integer timeOffset) {
 152         this.timeOffset = timeOffset;
 153     }
 154
 155     /**
 156      * @return the default back pressure object threshold
 157      */
 158     @ApiModelProperty(
 159             value = "The default back pressure object threshold."
 160     )
 161     public Long getDefaultBackPressureObjectThreshold() {
 162         return defaultBackPressureObjectThreshold;
 163     }
 164
 165     public void setDefaultBackPressureObjectThreshold(Long backPressureObjectThreshold) {
 166         this.defaultBackPressureObjectThreshold = backPressureObjectThreshold;
 167     }
 168
 169     /**
 170      * @return the default back pressure data size threshold
 171      */
 172     @ApiModelProperty(
 173             value = "The default back pressure data size threshold."
 174     )
 175     public String getDefaultBackPressureDataSizeThreshold() {
 176         return defaultBackPressureDataSizeThreshold;
 177     }
 178
 179     public void setDefaultBackPressureDataSizeThreshold(String backPressureDataSizeThreshold) {
 180         this.defaultBackPressureDataSizeThreshold = backPressureDataSizeThreshold;
 181     }
 182 }