org.apache.nifi.web.api.dto

Class ControllerServiceDTO

java.lang.Object

org.apache.nifi.web.api.dto.ComponentDTO

org.apache.nifi.web.api.dto.ControllerServiceDTO

public class ControllerServiceDTO
extends ComponentDTO

A Controller Service that can be shared by other components

Field Summary

Fields

Modifier and Type	Field and Description
private String	annotationData
private String	bulletinLevel
private BundleDTO	bundle
private String	comments
private List<ControllerServiceApiDTO>	controllerServiceApis
private String	customUiUrl
private Boolean	deprecated
private Map<String,PropertyDescriptorDTO>	descriptors
static String	INVALID
private Boolean	isExtensionMissing
private Boolean	multipleVersionsAvailable
private String	name
private Boolean	persistsState
private Map<String,String>	properties
private Set<ControllerServiceReferencingComponentEntity>	referencingComponents
private Boolean	restricted
private Set<String>	sensitiveDynamicPropertyNames
private String	state
private Boolean	supportsSensitiveDynamicProperties
private String	type
static String	VALID
static String	VALIDATING
private Collection<String>	validationErrors
private String	validationStatus

Constructor Summary

Constructors

Constructor and Description
ControllerServiceDTO()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAnnotationData()
String	getBulletinLevel()
BundleDTO	getBundle() The details of the artifact that bundled this controller service type.
String	getComments()
List<ControllerServiceApiDTO>	getControllerServiceApis() Lists the APIs this Controller Service implements.
String	getCustomUiUrl()
Boolean	getDeprecated()
Map<String,PropertyDescriptorDTO>	getDescriptors()
Boolean	getExtensionMissing()
Boolean	getMultipleVersionsAvailable()
String	getName()
Boolean	getPersistsState()
Map<String,String>	getProperties()
Set<ControllerServiceReferencingComponentEntity>	getReferencingComponents()
Boolean	getRestricted()
Set<String>	getSensitiveDynamicPropertyNames()
String	getState()
Boolean	getSupportsSensitiveDynamicProperties()
String	getType()
Collection<String>	getValidationErrors() Gets the validation errors from this controller service.
String	getValidationStatus()
int	hashCode()
void	setAnnotationData(String annotationData)
void	setBulletinLevel(String bulletinLevel)
void	setBundle(BundleDTO bundle)
void	setComments(String comments)
void	setControllerServiceApis(List<ControllerServiceApiDTO> controllerServiceApis)
void	setCustomUiUrl(String customUiUrl)
void	setDeprecated(Boolean deprecated)
void	setDescriptors(Map<String,PropertyDescriptorDTO> descriptors)
void	setExtensionMissing(Boolean extensionMissing)
void	setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)
void	setName(String name)
void	setPersistsState(Boolean persistsState)
void	setProperties(Map<String,String> properties)
void	setReferencingComponents(Set<ControllerServiceReferencingComponentEntity> referencingComponents)
void	setRestricted(Boolean restricted)
void	setSensitiveDynamicPropertyNames(Set<String> sensitiveDynamicPropertyNames)
void	setState(String state)
void	setSupportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)
void	setType(String type)
void	setValidationErrors(Collection<String> validationErrors)
void	setValidationStatus(String validationStatus)

Methods inherited from class org.apache.nifi.web.api.dto.ComponentDTO

getId, getParentGroupId, getPosition, getVersionedComponentId, setId, setParentGroupId, setPosition, setVersionedComponentId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

VALID

public static final String VALID

See Also:

Constant Field Values

INVALID

public static final String INVALID

See Also:

Constant Field Values

VALIDATING

public static final String VALIDATING

See Also:

Constant Field Values

name

private String name

type

private String type

bundle

private BundleDTO bundle

controllerServiceApis

private List<ControllerServiceApiDTO> controllerServiceApis

comments

private String comments

state

private String state

persistsState

private Boolean persistsState

restricted

private Boolean restricted

deprecated

private Boolean deprecated

isExtensionMissing

private Boolean isExtensionMissing

multipleVersionsAvailable

private Boolean multipleVersionsAvailable

supportsSensitiveDynamicProperties

private Boolean supportsSensitiveDynamicProperties

properties

private Map<String,String> properties

descriptors

private Map<String,PropertyDescriptorDTO> descriptors

sensitiveDynamicPropertyNames

