Examples with PropertyDescriptor org.apache.nifi.components.PropertyDescriptor used on opensource projects

Example 1 with PropertyDescriptor

use of org.apache.nifi.components.PropertyDescriptor in project nifi by apache.

the class StandardNiFiServiceFacade method getReportingTaskPropertyDescriptor.

@Override
public PropertyDescriptorDTO getReportingTaskPropertyDescriptor(final String id, final String property) {
    final ReportingTaskNode reportingTask = reportingTaskDAO.getReportingTask(id);
    PropertyDescriptor descriptor = reportingTask.getReportingTask().getPropertyDescriptor(property);
    // return an invalid descriptor if the reporting task doesn't support this property
    if (descriptor == null) {
        descriptor = new PropertyDescriptor.Builder().name(property).addValidator(Validator.INVALID).dynamic(true).build();
    }
    return dtoFactory.createPropertyDescriptorDto(descriptor, null);
}

Example 2 with PropertyDescriptor

use of org.apache.nifi.components.PropertyDescriptor in project nifi by apache.

the class DtoFactory method createProcessorConfigDto.

/**
 * Creates a ProcessorConfigDTO from the specified ProcessorNode.
 *
 * @param procNode node
 * @return dto
 */
public ProcessorConfigDTO createProcessorConfigDto(final ProcessorNode procNode) {
    if (procNode == null) {
        return null;
    }
    final ProcessorConfigDTO dto = new ProcessorConfigDTO();
    // sort a copy of the properties
    final Map<PropertyDescriptor, String> sortedProperties = new TreeMap<>(new Comparator<PropertyDescriptor>() {

        @Override
        public int compare(final PropertyDescriptor o1, final PropertyDescriptor o2) {
            return Collator.getInstance(Locale.US).compare(o1.getName(), o2.getName());
        }
    });
    sortedProperties.putAll(procNode.getProperties());
    // get the property order from the processor
    final Processor processor = procNode.getProcessor();
    final Map<PropertyDescriptor, String> orderedProperties = new LinkedHashMap<>();
    final List<PropertyDescriptor> descriptors = processor.getPropertyDescriptors();
    if (descriptors != null && !descriptors.isEmpty()) {
        for (final PropertyDescriptor descriptor : descriptors) {
            orderedProperties.put(descriptor, null);
        }
    }
    orderedProperties.putAll(sortedProperties);
    // build the descriptor and property dtos
    dto.setDescriptors(new LinkedHashMap<String, PropertyDescriptorDTO>());
    dto.setProperties(new LinkedHashMap<String, String>());
    for (final Map.Entry<PropertyDescriptor, String> entry : orderedProperties.entrySet()) {
        final PropertyDescriptor descriptor = entry.getKey();
        // store the property descriptor
        dto.getDescriptors().put(descriptor.getName(), createPropertyDescriptorDto(descriptor, procNode.getProcessGroup().getIdentifier()));
        // determine the property value - don't include sensitive properties
        String propertyValue = entry.getValue();
        if (propertyValue != null && descriptor.isSensitive()) {
            propertyValue = SENSITIVE_VALUE_MASK;
        } else if (propertyValue == null && descriptor.getDefaultValue() != null) {
            propertyValue = descriptor.getDefaultValue();
        }
        // set the property value
        dto.getProperties().put(descriptor.getName(), propertyValue);
    }
    dto.setSchedulingPeriod(procNode.getSchedulingPeriod());
    dto.setPenaltyDuration(procNode.getPenalizationPeriod());
    dto.setYieldDuration(procNode.getYieldPeriod());
    dto.setRunDurationMillis(procNode.getRunDuration(TimeUnit.MILLISECONDS));
    dto.setConcurrentlySchedulableTaskCount(procNode.getMaxConcurrentTasks());
    dto.setLossTolerant(procNode.isLossTolerant());
    dto.setComments(procNode.getComments());
    dto.setBulletinLevel(procNode.getBulletinLevel().name());
    dto.setSchedulingStrategy(procNode.getSchedulingStrategy().name());
    dto.setExecutionNode(procNode.getExecutionNode().name());
    dto.setAnnotationData(procNode.getAnnotationData());
    // set up the default values for concurrent tasks and scheduling period
    final Map<String, String> defaultConcurrentTasks = new HashMap<>();
    defaultConcurrentTasks.put(SchedulingStrategy.TIMER_DRIVEN.name(), String.valueOf(SchedulingStrategy.TIMER_DRIVEN.getDefaultConcurrentTasks()));
    defaultConcurrentTasks.put(SchedulingStrategy.EVENT_DRIVEN.name(), String.valueOf(SchedulingStrategy.EVENT_DRIVEN.getDefaultConcurrentTasks()));
    defaultConcurrentTasks.put(SchedulingStrategy.CRON_DRIVEN.name(), String.valueOf(SchedulingStrategy.CRON_DRIVEN.getDefaultConcurrentTasks()));
    dto.setDefaultConcurrentTasks(defaultConcurrentTasks);
    final Map<String, String> defaultSchedulingPeriod = new HashMap<>();
    defaultSchedulingPeriod.put(SchedulingStrategy.TIMER_DRIVEN.name(), SchedulingStrategy.TIMER_DRIVEN.getDefaultSchedulingPeriod());
    defaultSchedulingPeriod.put(SchedulingStrategy.CRON_DRIVEN.name(), SchedulingStrategy.CRON_DRIVEN.getDefaultSchedulingPeriod());
    dto.setDefaultSchedulingPeriod(defaultSchedulingPeriod);
    return dto;
}

