org.apache.nifi.web.api.dto

Class DtoFactory

java.lang.Object

org.apache.nifi.web.api.dto.DtoFactory

public final class DtoFactory
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DtoFactory.SortedRemoteGroupPortComparator

Field Summary

Fields

Modifier and Type	Field and Description
private static Comparator<Class>	CLASS_NAME_COMPARATOR
private ControllerServiceLookup	controllerServiceLookup
(package private) int	MAX_BULLETINS_PER_COMPONENT
private NiFiProperties	properties

Constructor Summary

Constructors

Constructor and Description
DtoFactory()

Method Summary

Methods

Modifier and Type	Method and Description
BulletinDTO	copy(BulletinDTO original)
private <T> List<T>	copy(Collection<T> original)
ConnectionDTO	copy(ConnectionDTO original)
private FlowSnippetDTO	copy(FlowSnippetDTO original, boolean deep)
FunnelDTO	copy(FunnelDTO original)
LabelDTO	copy(LabelDTO original)
private <T> List<T>	copy(List<T> original)
private <S,T> Map<S,T>	copy(Map<S,T> original)
PortDTO	copy(PortDTO original)
ProcessGroupDTO	copy(ProcessGroupDTO original, boolean deep)
private ProcessorConfigDTO	copy(ProcessorConfigDTO original)
ProcessorDTO	copy(ProcessorDTO original)
RemoteProcessGroupDTO	copy(RemoteProcessGroupDTO original)
RemoteProcessGroupPortDTO	copy(RemoteProcessGroupPortDTO original)
private <T> Set<T>	copy(Set<T> original)
FlowSnippetDTO	copySnippetContents(FlowSnippetDTO originalSnippet) Copies the specified snippet.
private ActionDetailsDTO	createActionDetailsDto(ActionDetails actionDetails) Creates an ActionDetailsDTO for the specified ActionDetails.
ActionDTO	createActionDto(Action action) Creates an ActionDTO for the specified Action.
BulletinBoardDTO	createBulletinBoardDto(List<BulletinDTO> bulletins) Creates a BulletinBoardDTO for the specified bulletins.
BulletinDTO	createBulletinDto(Bulletin bulletin) Creates a BulletinDTO for the specified Bulletin.
private ComponentDetailsDTO	createComponentDetailsDto(ComponentDetails componentDetails) Creates a ComponentDetailsDTO for the specified ComponentDetails.
private ProcessGroupDTO	createConciseProcessGroupDto(ProcessGroup group) Creates a ProcessGroupDTO from the specified ProcessGroup.
ConnectableDTO	createConnectableDto(Connectable connectable) Creates a ConnectableDTO from the specified Connectable.
ConnectableDTO	createConnectableDto(FunnelDTO funnel)
ConnectableDTO	createConnectableDto(PortDTO port, ConnectableType type)
ConnectableDTO	createConnectableDto(ProcessorDTO processor)
ConnectableDTO	createConnectableDto(RemoteProcessGroupPortDTO remoteGroupPort, ConnectableType type)
ConnectionDTO	createConnectionDto(Connection connection) Creates a ConnectionDTO from the specified Connection.
ConnectionStatusDTO	createConnectionStatusDto(ConnectionStatus connectionStatus)
CounterDTO	createCounterDto(Counter counter) Creates a CounterDTO from the specified Counter.
CountersDTO	createCountersDto(Collection<CounterDTO> counterDtos) Creates CounterDTOs for each Counter specified.
ProvenanceNodeDTO	createFlowFileNodeDTO(LineageNode node) Creates a FlowFileNodeDTO for the specified LineageNode.
FunnelDTO	createFunnelDto(Funnel funnel) Creates a FunnelDTO from the specified Funnel.
SystemDiagnosticsDTO.GarbageCollectionDTO	createGarbageCollectionDTO(String name, GarbageCollection garbageCollection) Creates a GarbageCollectionDTO from the specified GarbageCollection.
HistoryDTO	createHistoryDto(History history) Creates a HistoryDTO from the specified History.
LabelDTO	createLabelDto(Label label) Creates a LabelDTO from the specified Label.
LineageDTO	createLineageDto(ComputeLineageSubmission computeLineageSubmission) Creates a LineageDTO for the specified Lineage.
NodeDTO	createNodeDTO(Node node, List<Event> events, boolean primary)
private ProcessGroupDTO	createParentProcessGroupDto(ProcessGroup parentGroup) Creates a ProcessGroupDTO from the specified parent ProcessGroup.
PortDTO	createPortDto(Port port) Creates a PortDTO from the specified Port.
PortStatusDTO	createPortStatusDto(PortStatus portStatus) Creates a PortStatusDTO for the specified PortStatus.
PositionDTO	createPositionDto(Position position) Creates a PositionDTO from the specified position
private FlowSnippetDTO	createProcessGroupContentsDto(ProcessGroup group, boolean recurse) Creates a ProcessGroupContentDTO from the specified ProcessGroup.
ProcessGroupDTO	createProcessGroupDto(ProcessGroup group) Creates a ProcessGroupDTO from the specified ProcessGroup.
ProcessGroupDTO	createProcessGroupDto(ProcessGroup group, boolean recurse) Creates a ProcessGroupDTO from the specified ProcessGroup.
ProcessGroupStatusDTO	createProcessGroupStatusDto(BulletinRepository bulletinRepository, ProcessGroupStatus processGroupStatus)
ProcessorConfigDTO	createProcessorConfigDto(ProcessorNode procNode) Creates a ProcessorConfigDTO from the specified ProcessorNode.
ProcessorDTO	createProcessorDto(ProcessorNode node) Creates a ProcessorDTO from the specified ProcessorNode.
ProcessorStatusDTO	createProcessorStatusDto(ProcessorStatus procStatus)
private ProcessorConfigDTO.PropertyDescriptorDTO	createPropertyDescriptorDto(PropertyDescriptor propertyDescriptor) Creates a PropertyDesriptorDTO from the specified PropertyDesriptor.
ProvenanceNodeDTO	createProvenanceEventNodeDTO(ProvenanceEventLineageNode node) Creates a ProvenanceEventNodeDTO for the specified ProvenanceEventLineageNode.
ProvenanceLinkDTO	createProvenanceLinkDTO(LineageEdge edge) Creates a ProvenanceLinkDTO for the specified LineageEdge.
RemoteProcessGroupDTO	createRemoteProcessGroupDto(RemoteProcessGroup group) Creates a RemoteProcessGroupDTO from the specified RemoteProcessGroup.
RemoteProcessGroupPortDTO	createRemoteProcessGroupPortDto(RemoteGroupPort port)
RemoteProcessGroupStatusDTO	createRemoteProcessGroupStatusDto(RemoteProcessGroupStatus remoteProcessGroupStatus)
RevisionDTO	createRevisionDTO(Revision revision) Factory method for creating a new RevisionDTO based on this controller.
SnippetDTO	createSnippetDto(Snippet snippet) Creates a SnippetDTO from the specified Snippet.
SystemDiagnosticsDTO.StorageUsageDTO	createStorageUsageDTO(String identifier, StorageUsage storageUsage) Creates a StorageUsageDTO from the specified StorageUsage.
SystemDiagnosticsDTO	createSystemDiagnosticsDto(SystemDiagnostics sysDiagnostics) Creates a SystemDiagnosticsDTO for the specified SystemDiagnostics.
TemplateDTO	createTemplateDTO(Template template) Creates a TemplateDTO from the specified template.
UserDTO	createUserDTO(NiFiUser user) Factory method for creating a new user transfer object.
UserGroupDTO	createUserGroupDTO(NiFiUserGroup userGroup)
private String	formatCount(Integer intStatus)
private String	formatDataSize(Long longStatus)
Set<DocumentedTypeDTO>	fromDocumentedTypes(Set<Class> classes) Gets the DocumentedTypeDTOs from the specified classes.
private String	getCapabilityDescription(Class<?> cls) Gets the capability description from the specified class.
private Set<String>	getTags(Class<?> cls) Gets the tags from the specified class.
void	setControllerServiceLookup(ControllerServiceLookup lookup)
void	setProperties(NiFiProperties properties)

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME_COMPARATOR

