org.apache.nifi.web.api.entity

Class PortEntity

java.lang.Object

org.apache.nifi.web.api.entity.Entity

org.apache.nifi.web.api.entity.ComponentEntity

org.apache.nifi.web.api.entity.PortEntity

All Implemented Interfaces:

OperationPermissible, Permissible<PortDTO>

public class PortEntity
extends ComponentEntity
implements Permissible<PortDTO>, OperationPermissible

A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to an input PortDTO.

Field Summary

Fields

Modifier and Type	Field and Description
private Boolean	allowRemoteAccess
private PortDTO	component
private PermissionsDTO	operatePermissions
private String	portType
private PortStatusDTO	status

Constructor Summary

Constructors

Constructor and Description
PortEntity()

Method Summary

Modifier and Type	Method and Description
PortDTO	getComponent()
PermissionsDTO	getOperatePermissions()
String	getPortType()
PortStatusDTO	getStatus()
Boolean	isAllowRemoteAccess()
void	setAllowRemoteAccess(Boolean allowRemoteAccess)
void	setComponent(PortDTO component)
void	setOperatePermissions(PermissionsDTO permissions)
void	setPortType(String portType)
void	setStatus(PortStatusDTO status)

Methods inherited from class org.apache.nifi.web.api.entity.ComponentEntity

equals, getBulletins, getId, getPermissions, getPosition, getRevision, getUri, hashCode, isDisconnectedNodeAcknowledged, setBulletins, setDisconnectedNodeAcknowledged, setId, setPermissions, setPosition, setRevision, setUri

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.web.api.entity.Permissible

getPermissions, setPermissions

Field Detail

component

private PortDTO component

status

private PortStatusDTO status

portType

private String portType

operatePermissions

private PermissionsDTO operatePermissions

allowRemoteAccess

private Boolean allowRemoteAccess

Constructor Detail

PortEntity

public PortEntity()

Method Detail

getComponent

public PortDTO getComponent()

Specified by:

getComponent in interface Permissible<PortDTO>

Returns:

input PortDTO that are being serialized

setComponent

public void setComponent(PortDTO component)

Specified by:

setComponent in interface Permissible<PortDTO>

getStatus

public PortStatusDTO getStatus()

Returns:

the port status

setStatus

public void setStatus(PortStatusDTO status)

getPortType

public String getPortType()

setPortType

public void setPortType(String portType)

getOperatePermissions

public PermissionsDTO getOperatePermissions()

Specified by:

getOperatePermissions in interface OperationPermissible

Returns:

The permissions for this component operations

setOperatePermissions

public void setOperatePermissions(PermissionsDTO permissions)

Specified by:

setOperatePermissions in interface OperationPermissible

isAllowRemoteAccess

public Boolean isAllowRemoteAccess()

Returns:

whether this port can be accessed remotely via Site-to-Site protocol.

setAllowRemoteAccess

public void setAllowRemoteAccess(Boolean allowRemoteAccess)