private Set<String> sensitiveDynamicPropertyNames

customUiUrl

private String customUiUrl

annotationData

private String annotationData

referencingComponents

private Set<ControllerServiceReferencingComponentEntity> referencingComponents

validationErrors

private Collection<String> validationErrors

validationStatus

private String validationStatus

bulletinLevel

private String bulletinLevel

Constructor Detail

ControllerServiceDTO

public ControllerServiceDTO()

Method Detail

getName

public String getName()

Returns:

controller service name

setName

public void setName(String name)

getType

public String getType()

Returns:

the controller service type

setType

public void setType(String type)

getBundle

public BundleDTO getBundle()

The details of the artifact that bundled this controller service type.

Returns:

The bundle details

setBundle

public void setBundle(BundleDTO bundle)

getControllerServiceApis

public List<ControllerServiceApiDTO> getControllerServiceApis()

Lists the APIs this Controller Service implements.

Returns:

The listing of implemented APIs

setControllerServiceApis

public void setControllerServiceApis(List<ControllerServiceApiDTO> controllerServiceApis)

getComments

public String getComments()

Returns:

the comment for the Controller Service

setComments

public void setComments(String comments)

getBulletinLevel

public String getBulletinLevel()

Returns:

the level at which this controller service will report bulletins

setBulletinLevel

public void setBulletinLevel(String bulletinLevel)

getPersistsState

public Boolean getPersistsState()

Returns:

whether this controller service persists state

setPersistsState

public void setPersistsState(Boolean persistsState)

getRestricted

public Boolean getRestricted()

Returns:

whether this controller service requires elevated privileges

setRestricted

public void setRestricted(Boolean restricted)

getDeprecated

public Boolean getDeprecated()

Returns:

Whether the controller service has been deprecated.

setDeprecated

public void setDeprecated(Boolean deprecated)

getExtensionMissing

public Boolean getExtensionMissing()

Returns:

whether the underlying extension is missing

setExtensionMissing

public void setExtensionMissing(Boolean extensionMissing)

getMultipleVersionsAvailable

public Boolean getMultipleVersionsAvailable()

Returns:

whether this controller service has multiple versions available

setMultipleVersionsAvailable

public void setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)

getSupportsSensitiveDynamicProperties

public Boolean getSupportsSensitiveDynamicProperties()

Returns:

whether this controller service supports sensitive dynamic properties

setSupportsSensitiveDynamicProperties

public void setSupportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)

getState

public String getState()

Returns:

The state of this controller service. Possible values are ENABLED, ENABLING, DISABLED, DISABLING

setState

public void setState(String state)

getProperties

public Map<String,String> getProperties()

Returns:

controller service properties

setProperties

public void setProperties(Map<String,String> properties)

getDescriptors

public Map<String,PropertyDescriptorDTO> getDescriptors()

Returns:

descriptors for the controller service properties

setDescriptors

public void setDescriptors(Map<String,PropertyDescriptorDTO> descriptors)

getSensitiveDynamicPropertyNames

public Set<String> getSensitiveDynamicPropertyNames()

Returns:

Set of sensitive dynamic property names

setSensitiveDynamicPropertyNames

public void setSensitiveDynamicPropertyNames(Set<String> sensitiveDynamicPropertyNames)

getCustomUiUrl

public String getCustomUiUrl()

Returns:

the URL for this controller services custom configuration UI if applicable. Null otherwise

setCustomUiUrl

public void setCustomUiUrl(String customUiUrl)

getAnnotationData

public String getAnnotationData()

Returns:

annotation data for this controller service

setAnnotationData

public void setAnnotationData(String annotationData)

getReferencingComponents

public Set<ControllerServiceReferencingComponentEntity> getReferencingComponents()

Returns:

all components referencing this controller service

setReferencingComponents

public void setReferencingComponents(Set<ControllerServiceReferencingComponentEntity> referencingComponents)

getValidationErrors

public Collection<String> getValidationErrors()

Gets the validation errors from this controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.

Returns:

The validation errors

setValidationErrors

public void setValidationErrors(Collection<String> validationErrors)

getValidationStatus

public String getValidationStatus()

setValidationStatus

public void setValidationStatus(String validationStatus)

hashCode

public int hashCode()

Overrides:

hashCode in class ComponentDTO

equals

public boolean equals(Object obj)

Overrides:

equals in class ComponentDTO