private static final Comparator<Class> CLASS_NAME_COMPARATOR

MAX_BULLETINS_PER_COMPONENT

final int MAX_BULLETINS_PER_COMPONENT

See Also:

Constant Field Values

properties

private NiFiProperties properties

controllerServiceLookup

private ControllerServiceLookup controllerServiceLookup

Constructor Detail

DtoFactory

public DtoFactory()

Method Detail

createActionDto

public ActionDTO createActionDto(Action action)

Creates an ActionDTO for the specified Action.

Parameters:

action -

Returns:

createActionDetailsDto

private ActionDetailsDTO createActionDetailsDto(ActionDetails actionDetails)

Creates an ActionDetailsDTO for the specified ActionDetails.

Parameters:

actionDetails -

Returns:

createComponentDetailsDto

private ComponentDetailsDTO createComponentDetailsDto(ComponentDetails componentDetails)

Creates a ComponentDetailsDTO for the specified ComponentDetails.

Parameters:

componentDetails -

Returns:

createHistoryDto

public HistoryDTO createHistoryDto(History history)

Creates a HistoryDTO from the specified History.

Parameters:

history -

Returns:

createCountersDto

public CountersDTO createCountersDto(Collection<CounterDTO> counterDtos)

Creates CounterDTOs for each Counter specified.

