This is an automated email from the ASF dual-hosted git repository.
pvillard31 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/main by this push:
new ecc1e86ca85 NIFI-15898 Updated Developer Guide example for
SSLContextProvider (#11198)
ecc1e86ca85 is described below
commit ecc1e86ca856d729bb17acf2d07261f8e2255d13
Author: David Handermann <[email protected]>
AuthorDate: Mon May 4 03:15:51 2026 -0500
NIFI-15898 Updated Developer Guide example for SSLContextProvider (#11198)
---
nifi-docs/src/main/asciidoc/developer-guide.adoc | 33 +++++++++---------------
1 file changed, 12 insertions(+), 21 deletions(-)
diff --git a/nifi-docs/src/main/asciidoc/developer-guide.adoc
b/nifi-docs/src/main/asciidoc/developer-guide.adoc
index cce1049c117..1906efacc77 100644
--- a/nifi-docs/src/main/asciidoc/developer-guide.adoc
+++ b/nifi-docs/src/main/asciidoc/developer-guide.adoc
@@ -1940,39 +1940,30 @@ that references a Controller Service as such:
[source,java]
----
-public static final PropertyDescriptor SSL_CONTEXT_SERVICE = new
PropertyDescriptor.Builder()
- .name("SSL Context Service")
- .description("Specified the SSL Context Service that can be used to create
secure connections")
+public static final PropertyDescriptor SSL_CONTEXT_PROVIDER = new
PropertyDescriptor.Builder()
+ .name("SSL Context Provider")
+ .description("Specifies the service for securing connections encrypted with
Transport Layer Security")
.required(true)
- .identifiesControllerService(SSLContextService.class)
+ .identifiesControllerService(SSLContextProvider.class)
.build();
----
Using this method, the user will be prompted to supply the SSL Context
-Service that should be used. This is
+Provider that should be used. This is
done by providing the user with a drop-down menu from which they are
-able to choose any of the `SSLContextService`
-configurations that have been configured, regardless of the implementation.
+able to choose any of the `SSLContextProvider`
+instances that have been configured, regardless of the implementation.
In order to make use of this service, the Processor can use code such as:
[source,java]
----
-final SSLContextService sslContextService =
context.getProperty(SSL_CONTEXT_SERVICE)
- .asControllerService(SSLContextService.class);
+final SSLContextProvider sslContextProvider =
context.getProperty(SSL_CONTEXT_PROVIDER)
+ .asControllerService(SSLContextProvider.class);
----
-Note here that `SSLContextService` is an interface that extends
-ControllerService. The only implementation
-at this time is the `StandardSSLContextService`. However, the
-Processor developer need not worry about this
-detail.
-
-
-
-
-
-
+Note here that `SSLContextProvider` is an interface that extends
+ControllerService.
== Reporting Tasks
@@ -2519,7 +2510,7 @@ far less complicated. Note here that the
This is done so that any NAR that has a dependency on
`my-controller-service-api-nar` will also be able to access
all of the Controller Services that are provided by the
-`nifi-standard-services-api-nar`, such as the `SSLContextService`.
+`nifi-standard-services-api-nar`, such as the `SSLContextProvider`.
In this same vein, it is not necessary to create a different
"service-api" NAR for each service. Instead, it often
makes sense to have a single "service-api" NAR that encapsulates the