Example 3 with PropertyDescriptor

use of org.apache.nifi.components.PropertyDescriptor in project nifi by apache.

the class DtoFactory method createControllerServiceReferencingComponentDTO.

public ControllerServiceReferencingComponentDTO createControllerServiceReferencingComponentDTO(final ConfiguredComponent component) {
    final ControllerServiceReferencingComponentDTO dto = new ControllerServiceReferencingComponentDTO();
    dto.setId(component.getIdentifier());
    dto.setName(component.getName());
    String processGroupId = null;
    List<PropertyDescriptor> propertyDescriptors = null;
    Collection<ValidationResult> validationErrors = null;
    if (component instanceof ProcessorNode) {
        final ProcessorNode node = ((ProcessorNode) component);
        dto.setGroupId(node.getProcessGroup().getIdentifier());
        dto.setState(node.getScheduledState().name());
        dto.setActiveThreadCount(node.getActiveThreadCount());
        dto.setType(node.getComponentType());
        dto.setReferenceType(Processor.class.getSimpleName());
        propertyDescriptors = node.getProcessor().getPropertyDescriptors();
        validationErrors = node.getValidationErrors();
        processGroupId = node.getProcessGroup().getIdentifier();
    } else if (component instanceof ControllerServiceNode) {
        final ControllerServiceNode node = ((ControllerServiceNode) component);
        dto.setState(node.getState().name());
        dto.setType(node.getComponentType());
        dto.setReferenceType(ControllerService.class.getSimpleName());
        propertyDescriptors = node.getControllerServiceImplementation().getPropertyDescriptors();
        validationErrors = node.getValidationErrors();
        processGroupId = node.getProcessGroup() == null ? null : node.getProcessGroup().getIdentifier();
    } else if (component instanceof ReportingTaskNode) {
        final ReportingTaskNode node = ((ReportingTaskNode) component);
        dto.setState(node.getScheduledState().name());
        dto.setActiveThreadCount(node.getActiveThreadCount());
        dto.setType(node.getComponentType());
        dto.setReferenceType(ReportingTask.class.getSimpleName());
        propertyDescriptors = node.getReportingTask().getPropertyDescriptors();
        validationErrors = node.getValidationErrors();
        processGroupId = null;
    }
    if (propertyDescriptors != null && !propertyDescriptors.isEmpty()) {
        final Map<PropertyDescriptor, String> sortedProperties = new TreeMap<>(new Comparator<PropertyDescriptor>() {

            @Override
            public int compare(final PropertyDescriptor o1, final PropertyDescriptor o2) {
                return Collator.getInstance(Locale.US).compare(o1.getName(), o2.getName());
            }
        });
        sortedProperties.putAll(component.getProperties());
        final Map<PropertyDescriptor, String> orderedProperties = new LinkedHashMap<>();
        for (final PropertyDescriptor descriptor : propertyDescriptors) {
            orderedProperties.put(descriptor, null);
        }
        orderedProperties.putAll(sortedProperties);
        // build the descriptor and property dtos
        dto.setDescriptors(new LinkedHashMap<String, PropertyDescriptorDTO>());
        dto.setProperties(new LinkedHashMap<String, String>());
        for (final Map.Entry<PropertyDescriptor, String> entry : orderedProperties.entrySet()) {
            final PropertyDescriptor descriptor = entry.getKey();
            // store the property descriptor
            dto.getDescriptors().put(descriptor.getName(), createPropertyDescriptorDto(descriptor, processGroupId));
            // determine the property value - don't include sensitive properties
            String propertyValue = entry.getValue();
            if (propertyValue != null && descriptor.isSensitive()) {
                propertyValue = SENSITIVE_VALUE_MASK;
            }
            // set the property value
            dto.getProperties().put(descriptor.getName(), propertyValue);
        }
    }
    if (validationErrors != null && !validationErrors.isEmpty()) {
        final List<String> errors = new ArrayList<>();
        for (final ValidationResult validationResult : validationErrors) {
            errors.add(validationResult.toString());
        }
        dto.setValidationErrors(errors);
    }
    return dto;
}