Parameters:

counterDtos -

Returns:

createCounterDto

public CounterDTO createCounterDto(Counter counter)

Creates a CounterDTO from the specified Counter.

Parameters:

counter -

Returns:

createPositionDto

public PositionDTO createPositionDto(Position position)

Creates a PositionDTO from the specified position

Parameters:

position -

Returns:

createConnectionDto

public ConnectionDTO createConnectionDto(Connection connection)

Creates a ConnectionDTO from the specified Connection.

Parameters:

connection -

Returns:

createConnectableDto

public ConnectableDTO createConnectableDto(Connectable connectable)

Creates a ConnectableDTO from the specified Connectable.

Parameters:

connectable -

Returns:

createLabelDto

public LabelDTO createLabelDto(Label label)

Creates a LabelDTO from the specified Label.

Parameters:

label -

Returns:

createFunnelDto

public FunnelDTO createFunnelDto(Funnel funnel)

Creates a FunnelDTO from the specified Funnel.

Parameters:

funnel -

Returns:

createSnippetDto

public SnippetDTO createSnippetDto(Snippet snippet)

Creates a SnippetDTO from the specified Snippet.

Parameters:

snippet -

Returns:

createTemplateDTO

public TemplateDTO createTemplateDTO(Template template)

Creates a TemplateDTO from the specified template.

Parameters:

template -

Returns:

formatCount

private String formatCount(Integer intStatus)

formatDataSize

private String formatDataSize(Long longStatus)

createRemoteProcessGroupStatusDto

public RemoteProcessGroupStatusDTO createRemoteProcessGroupStatusDto(RemoteProcessGroupStatus remoteProcessGroupStatus)

createProcessGroupStatusDto

public ProcessGroupStatusDTO createProcessGroupStatusDto(BulletinRepository bulletinRepository,
                                                ProcessGroupStatus processGroupStatus)

createConnectionStatusDto

public ConnectionStatusDTO createConnectionStatusDto(ConnectionStatus connectionStatus)

createProcessorStatusDto

public ProcessorStatusDTO createProcessorStatusDto(ProcessorStatus procStatus)

createPortStatusDto

public PortStatusDTO createPortStatusDto(PortStatus portStatus)

Creates a PortStatusDTO for the specified PortStatus.

