[jira] [Commented] (NIFI-4424) org.apache.nifi.NiFi does not allow programmatic access to the NiFi engine

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/NIFI-4424?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16180772#comment-16180772 ] 

ASF GitHub Bot commented on NIFI-4424:
--------------------------------------

GitHub user peter-gergely-horvath opened a pull request:

    https://github.com/apache/nifi/pull/2176

    NIFI-4424 org.apache.nifi.NiFi does not allow programmatic access to …

    This pull request adds support described in [NIFI-4424
    org.apache.nifi.NiFi does not allow programmatic access to the NiFi engine](https://issues.apache.org/jira/browse/NIFI-4424)
    
    NOTE: As of now, `-Pcontrib-check clean install` does fail with
    `[ERROR] Failed to execute goal org.apache.rat:apache-rat-plugin:0.11:check (default) on project nifi-web-ui: Too many files with unapproved license: 11 See RAT report in: ...`
    but that should be unrelated to the change. (This pull request contains file level changes)
    
    Thank you for submitting a contribution to Apache NiFi.
    
    In order to streamline the review of the contribution we ask you
    to ensure the following steps have been taken:
    
    ### For all changes:
    - [x] Is there a JIRA ticket associated with this PR? Is it referenced 
         in the commit message?
    
    - [x] Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
    
    - [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
    
    - [x] Is your initial contribution a single, squashed commit?
    
    ### For code changes:
    - [ ] Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
    - [ ] Have you written or updated unit tests to verify your changes?
    - [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)? 
    - [ ] If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
    - [ ] If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
    - [ ] If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?
    
    ### For documentation related changes:
    - [ ] Have you ensured that format looks appropriate for the output in which it is rendered?
    
    ### Note:
    Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/peter-gergely-horvath/nifi master

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/nifi/pull/2176.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #2176
    
----
commit fae3b69644fa3f59b77426915549cd33b6a0e4ab
Author: Peter G. Horvath <pe...@gmail.com>
Date:   2017-09-26T13:30:32Z

    NIFI-4424 org.apache.nifi.NiFi does not allow programmatic access to the NiFi engine

----


> org.apache.nifi.NiFi does not allow programmatic access to the NiFi engine
> --------------------------------------------------------------------------
>
>                 Key: NIFI-4424
>                 URL: https://issues.apache.org/jira/browse/NIFI-4424
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Core Framework
>    Affects Versions: 1.3.0
>            Reporter: Peter Horvath
>
> Class {{org.apache.nifi.NiFi}} was not designed with extensibility or programmatic access in mind.
> This class is the entry point of the engine, however, the current implementation does not allow
> a potential caller (e.g. an integration test harness) to bootstrap the engine and then shut it down properly:
> The main method {{org.apache.nifi.NiFi#main}} simply logs any exception, which is fine
> when started from the command line, however prevents programmatic usage and
> detecting error conditions (Exceptions) that would be essential to programatically access 
> it from an integration test.
> The constructor {{org.apache.nifi.NiFi#NiFi}} registers an {{UncaughtExceptionHandler}}, 
> a JVM {{Shutdown Hook}} and changes logging framework settings.
> *Please change this behaviour:*
> Expose *two* methods, one of which accepts the command line argument one would pass
> to the NiFi process and another one, which allows the NiFiProperties object to be passed.
> This method should return the {{NiFi}} object instance for further programmatic access.
> The logic used to register {{UncaughtExceptionHandler}}, a JVM Shutdown Hook and 
> changing logging framework settings should be extracted to a {{protected}} *instance*
> method so that a client can override their behaviour with a NO-OP.
> *Please note these changes are baby-steps towards the implementation of a 
> NiFi integration test harness.*



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)