Example 4 with PropertyDescriptor

use of org.apache.nifi.components.PropertyDescriptor in project nifi by apache.

the class DtoFactory method createReportingTaskDto.

public ReportingTaskDTO createReportingTaskDto(final ReportingTaskNode reportingTaskNode) {
    final BundleCoordinate bundleCoordinate = reportingTaskNode.getBundleCoordinate();
    final List<Bundle> compatibleBundles = ExtensionManager.getBundles(reportingTaskNode.getCanonicalClassName()).stream().filter(bundle -> {
        final BundleCoordinate coordinate = bundle.getBundleDetails().getCoordinate();
        return bundleCoordinate.getGroup().equals(coordinate.getGroup()) && bundleCoordinate.getId().equals(coordinate.getId());
    }).collect(Collectors.toList());
    final ReportingTaskDTO dto = new ReportingTaskDTO();
    dto.setId(reportingTaskNode.getIdentifier());
    dto.setName(reportingTaskNode.getName());
    dto.setType(reportingTaskNode.getCanonicalClassName());
    dto.setBundle(createBundleDto(bundleCoordinate));
    dto.setSchedulingStrategy(reportingTaskNode.getSchedulingStrategy().name());
    dto.setSchedulingPeriod(reportingTaskNode.getSchedulingPeriod());
    dto.setState(reportingTaskNode.getScheduledState().name());
    dto.setActiveThreadCount(reportingTaskNode.getActiveThreadCount());
    dto.setAnnotationData(reportingTaskNode.getAnnotationData());
    dto.setComments(reportingTaskNode.getComments());
    dto.setPersistsState(reportingTaskNode.getReportingTask().getClass().isAnnotationPresent(Stateful.class));
    dto.setRestricted(reportingTaskNode.isRestricted());
    dto.setDeprecated(reportingTaskNode.isDeprecated());
    dto.setExtensionMissing(reportingTaskNode.isExtensionMissing());
    dto.setMultipleVersionsAvailable(compatibleBundles.size() > 1);
    final Map<String, String> defaultSchedulingPeriod = new HashMap<>();
    defaultSchedulingPeriod.put(SchedulingStrategy.TIMER_DRIVEN.name(), SchedulingStrategy.TIMER_DRIVEN.getDefaultSchedulingPeriod());
    defaultSchedulingPeriod.put(SchedulingStrategy.CRON_DRIVEN.name(), SchedulingStrategy.CRON_DRIVEN.getDefaultSchedulingPeriod());
    dto.setDefaultSchedulingPeriod(defaultSchedulingPeriod);
    // sort a copy of the properties
    final Map<PropertyDescriptor, String> sortedProperties = new TreeMap<>(new Comparator<PropertyDescriptor>() {

        @Override
        public int compare(final PropertyDescriptor o1, final PropertyDescriptor o2) {
            return Collator.getInstance(Locale.US).compare(o1.getName(), o2.getName());
        }
    });
    sortedProperties.putAll(reportingTaskNode.getProperties());
    // get the property order from the reporting task
    final ReportingTask reportingTask = reportingTaskNode.getReportingTask();
    final Map<PropertyDescriptor, String> orderedProperties = new LinkedHashMap<>();
    final List<PropertyDescriptor> descriptors = reportingTask.getPropertyDescriptors();
    if (descriptors != null && !descriptors.isEmpty()) {
        for (final PropertyDescriptor descriptor : descriptors) {
            orderedProperties.put(descriptor, null);
        }
    }
    orderedProperties.putAll(sortedProperties);
    // build the descriptor and property dtos
    dto.setDescriptors(new LinkedHashMap<String, PropertyDescriptorDTO>());
    dto.setProperties(new LinkedHashMap<String, String>());
    for (final Map.Entry<PropertyDescriptor, String> entry : orderedProperties.entrySet()) {
        final PropertyDescriptor descriptor = entry.getKey();
        // store the property descriptor
        dto.getDescriptors().put(descriptor.getName(), createPropertyDescriptorDto(descriptor, null));
        // determine the property value - don't include sensitive properties
        String propertyValue = entry.getValue();
        if (propertyValue != null && descriptor.isSensitive()) {
            propertyValue = SENSITIVE_VALUE_MASK;
        }
        // set the property value
        dto.getProperties().put(descriptor.getName(), propertyValue);
    }
    // add the validation errors
    final Collection<ValidationResult> validationErrors = reportingTaskNode.getValidationErrors();
    if (validationErrors != null && !validationErrors.isEmpty()) {
        final List<String> errors = new ArrayList<>();
        for (final ValidationResult validationResult : validationErrors) {
            errors.add(validationResult.toString());
        }
        dto.setValidationErrors(errors);
    }
    return dto;
}

Example 5 with PropertyDescriptor