Parameters:

portStatus -

Returns:

copySnippetContents

public FlowSnippetDTO copySnippetContents(FlowSnippetDTO originalSnippet)

Copies the specified snippet.

Parameters:

originalSnippet -

Returns:

createPortDto

public PortDTO createPortDto(Port port)

Creates a PortDTO from the specified Port.

Parameters:

port -

Returns:

createRemoteProcessGroupPortDto

public RemoteProcessGroupPortDTO createRemoteProcessGroupPortDto(RemoteGroupPort port)

createRemoteProcessGroupDto

public RemoteProcessGroupDTO createRemoteProcessGroupDto(RemoteProcessGroup group)

Creates a RemoteProcessGroupDTO from the specified RemoteProcessGroup.

Parameters:

group -

Returns:

createParentProcessGroupDto

private ProcessGroupDTO createParentProcessGroupDto(ProcessGroup parentGroup)

Creates a ProcessGroupDTO from the specified parent ProcessGroup.

Parameters:

parentGroup -

Returns:

createProcessGroupDto

public ProcessGroupDTO createProcessGroupDto(ProcessGroup group)

Creates a ProcessGroupDTO from the specified ProcessGroup.

Parameters:

group -

Returns:

createProcessGroupDto

public ProcessGroupDTO createProcessGroupDto(ProcessGroup group,
                                    boolean recurse)

Creates a ProcessGroupDTO from the specified ProcessGroup.

Parameters:

group -

recurse -

Returns:

createConciseProcessGroupDto

private ProcessGroupDTO createConciseProcessGroupDto(ProcessGroup group)

Creates a ProcessGroupDTO from the specified ProcessGroup.

Parameters:

group -

recurse -

Returns:

createProcessGroupContentsDto

private FlowSnippetDTO createProcessGroupContentsDto(ProcessGroup group,
                                           boolean recurse)

Creates a ProcessGroupContentDTO from the specified ProcessGroup.

Parameters:

group -

recurse -

Returns:

getCapabilityDescription

private String getCapabilityDescription(Class<?> cls)

Gets the capability description from the specified class.

Parameters:

cls -

Returns:

getTags

private Set<String> getTags(Class<?> cls)

Gets the tags from the specified class.

Parameters:

cls -

Returns:

fromDocumentedTypes

public Set<DocumentedTypeDTO> fromDocumentedTypes(Set<Class> classes)

Gets the DocumentedTypeDTOs from the specified classes.

Parameters:

classes -

Returns:

createProcessorDto

public ProcessorDTO createProcessorDto(ProcessorNode node)

Creates a ProcessorDTO from the specified ProcessorNode.

Parameters:

node -

Returns:

createBulletinBoardDto

public BulletinBoardDTO createBulletinBoardDto(List<BulletinDTO> bulletins)

Creates a BulletinBoardDTO for the specified bulletins.

Parameters:

bulletins -

Returns:

createBulletinDto

public BulletinDTO createBulletinDto(Bulletin bulletin)

Creates a BulletinDTO for the specified Bulletin.

Parameters:

bulletin -

Returns:

createProvenanceEventNodeDTO

public ProvenanceNodeDTO createProvenanceEventNodeDTO(ProvenanceEventLineageNode node)

Creates a ProvenanceEventNodeDTO for the specified ProvenanceEventLineageNode.

Parameters:

node -

Returns:

createFlowFileNodeDTO

public ProvenanceNodeDTO createFlowFileNodeDTO(LineageNode node)

Creates a FlowFileNodeDTO for the specified LineageNode.

Parameters:

node -

Returns:

createProvenanceLinkDTO

public ProvenanceLinkDTO createProvenanceLinkDTO(LineageEdge edge)

Creates a ProvenanceLinkDTO for the specified LineageEdge.

Parameters:

edge -

Returns:

createLineageDto

public LineageDTO createLineageDto(ComputeLineageSubmission computeLineageSubmission)

