Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-8374 Refactor readOnly to accessMode in ApiModelProperty usages 

This closes #4945

Signed-off-by: Mike Thomsen <mthomsen@apache.org>
This commit is contained in:
Jose Luis Pedrosa 2021-03-29 15:47:28 +01:00 committed by Mike Thomsen
parent 87b561f026
commit f21c1be60f
No known key found for this signature in database
GPG Key ID: 88511C3D4CAD246F
40 changed files with 93 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/AboutDTO.java
View File

@ -109,7 +109,7 @@ public class AboutDTO {
@XmlJavaTypeAdapter(TimezoneAdapter.class) @XmlJavaTypeAdapter(TimezoneAdapter.class)
@ApiModelProperty( @ApiModelProperty(
value = "The timezone of the NiFi instance.", value = "The timezone of the NiFi instance.",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
dataType = "string" dataType = "string"
) )
public Date getTimezone() { public Date getTimezone() {

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/AccessConfigurationDTO.java
View File

@ -33,7 +33,7 @@ public class AccessConfigurationDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "Indicates whether or not this NiFi supports user login.", value = "Indicates whether or not this NiFi supports user login.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Boolean getSupportsLogin() { public Boolean getSupportsLogin() {
return supportsLogin; return supportsLogin;

6
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/AccessStatusDTO.java
View File

@ -42,7 +42,7 @@ public class AccessStatusDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The user identity.", value = "The user identity.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public String getIdentity() { public String getIdentity() {
return identity; return identity;
@ -57,7 +57,7 @@ public class AccessStatusDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The user access status.", value = "The user access status.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public String getStatus() { public String getStatus() {
return status; return status;
@ -72,7 +72,7 @@ public class AccessStatusDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "Additional details about the user access status.", value = "Additional details about the user access status.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public String getMessage() { public String getMessage() {
return message; return message;

18
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/AsynchronousRequestDTO.java
View File

@ -35,7 +35,7 @@ public abstract class AsynchronousRequestDTO<T extends UpdateStepDTO> {
private List<T> updateSteps; private List<T> updateSteps;
@ApiModelProperty(value = "The ID of the request", readOnly = true) @ApiModelProperty(value = "The ID of the request", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getRequestId() { public String getRequestId() {
return requestId; return requestId;
} }
@ -44,7 +44,7 @@ public abstract class AsynchronousRequestDTO<T extends UpdateStepDTO> {
this.requestId = requestId; this.requestId = requestId;
} }
@ApiModelProperty(value = "The URI for the request", readOnly = true) @ApiModelProperty(value = "The URI for the request", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getUri() { public String getUri() {
return uri; return uri;
} }
@ -54,7 +54,7 @@ public abstract class AsynchronousRequestDTO<T extends UpdateStepDTO> {
} }
@XmlJavaTypeAdapter(TimestampAdapter.class) @XmlJavaTypeAdapter(TimestampAdapter.class)
@ApiModelProperty(value = "The timestamp of when the request was submitted", readOnly = true) @ApiModelProperty(value = "The timestamp of when the request was submitted", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public Date getSubmissionTime() { public Date getSubmissionTime() {
return submissionTime; return submissionTime;
} }
@ -64,7 +64,7 @@ public abstract class AsynchronousRequestDTO<T extends UpdateStepDTO> {
} }
@XmlJavaTypeAdapter(TimestampAdapter.class) @XmlJavaTypeAdapter(TimestampAdapter.class)
@ApiModelProperty(value = "The timestamp of when the request was last updated", readOnly = true) @ApiModelProperty(value = "The timestamp of when the request was last updated", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public Date getLastUpdated() { public Date getLastUpdated() {
return lastUpdated; return lastUpdated;
} }
@ -73,7 +73,7 @@ public abstract class AsynchronousRequestDTO<T extends UpdateStepDTO> {
this.lastUpdated = lastUpdated; this.lastUpdated = lastUpdated;
} }
@ApiModelProperty(value = "Whether or not the request is completed", readOnly = true) @ApiModelProperty(value = "Whether or not the request is completed", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public boolean isComplete() { public boolean isComplete() {
return complete; return complete;
} }
@ -82,7 +82,7 @@ public abstract class AsynchronousRequestDTO<T extends UpdateStepDTO> {
this.complete = complete; this.complete = complete;
} }
@ApiModelProperty(value = "The reason for the request failing, or null if the request has not failed", readOnly = true) @ApiModelProperty(value = "The reason for the request failing, or null if the request has not failed", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getFailureReason() { public String getFailureReason() {
return failureReason; return failureReason;
} }
@ -91,7 +91,7 @@ public abstract class AsynchronousRequestDTO<T extends UpdateStepDTO> {
this.failureReason = failureReason; this.failureReason = failureReason;
} }
@ApiModelProperty(value = "A value between 0 and 100 (inclusive) indicating how close the request is to completion", readOnly = true) @ApiModelProperty(value = "A value between 0 and 100 (inclusive) indicating how close the request is to completion", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public int getPercentCompleted() { public int getPercentCompleted() {
return percentCompleted; return percentCompleted;
} }
@ -100,7 +100,7 @@ public abstract class AsynchronousRequestDTO<T extends UpdateStepDTO> {
this.percentCompleted = percentCompleted; this.percentCompleted = percentCompleted;
} }
@ApiModelProperty(value = "A description of the current state of the request", readOnly = true) @ApiModelProperty(value = "A description of the current state of the request", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getState() { public String getState() {
return state; return state;
} }
@ -109,7 +109,7 @@ public abstract class AsynchronousRequestDTO<T extends UpdateStepDTO> {
this.state = state; this.state = state;
} }
@ApiModelProperty(value = "The steps that are required in order to complete the request, along with the status of each", readOnly = true) @ApiModelProperty(value = "The steps that are required in order to complete the request, along with the status of each", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public List<T> getUpdateSteps() { public List<T> getUpdateSteps() {
return updateSteps; return updateSteps;
} }

4
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java
View File

@ -159,7 +159,7 @@ public class ConnectionDTO extends ComponentDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The relationships that the source of the connection currently supports.", value = "The relationships that the source of the connection currently supports.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Set<String> getAvailableRelationships() { public Set<String> getAvailableRelationships() {
return availableRelationships; return availableRelationships;
@ -271,7 +271,7 @@ public class ConnectionDTO extends ComponentDTO {
@ApiModelProperty(value = "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing " + @ApiModelProperty(value = "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing " +
"is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", "is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.",
allowableValues = LOAD_BALANCE_NOT_CONFIGURED + ", " + LOAD_BALANCE_INACTIVE + ", " + LOAD_BALANCE_ACTIVE, allowableValues = LOAD_BALANCE_NOT_CONFIGURED + ", " + LOAD_BALANCE_INACTIVE + ", " + LOAD_BALANCE_ACTIVE,
readOnly = true) accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getLoadBalanceStatus() { public String getLoadBalanceStatus() {
return loadBalanceStatus; return loadBalanceStatus;
} }

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java
View File

@ -303,7 +303,7 @@ public class ControllerServiceDTO extends ComponentDTO {
} }
@ApiModelProperty(value = "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", @ApiModelProperty(value = "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
allowableValues = VALID + ", " + INVALID + ", " + VALIDATING) allowableValues = VALID + ", " + INVALID + ", " + VALIDATING)
public String getValidationStatus() { public String getValidationStatus() {
return validationStatus; return validationStatus;

8
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowConfigurationDTO.java
View File

@ -45,7 +45,7 @@ public class FlowConfigurationDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The interval in seconds between the automatic NiFi refresh requests.", value = "The interval in seconds between the automatic NiFi refresh requests.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Long getAutoRefreshIntervalSeconds() { public Long getAutoRefreshIntervalSeconds() {
return autoRefreshIntervalSeconds; return autoRefreshIntervalSeconds;
@ -61,7 +61,7 @@ public class FlowConfigurationDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", value = "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Boolean getSupportsManagedAuthorizer() { public Boolean getSupportsManagedAuthorizer() {
return supportsManagedAuthorizer; return supportsManagedAuthorizer;
@ -76,7 +76,7 @@ public class FlowConfigurationDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "Whether this NiFi supports configurable users and groups.", value = "Whether this NiFi supports configurable users and groups.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Boolean getSupportsConfigurableUsersAndGroups() { public Boolean getSupportsConfigurableUsersAndGroups() {
return supportsConfigurableUsersAndGroups; return supportsConfigurableUsersAndGroups;
@ -91,7 +91,7 @@ public class FlowConfigurationDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "Whether this NiFi supports a configurable authorizer.", value = "Whether this NiFi supports a configurable authorizer.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Boolean getSupportsConfigurableAuthorizer() { public Boolean getSupportsConfigurableAuthorizer() {
return supportsConfigurableAuthorizer; return supportsConfigurableAuthorizer;

14
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowUpdateRequestDTO.java
View File

@ -42,7 +42,7 @@ public abstract class FlowUpdateRequestDTO {
this.processGroupId = processGroupId; this.processGroupId = processGroupId;
} }
@ApiModelProperty(value = "The unique ID of this request.", readOnly = true) @ApiModelProperty(value = "The unique ID of this request.", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getRequestId() { public String getRequestId() {
return requestId; return requestId;
} }
@ -51,7 +51,7 @@ public abstract class FlowUpdateRequestDTO {
this.requestId = requestId; this.requestId = requestId;
} }
@ApiModelProperty(value = "The URI for future requests to this drop request.", readOnly = true) @ApiModelProperty(value = "The URI for future requests to this drop request.", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getUri() { public String getUri() {
return uri; return uri;
} }
@ -61,7 +61,7 @@ public abstract class FlowUpdateRequestDTO {
} }
@XmlJavaTypeAdapter(TimestampAdapter.class) @XmlJavaTypeAdapter(TimestampAdapter.class)
@ApiModelProperty(value = "The last time this request was updated.", dataType = "string", readOnly = true) @ApiModelProperty(value = "The last time this request was updated.", dataType = "string", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public Date getLastUpdated() { public Date getLastUpdated() {
return lastUpdated; return lastUpdated;
} }
@ -70,7 +70,7 @@ public abstract class FlowUpdateRequestDTO {
this.lastUpdated = lastUpdated; this.lastUpdated = lastUpdated;
} }
@ApiModelProperty(value = "Whether or not this request has completed", readOnly = true) @ApiModelProperty(value = "Whether or not this request has completed", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public boolean isComplete() { public boolean isComplete() {
return complete; return complete;
} }
@ -79,7 +79,7 @@ public abstract class FlowUpdateRequestDTO {
this.complete = complete; this.complete = complete;
} }
@ApiModelProperty(value = "An explanation of why this request failed, or null if this request has not failed", readOnly = true) @ApiModelProperty(value = "An explanation of why this request failed, or null if this request has not failed", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getFailureReason() { public String getFailureReason() {
return failureReason; return failureReason;
} }
@ -88,7 +88,7 @@ public abstract class FlowUpdateRequestDTO {
this.failureReason = reason; this.failureReason = reason;
} }
@ApiModelProperty(value = "The state of the request", readOnly = true) @ApiModelProperty(value = "The state of the request", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getState() { public String getState() {
return state; return state;
} }
@ -97,7 +97,7 @@ public abstract class FlowUpdateRequestDTO {
this.state = state; this.state = state;
} }
@ApiModelProperty(value = "The percentage complete for the request, between 0 and 100", readOnly = true) @ApiModelProperty(value = "The percentage complete for the request, between 0 and 100", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public int getPercentCompleted() { public int getPercentCompleted() {
return percentCompleted; return percentCompleted;
} }

20
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeDTO.java
View File

@ -49,7 +49,7 @@ public class NodeDTO {
@XmlJavaTypeAdapter(DateTimeAdapter.class) @XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty( @ApiModelProperty(
value = "the time of the nodes's last heartbeat.", value = "the time of the nodes's last heartbeat.",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
dataType = "string" dataType = "string"
) )
public Date getHeartbeat() { public Date getHeartbeat() {
@ -66,7 +66,7 @@ public class NodeDTO {
@XmlJavaTypeAdapter(DateTimeAdapter.class) @XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty( @ApiModelProperty(
value = "The time of the node's last connection request.", value = "The time of the node's last connection request.",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
dataType = "string" dataType = "string"
) )
public Date getConnectionRequested() { public Date getConnectionRequested() {
@ -84,7 +84,7 @@ public class NodeDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The active threads for the NiFi on the node.", value = "The active threads for the NiFi on the node.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Integer getActiveThreadCount() { public Integer getActiveThreadCount() {
return activeThreadCount; return activeThreadCount;
@ -99,7 +99,7 @@ public class NodeDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The queue the NiFi on the node.", value = "The queue the NiFi on the node.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public String getQueued() { public String getQueued() {
return queued; return queued;
@ -114,7 +114,7 @@ public class NodeDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The node's host/ip address.", value = "The node's host/ip address.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public String getAddress() { public String getAddress() {
return address; return address;
@ -129,7 +129,7 @@ public class NodeDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The id of the node.", value = "The id of the node.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public String getNodeId() { public String getNodeId() {
return nodeId; return nodeId;
@ -144,7 +144,7 @@ public class NodeDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The port the node is listening for API requests.", value = "The port the node is listening for API requests.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Integer getApiPort() { public Integer getApiPort() {
return apiPort; return apiPort;
@ -173,7 +173,7 @@ public class NodeDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The node's events.", value = "The node's events.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public List<NodeEventDTO> getEvents() { public List<NodeEventDTO> getEvents() {
return events; return events;
@ -188,7 +188,7 @@ public class NodeDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The roles of this node.", value = "The roles of this node.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Set<String> getRoles() { public Set<String> getRoles() {
return roles; return roles;
@ -204,7 +204,7 @@ public class NodeDTO {
@XmlJavaTypeAdapter(DateTimeAdapter.class) @XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty( @ApiModelProperty(
value = "The time at which this Node was last refreshed.", value = "The time at which this Node was last refreshed.",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
dataType = "string" dataType = "string"
) )
public Date getNodeStartTime() { public Date getNodeStartTime() {

4
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ParameterContextDTO.java
View File

@ -35,7 +35,7 @@ public class ParameterContextDTO {
this.identifier = id; this.identifier = id;
} }
@ApiModelProperty(value = "The ID the Parameter Context.", readOnly = true) @ApiModelProperty(value = "The ID the Parameter Context.", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getId() { public String getId() {
return identifier; return identifier;
} }
@ -71,7 +71,7 @@ public class ParameterContextDTO {
this.boundProcessGroups = boundProcessGroups; this.boundProcessGroups = boundProcessGroups;
} }
@ApiModelProperty(value = "The Process Groups that are bound to this Parameter Context", readOnly = true) @ApiModelProperty(value = "The Process Groups that are bound to this Parameter Context", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public Set<ProcessGroupEntity> getBoundProcessGroups() { public Set<ProcessGroupEntity> getBoundProcessGroups() {
return boundProcessGroups; return boundProcessGroups;
} }

5
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ParameterContextUpdateRequestDTO.java
View File

@ -27,7 +27,8 @@ public class ParameterContextUpdateRequestDTO extends AsynchronousRequestDTO<Par
private ParameterContextDTO parameterContext; private ParameterContextDTO parameterContext;
private Set<AffectedComponentEntity> referencingComponents; private Set<AffectedComponentEntity> referencingComponents;
@ApiModelProperty(value = "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", readOnly = true) @ApiModelProperty(value = "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.",
accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public ParameterContextDTO getParameterContext() { public ParameterContextDTO getParameterContext() {
return parameterContext; return parameterContext;
} }
@ -36,7 +37,7 @@ public class ParameterContextUpdateRequestDTO extends AsynchronousRequestDTO<Par
this.parameterContext = parameterContext; this.parameterContext = parameterContext;
} }
@ApiModelProperty(value = "The components that are referenced by the update.", readOnly = true) @ApiModelProperty(value = "The components that are referenced by the update.", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public Set<AffectedComponentEntity> getReferencingComponents() { public Set<AffectedComponentEntity> getReferencingComponents() {
return referencingComponents; return referencingComponents;
} }

3
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ParameterContextValidationRequestDTO.java
View File

@ -26,7 +26,8 @@ public class ParameterContextValidationRequestDTO extends AsynchronousRequestDTO
private ParameterContextDTO parameterContext; private ParameterContextDTO parameterContext;
private ComponentValidationResultsEntity componentValidationResults; private ComponentValidationResultsEntity componentValidationResults;
@ApiModelProperty(value = "The Validation Results that were calculated for each component. This value may not be set until the request completes.", readOnly = true) @ApiModelProperty(value = "The Validation Results that were calculated for each component. This value may not be set until the request completes.",
accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public ComponentValidationResultsEntity getComponentValidationResults() { public ComponentValidationResultsEntity getComponentValidationResults() {
return componentValidationResults; return componentValidationResults;
} }

4
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PermissionsDTO.java
View File

@ -34,7 +34,7 @@ public class PermissionsDTO implements ReadablePermission, WritablePermission {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "Indicates whether the user can read a given resource.", value = "Indicates whether the user can read a given resource.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
@Override @Override
public Boolean getCanRead() { public Boolean getCanRead() {
@ -51,7 +51,7 @@ public class PermissionsDTO implements ReadablePermission, WritablePermission {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "Indicates whether the user can write a given resource.", value = "Indicates whether the user can write a given resource.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
@Override @Override
public Boolean getCanWrite() { public Boolean getCanWrite() {

6
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessGroupDTO.java
View File

@ -111,7 +111,7 @@ public class ProcessGroupDTO extends ComponentDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The number of input ports in the process group.", value = "The number of input ports in the process group.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Integer getInputPortCount() { public Integer getInputPortCount() {
return NumberUtil.sumNullableIntegers(localInputPortCount, publicInputPortCount); return NumberUtil.sumNullableIntegers(localInputPortCount, publicInputPortCount);
@ -171,7 +171,7 @@ public class ProcessGroupDTO extends ComponentDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The number of output ports in the process group.", value = "The number of output ports in the process group.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Integer getOutputPortCount() { public Integer getOutputPortCount() {
return NumberUtil.sumNullableIntegers(localOutputPortCount, publicOutputPortCount); return NumberUtil.sumNullableIntegers(localOutputPortCount, publicOutputPortCount);
@ -327,7 +327,7 @@ public class ProcessGroupDTO extends ComponentDTO {
@ApiModelProperty(value = "The variables that are configured for the Process Group. Note that this map contains only " @ApiModelProperty(value = "The variables that are configured for the Process Group. Note that this map contains only "
+ "those variables that are defined on this Process Group and not any variables that are defined in the parent " + "those variables that are defined on this Process Group and not any variables that are defined in the parent "
+ "Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this " + "Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this "
+ "Process Group by rather only the variables that are defined for this Process Group itself.", readOnly = true) + "Process Group by rather only the variables that are defined for this Process Group itself.", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public Map<String, String> getVariables() { public Map<String, String> getVariables() {
return variables; return variables;
} }

4
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorDTO.java
View File

@ -269,7 +269,7 @@ public class ProcessorDTO extends ComponentDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The available relationships that the processor currently supports.", value = "The available relationships that the processor currently supports.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public List<RelationshipDTO> getRelationships() { public List<RelationshipDTO> getRelationships() {
return relationships; return relationships;
@ -312,7 +312,7 @@ public class ProcessorDTO extends ComponentDTO {
} }
@ApiModelProperty(value = "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", @ApiModelProperty(value = "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
allowableValues = VALID + ", " + INVALID + ", " + VALIDATING) allowableValues = VALID + ", " + INVALID + ", " + VALIDATING)
public String getValidationStatus() { public String getValidationStatus() {
return validationStatus; return validationStatus;

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReadablePermission.java
View File

@ -21,7 +21,7 @@ import io.swagger.annotations.ApiModelProperty;
public interface ReadablePermission { public interface ReadablePermission {
@ApiModelProperty( @ApiModelProperty(
value = "Indicates whether the user can read a given resource.", value = "Indicates whether the user can read a given resource.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
Boolean getCanRead(); Boolean getCanRead();

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReportingTaskDTO.java
View File

@ -303,7 +303,7 @@ public class ReportingTaskDTO extends ComponentDTO {
} }
@ApiModelProperty(value = "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", @ApiModelProperty(value = "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
allowableValues = VALID + ", " + INVALID + ", " + VALIDATING) allowableValues = VALID + ", " + INVALID + ", " + VALIDATING)
public String getValidationStatus() { public String getValidationStatus() {
return validationStatus; return validationStatus;

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RevisionDTO.java
View File

@ -71,7 +71,7 @@ public class RevisionDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The user that last modified the flow.", value = "The user that last modified the flow.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public String getLastModifier() { public String getLastModifier() {
return lastModifier; return lastModifier;

6
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UpdateStepDTO.java
View File

@ -23,7 +23,7 @@ public abstract class UpdateStepDTO {
private boolean complete; private boolean complete;
private String failureReason; private String failureReason;
@ApiModelProperty(value = "Explanation of what happens in this step", readOnly = true) @ApiModelProperty(value = "Explanation of what happens in this step", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getDescription() { public String getDescription() {
return description; return description;
} }
@ -32,7 +32,7 @@ public abstract class UpdateStepDTO {
this.description = description; this.description = description;
} }
@ApiModelProperty(value = "Whether or not this step has completed", readOnly = true) @ApiModelProperty(value = "Whether or not this step has completed", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public boolean isComplete() { public boolean isComplete() {
return complete; return complete;
} }
@ -41,7 +41,7 @@ public abstract class UpdateStepDTO {
this.complete = complete; this.complete = complete;
} }
@ApiModelProperty(value = "An explanation of why this step failed, or null if this step did not fail", readOnly = true) @ApiModelProperty(value = "An explanation of why this step failed, or null if this step did not fail", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getFailureReason() { public String getFailureReason() {
return failureReason; return failureReason;
} }

4
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserDTO.java
View File

@ -37,7 +37,7 @@ public class UserDTO extends TenantDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The groups to which the user belongs. This field is read only and it provided for convenience.", value = "The groups to which the user belongs. This field is read only and it provided for convenience.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Set<TenantEntity> getUserGroups() { public Set<TenantEntity> getUserGroups() {
return userGroups; return userGroups;
@ -52,7 +52,7 @@ public class UserDTO extends TenantDTO {
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The access policies this user belongs to.", value = "The access policies this user belongs to.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Set<AccessPolicySummaryEntity> getAccessPolicies() { public Set<AccessPolicySummaryEntity> getAccessPolicies() {
return accessPolicies; return accessPolicies;

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserGroupDTO.java
View File

@ -51,7 +51,7 @@ public class UserGroupDTO extends TenantDTO {
value = "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For " value = "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For "
+ "compatibility reasons the field will remain of this type, however only the fields that are present in the " + "compatibility reasons the field will remain of this type, however only the fields that are present in the "
+ "AccessPolicySummaryEntity will be populated here.", + "AccessPolicySummaryEntity will be populated here.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Set<AccessPolicyEntity> getAccessPolicies() { public Set<AccessPolicyEntity> getAccessPolicies() {
return accessPolicies; return accessPolicies;

4
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/VariableDTO.java
View File

@ -48,7 +48,7 @@ public class VariableDTO {
this.value = value; this.value = value;
} }
@ApiModelProperty(value = "The ID of the Process Group where this Variable is defined", readOnly = true) @ApiModelProperty(value = "The ID of the Process Group where this Variable is defined", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getProcessGroupId() { public String getProcessGroupId() {
return processGroupId; return processGroupId;
} }
@ -57,7 +57,7 @@ public class VariableDTO {
this.processGroupId = groupId; this.processGroupId = groupId;
} }
@ApiModelProperty(value = "A set of all components that will be affected if the value of this variable is changed", readOnly = true) @ApiModelProperty(value = "A set of all components that will be affected if the value of this variable is changed", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public Set<AffectedComponentEntity> getAffectedComponents() { public Set<AffectedComponentEntity> getAffectedComponents() {
return affectedComponents; return affectedComponents;
} }

3
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/VariableRegistryUpdateRequestDTO.java
View File

@ -37,7 +37,8 @@ public class VariableRegistryUpdateRequestDTO extends AsynchronousRequestDTO<Var
this.processGroupId = processGroupId; this.processGroupId = processGroupId;
} }
@ApiModelProperty(value = "A set of all components that will be affected if the value of this variable is changed", readOnly = true) @ApiModelProperty(value = "A set of all components that will be affected if the value of this variable is changed",
accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public Set<AffectedComponentEntity> getAffectedComponents() { public Set<AffectedComponentEntity> getAffectedComponents() {
return affectedComponents; return affectedComponents;
} }

8
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/VersionControlInformationDTO.java
View File

@ -53,7 +53,7 @@ public class VersionControlInformationDTO {
this.registryId = registryId; this.registryId = registryId;
} }
@ApiModelProperty(value = "The name of the registry that the flow is stored in", readOnly = true) @ApiModelProperty(value = "The name of the registry that the flow is stored in", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getRegistryName() { public String getRegistryName() {
return registryName; return registryName;
} }
@ -71,7 +71,7 @@ public class VersionControlInformationDTO {
this.bucketId = bucketId; this.bucketId = bucketId;
} }
@ApiModelProperty(value = "The name of the bucket that the flow is stored in", readOnly = true) @ApiModelProperty(value = "The name of the bucket that the flow is stored in", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public String getBucketName() { public String getBucketName() {
return bucketName; return bucketName;
} }
@ -116,7 +116,7 @@ public class VersionControlInformationDTO {
this.version = version; this.version = version;
} }
@ApiModelProperty(readOnly = true, @ApiModelProperty(accessMode = ApiModelProperty.AccessMode.READ_ONLY,
value = "The current state of the Process Group, as it relates to the Versioned Flow", value = "The current state of the Process Group, as it relates to the Versioned Flow",
allowableValues = "LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE") allowableValues = "LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE")
public String getState() { public String getState() {
@ -127,7 +127,7 @@ public class VersionControlInformationDTO {
this.state = state; this.state = state;
} }
@ApiModelProperty(readOnly = true, value = "Explanation of why the group is in the specified state") @ApiModelProperty(accessMode = ApiModelProperty.AccessMode.READ_ONLY, value = "Explanation of why the group is in the specified state")
public String getStateExplanation() { public String getStateExplanation() {
return stateExplanation; return stateExplanation;
} }

3
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/VersionedFlowUpdateRequestDTO.java
View File

@ -25,7 +25,8 @@ import javax.xml.bind.annotation.XmlType;
public class VersionedFlowUpdateRequestDTO extends FlowUpdateRequestDTO { public class VersionedFlowUpdateRequestDTO extends FlowUpdateRequestDTO {
private VersionControlInformationDTO versionControlInformation; private VersionControlInformationDTO versionControlInformation;
@ApiModelProperty(value = "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", readOnly = true) @ApiModelProperty(value = "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.",
accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public VersionControlInformationDTO getVersionControlInformation() { public VersionControlInformationDTO getVersionControlInformation() {
return versionControlInformation; return versionControlInformation;
} }

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/WritablePermission.java
View File

@ -21,7 +21,7 @@ import io.swagger.annotations.ApiModelProperty;
public interface WritablePermission { public interface WritablePermission {
@ApiModelProperty( @ApiModelProperty(
value = "Indicates whether the user can write a given resource.", value = "Indicates whether the user can write a given resource.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
Boolean getCanWrite(); Boolean getCanWrite();

7
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/diagnostics/ConnectionDiagnosticsDTO.java
View File

@ -28,7 +28,7 @@ public class ConnectionDiagnosticsDTO {
private ConnectionDiagnosticsSnapshotDTO aggregateSnapshot; private ConnectionDiagnosticsSnapshotDTO aggregateSnapshot;
private List<ConnectionDiagnosticsSnapshotDTO> nodeSnapshots; private List<ConnectionDiagnosticsSnapshotDTO> nodeSnapshots;
@ApiModelProperty(value = "Details about the connection", readOnly = true) @ApiModelProperty(value = "Details about the connection", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public ConnectionDTO getConnection() { public ConnectionDTO getConnection() {
return connection; return connection;
} }
@ -37,7 +37,8 @@ public class ConnectionDiagnosticsDTO {
this.connection = connection; this.connection = connection;
} }
@ApiModelProperty(value = "Aggregate values for all nodes in the cluster, or for this instance if not clustered", readOnly = true) @ApiModelProperty(value = "Aggregate values for all nodes in the cluster, or for this instance if not clustered",
accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public ConnectionDiagnosticsSnapshotDTO getAggregateSnapshot() { public ConnectionDiagnosticsSnapshotDTO getAggregateSnapshot() {
return aggregateSnapshot; return aggregateSnapshot;
} }
@ -46,7 +47,7 @@ public class ConnectionDiagnosticsDTO {
this.aggregateSnapshot = aggregateSnapshot; this.aggregateSnapshot = aggregateSnapshot;
} }
@ApiModelProperty(value = "A list of values for each node in the cluster, if clustered.", readOnly = true) @ApiModelProperty(value = "A list of values for each node in the cluster, if clustered.", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public List<ConnectionDiagnosticsSnapshotDTO> getNodeSnapshots() { public List<ConnectionDiagnosticsSnapshotDTO> getNodeSnapshots() {
return nodeSnapshots; return nodeSnapshots;
} }

4
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ComponentStatusDTO.java
View File

@ -43,7 +43,7 @@ public class ComponentStatusDTO{
* @return the run status of the component * @return the run status of the component
*/ */
@ApiModelProperty(value = "The run status of this component", @ApiModelProperty(value = "The run status of this component",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
allowableValues = "ENABLED, ENABLING, DISABLED, DISABLING") allowableValues = "ENABLED, ENABLING, DISABLED, DISABLING")
public String getRunStatus() { public String getRunStatus() {
return runStatus; return runStatus;
@ -55,7 +55,7 @@ public class ComponentStatusDTO{
@ApiModelProperty(value = "Indicates whether the component is valid, invalid, or still in the process of validating" + @ApiModelProperty(value = "Indicates whether the component is valid, invalid, or still in the process of validating" +
" (i.e., it is unknown whether or not the component is valid)", " (i.e., it is unknown whether or not the component is valid)",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
allowableValues = VALID + ", " + INVALID + ", " + VALIDATING) allowableValues = VALID + ", " + INVALID + ", " + VALIDATING)
public String getValidationStatus() { public String getValidationStatus() {
return validationStatus; return validationStatus;

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ControllerServiceStatusDTO.java
View File

@ -28,7 +28,7 @@ import javax.xml.bind.annotation.XmlType;
public class ControllerServiceStatusDTO extends ComponentStatusDTO { public class ControllerServiceStatusDTO extends ComponentStatusDTO {
@ApiModelProperty(value = "The run status of this ControllerService", @ApiModelProperty(value = "The run status of this ControllerService",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
allowableValues = "ENABLED, ENABLING, DISABLED, DISABLING") allowableValues = "ENABLED, ENABLING, DISABLED, DISABLING")
@Override @Override
public String getRunStatus() { public String getRunStatus() {

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessGroupStatusSnapshotDTO.java
View File

@ -105,7 +105,7 @@ public class ProcessGroupStatusSnapshotDTO implements Cloneable {
this.name = name; this.name = name;
} }
@ApiModelProperty(readOnly = true, @ApiModelProperty(accessMode = ApiModelProperty.AccessMode.READ_ONLY,
value = "The current state of the Process Group, as it relates to the Versioned Flow", value = "The current state of the Process Group, as it relates to the Versioned Flow",
allowableValues = "LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE") allowableValues = "LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE")
public String getVersionedFlowState() { public String getVersionedFlowState() {

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemoteProcessGroupStatusDTO.java
View File

@ -123,7 +123,7 @@ public class RemoteProcessGroupStatusDTO {
@ApiModelProperty(value = "Indicates whether the component is valid, invalid, or still in the process of validating" + @ApiModelProperty(value = "Indicates whether the component is valid, invalid, or still in the process of validating" +
" (i.e., it is unknown whether or not the component is valid)", " (i.e., it is unknown whether or not the component is valid)",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
allowableValues = "VALID, INVALID, VALIDATING") allowableValues = "VALID, INVALID, VALIDATING")
public String getValidationStatus() { public String getValidationStatus() {
return validationStatus; return validationStatus;

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ReportingTaskStatusDTO.java
View File

@ -28,7 +28,7 @@ import javax.xml.bind.annotation.XmlType;
public class ReportingTaskStatusDTO extends ComponentStatusDTO { public class ReportingTaskStatusDTO extends ComponentStatusDTO {
@ApiModelProperty(value = "The run status of this ReportingTask", @ApiModelProperty(value = "The run status of this ReportingTask",
readOnly = true, accessMode = ApiModelProperty.AccessMode.READ_ONLY,
allowableValues = "RUNNING, STOPPED, DISABLED") allowableValues = "RUNNING, STOPPED, DISABLED")
@Override @Override
public String getRunStatus() { public String getRunStatus() {

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceEntity.java
View File

@ -80,7 +80,7 @@ public class ControllerServiceEntity extends ComponentEntity implements Permissi
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The status for this ControllerService.", value = "The status for this ControllerService.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public ControllerServiceStatusDTO getStatus() { public ControllerServiceStatusDTO getStatus() {
return status; return status;

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FlowBreadcrumbEntity.java
View File

@ -98,7 +98,7 @@ public class FlowBreadcrumbEntity extends Entity {
this.parentBreadcrumb = parentBreadcrumb; this.parentBreadcrumb = parentBreadcrumb;
} }
@ApiModelProperty(readOnly = true, @ApiModelProperty(accessMode = ApiModelProperty.AccessMode.READ_ONLY,
value = "The current state of the Process Group, as it relates to the Versioned Flow", value = "The current state of the Process Group, as it relates to the Versioned Flow",
allowableValues = "LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE") allowableValues = "LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE")
public String getVersionedFlowState() { public String getVersionedFlowState() {

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ParameterContextsEntity.java
View File

@ -42,7 +42,7 @@ public class ParameterContextsEntity extends Entity {
@ApiModelProperty( @ApiModelProperty(
value = "The current time on the system.", value = "The current time on the system.",
dataType = "string", dataType = "string",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Date getCurrentTime() { public Date getCurrentTime() {
return currentTime; return currentTime;

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ParameterEntity.java
View File

@ -37,7 +37,7 @@ public class ParameterEntity extends Entity implements WritablePermission {
} }
@Override @Override
@ApiModelProperty(value = "Indicates whether the user can write a given resource.", readOnly = true) @ApiModelProperty(value = "Indicates whether the user can write a given resource.", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public Boolean getCanWrite() { public Boolean getCanWrite() {
return canWrite; return canWrite;
} }

8
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupEntity.java
View File

@ -90,7 +90,7 @@ public class ProcessGroupEntity extends ComponentEntity implements Permissible<P
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The number of input ports in the process group.", value = "The number of input ports in the process group.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Integer getInputPortCount() { public Integer getInputPortCount() {
return NumberUtil.sumNullableIntegers(localInputPortCount, publicInputPortCount); return NumberUtil.sumNullableIntegers(localInputPortCount, publicInputPortCount);
@ -147,7 +147,7 @@ public class ProcessGroupEntity extends ComponentEntity implements Permissible<P
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The number of output ports in the process group.", value = "The number of output ports in the process group.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public Integer getOutputPortCount() { public Integer getOutputPortCount() {
return NumberUtil.sumNullableIntegers(localOutputPortCount, publicOutputPortCount); return NumberUtil.sumNullableIntegers(localOutputPortCount, publicOutputPortCount);
@ -255,7 +255,7 @@ public class ProcessGroupEntity extends ComponentEntity implements Permissible<P
this.inactiveRemotePortCount = inactiveRemotePortCount; this.inactiveRemotePortCount = inactiveRemotePortCount;
} }
@ApiModelProperty(value = "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", readOnly = true) @ApiModelProperty(value = "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public VersionedFlowSnapshot getVersionedFlowSnapshot() { public VersionedFlowSnapshot getVersionedFlowSnapshot() {
return versionedFlowSnapshot; return versionedFlowSnapshot;
} }
@ -264,7 +264,7 @@ public class ProcessGroupEntity extends ComponentEntity implements Permissible<P
this.versionedFlowSnapshot = versionedFlowSnapshot; this.versionedFlowSnapshot = versionedFlowSnapshot;
} }
@ApiModelProperty(readOnly = true, @ApiModelProperty(accessMode = ApiModelProperty.AccessMode.READ_ONLY,
value = "The current state of the Process Group, as it relates to the Versioned Flow", value = "The current state of the Process Group, as it relates to the Versioned Flow",
allowableValues = "LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE") allowableValues = "LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE")
public String getVersionedFlowState() { public String getVersionedFlowState() {

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupReplaceRequestEntity.java
View File

@ -30,7 +30,7 @@ import javax.xml.bind.annotation.XmlRootElement;
public class ProcessGroupReplaceRequestEntity extends FlowUpdateRequestEntity<ProcessGroupReplaceRequestDTO> { public class ProcessGroupReplaceRequestEntity extends FlowUpdateRequestEntity<ProcessGroupReplaceRequestDTO> {
private VersionedFlowSnapshot versionedFlowSnapshot; private VersionedFlowSnapshot versionedFlowSnapshot;
@ApiModelProperty(value = "Returns the Versioned Flow to replace with", readOnly = true) @ApiModelProperty(value = "Returns the Versioned Flow to replace with", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public VersionedFlowSnapshot getVersionedFlowSnapshot() { public VersionedFlowSnapshot getVersionedFlowSnapshot() {
return versionedFlowSnapshot; return versionedFlowSnapshot;
} }

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTaskEntity.java
View File

@ -68,7 +68,7 @@ public class ReportingTaskEntity extends ComponentEntity implements Permissible<
*/ */
@ApiModelProperty( @ApiModelProperty(
value = "The status for this ReportingTask.", value = "The status for this ReportingTask.",
readOnly = true accessMode = ApiModelProperty.AccessMode.READ_ONLY
) )
public ReportingTaskStatusDTO getStatus() { public ReportingTaskStatusDTO getStatus() {
return status; return status;

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/VariableEntity.java
View File

@ -28,7 +28,7 @@ public class VariableEntity extends Entity implements WritablePermission {
private Boolean canWrite; private Boolean canWrite;
@Override @Override
@ApiModelProperty(value = "Indicates whether the user can write a given resource.", readOnly = true) @ApiModelProperty(value = "Indicates whether the user can write a given resource.", accessMode = ApiModelProperty.AccessMode.READ_ONLY)
public Boolean getCanWrite() { public Boolean getCanWrite() {
return canWrite; return canWrite;
} }