use of org.apache.nifi.components.PropertyDescriptor in project nifi by apache.

the class ControllerSearchService method search.

private ComponentSearchResultDTO search(final String searchStr, final ProcessorNode procNode) {
    final List<String> matches = new ArrayList<>();
    final Processor processor = procNode.getProcessor();
    addIfAppropriate(searchStr, procNode.getIdentifier(), "Id", matches);
    addIfAppropriate(searchStr, procNode.getVersionedComponentId().orElse(null), "Version Control ID", matches);
    addIfAppropriate(searchStr, procNode.getName(), "Name", matches);
    addIfAppropriate(searchStr, procNode.getComments(), "Comments", matches);
    // consider scheduling strategy
    if (SchedulingStrategy.EVENT_DRIVEN.equals(procNode.getSchedulingStrategy()) && StringUtils.containsIgnoreCase("event", searchStr)) {
        matches.add("Scheduling strategy: Event driven");
    } else if (SchedulingStrategy.TIMER_DRIVEN.equals(procNode.getSchedulingStrategy()) && StringUtils.containsIgnoreCase("timer", searchStr)) {
        matches.add("Scheduling strategy: Timer driven");
    } else if (SchedulingStrategy.PRIMARY_NODE_ONLY.equals(procNode.getSchedulingStrategy()) && StringUtils.containsIgnoreCase("primary", searchStr)) {
        // PRIMARY_NODE_ONLY has been deprecated as a SchedulingStrategy and replaced by PRIMARY as an ExecutionNode.
        matches.add("Scheduling strategy: On primary node");
    }
    // consider execution node
    if (ExecutionNode.PRIMARY.equals(procNode.getExecutionNode()) && StringUtils.containsIgnoreCase("primary", searchStr)) {
        matches.add("Execution node: primary");
    }
    // consider scheduled state
    if (ScheduledState.DISABLED.equals(procNode.getScheduledState())) {
        if (StringUtils.containsIgnoreCase("disabled", searchStr)) {
            matches.add("Run status: Disabled");
        }
    } else {
        if (StringUtils.containsIgnoreCase("invalid", searchStr) && !procNode.isValid()) {
            matches.add("Run status: Invalid");
        } else if (ScheduledState.RUNNING.equals(procNode.getScheduledState()) && StringUtils.containsIgnoreCase("running", searchStr)) {
            matches.add("Run status: Running");
        } else if (ScheduledState.STOPPED.equals(procNode.getScheduledState()) && StringUtils.containsIgnoreCase("stopped", searchStr)) {
            matches.add("Run status: Stopped");
        }
    }
    for (final Relationship relationship : procNode.getRelationships()) {
        addIfAppropriate(searchStr, relationship.getName(), "Relationship", matches);
    }
    // Add both the actual class name and the component type. This allows us to search for 'Ghost'
    // to search for components that could not be instantiated.
    addIfAppropriate(searchStr, processor.getClass().getSimpleName(), "Type", matches);
    addIfAppropriate(searchStr, procNode.getComponentType(), "Type", matches);
    for (final Map.Entry<PropertyDescriptor, String> entry : procNode.getProperties().entrySet()) {
        final PropertyDescriptor descriptor = entry.getKey();
        addIfAppropriate(searchStr, descriptor.getName(), "Property name", matches);
        addIfAppropriate(searchStr, descriptor.getDescription(), "Property description", matches);
        // never include sensitive properties values in search results
        if (descriptor.isSensitive()) {
            continue;
        }
        String value = entry.getValue();
        // if unset consider default value
        if (value == null) {
            value = descriptor.getDefaultValue();
        }
        // evaluate if the value matches the search criteria
        if (StringUtils.containsIgnoreCase(value, searchStr)) {
            matches.add("Property value: " + descriptor.getName() + " - " + value);
        }
    }
    // consider searching the processor directly
    if (processor instanceof Searchable) {
        final Searchable searchable = (Searchable) processor;
        final SearchContext context = new StandardSearchContext(searchStr, procNode, flowController, variableRegistry);
        // search the processor using the appropriate thread context classloader
        try (final NarCloseable x = NarCloseable.withComponentNarLoader(processor.getClass(), processor.getIdentifier())) {
            final Collection<SearchResult> searchResults = searchable.search(context);
            if (CollectionUtils.isNotEmpty(searchResults)) {
                for (final SearchResult searchResult : searchResults) {
                    matches.add(searchResult.getLabel() + ": " + searchResult.getMatch());
                }
            }
        } catch (final Throwable t) {
        // log this as error
        }
    }
    if (matches.isEmpty()) {
        return null;
    }
    final ComponentSearchResultDTO result = new ComponentSearchResultDTO();
    result.setId(procNode.getIdentifier());
    result.setMatches(matches);
    result.setName(procNode.getName());
    return result;
}