Creates a LineageDTO for the specified Lineage.

Parameters:

computeLineageSubmission -

Returns:

createSystemDiagnosticsDto

public SystemDiagnosticsDTO createSystemDiagnosticsDto(SystemDiagnostics sysDiagnostics)

Creates a SystemDiagnosticsDTO for the specified SystemDiagnostics.

Parameters:

sysDiagnostics -

Returns:

createStorageUsageDTO

public SystemDiagnosticsDTO.StorageUsageDTO createStorageUsageDTO(String identifier,
                                                         StorageUsage storageUsage)

Creates a StorageUsageDTO from the specified StorageUsage.

Parameters:

identifier -

storageUsage -

Returns:

createGarbageCollectionDTO

public SystemDiagnosticsDTO.GarbageCollectionDTO createGarbageCollectionDTO(String name,
                                                                   GarbageCollection garbageCollection)

Creates a GarbageCollectionDTO from the specified GarbageCollection.

Parameters:

name -

garbageCollection -

Returns:

createProcessorConfigDto

public ProcessorConfigDTO createProcessorConfigDto(ProcessorNode procNode)

Creates a ProcessorConfigDTO from the specified ProcessorNode.

Parameters:

procNode -

Returns:

createPropertyDescriptorDto

private ProcessorConfigDTO.PropertyDescriptorDTO createPropertyDescriptorDto(PropertyDescriptor propertyDescriptor)

Creates a PropertyDesriptorDTO from the specified PropertyDesriptor.

Parameters:

propertyDescriptor -

Returns:

copy

public LabelDTO copy(LabelDTO original)

copy

public FunnelDTO copy(FunnelDTO original)

copy

private <T> List<T> copy(List<T> original)

copy

private <T> List<T> copy(Collection<T> original)

copy

private <T> Set<T> copy(Set<T> original)

copy

private <S,T> Map<S,T> copy(Map<S,T> original)

copy

public ProcessorDTO copy(ProcessorDTO original)

copy

private ProcessorConfigDTO copy(ProcessorConfigDTO original)

copy

public ConnectionDTO copy(ConnectionDTO original)

copy

public BulletinDTO copy(BulletinDTO original)

copy

public PortDTO copy(PortDTO original)

copy

public RemoteProcessGroupPortDTO copy(RemoteProcessGroupPortDTO original)

copy

public ProcessGroupDTO copy(ProcessGroupDTO original,
                   boolean deep)

copy

public RemoteProcessGroupDTO copy(RemoteProcessGroupDTO original)

createConnectableDto

public ConnectableDTO createConnectableDto(PortDTO port,
                                  ConnectableType type)

createConnectableDto

public ConnectableDTO createConnectableDto(ProcessorDTO processor)

createConnectableDto

public ConnectableDTO createConnectableDto(FunnelDTO funnel)

createConnectableDto

public ConnectableDTO createConnectableDto(RemoteProcessGroupPortDTO remoteGroupPort,
                                  ConnectableType type)

copy

private FlowSnippetDTO copy(FlowSnippetDTO original,
                  boolean deep)

Parameters:

original -

deep - if true, all Connections, ProcessGroups, Ports, Processors, etc. will be copied. If false, the copy will have links to the same objects referenced by original.

Returns:

createRevisionDTO

public RevisionDTO createRevisionDTO(Revision revision)

Factory method for creating a new RevisionDTO based on this controller.

Parameters:

revision -

Returns:

createUserDTO

public UserDTO createUserDTO(NiFiUser user)

Factory method for creating a new user transfer object.

Parameters:

user -

Returns:

createUserGroupDTO

public UserGroupDTO createUserGroupDTO(NiFiUserGroup userGroup)

createNodeDTO

public NodeDTO createNodeDTO(Node node,
                    List<Event> events,
                    boolean primary)

setProperties

public void setProperties(NiFiProperties properties)

setControllerServiceLookup

public void setControllerServiceLookup(ControllerServiceLookup lookup)