Package org.apache.nifi.web.server

Class JettyServer

java.lang.Object

org.apache.nifi.web.server.JettyServer

All Implemented Interfaces:

ExtensionUiLoader, NiFiServer

public class JettyServer
extends Object
implements NiFiServer, ExtensionUiLoader

Encapsulates the Jetty instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	JettyServer.ExtensionUiApp	Extension of Jetty's App class to allow use of an already created WebAppContext.
private static final record	JettyServer.ExtensionUiInfo
private static class	JettyServer.ExtensionUiLoadTask	Task that asynchronously processes any bundles that were submitted to have extension UIs loaded.
private static class	JettyServer.ThreadDumpDiagnosticsFactory

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ALLOWED_CONTEXT_PATHS_PARAMETER
private static final String	APPLICATION_PATH
private final Map<BundleCoordinate,List<org.eclipse.jetty.deploy.App>>	appsByBundleCoordinate
private Set<Bundle>	bundles
private ClusterDetailsFactory	clusterDetailsFactory
private UiExtensionMapping	componentUiExtensions
private Collection<org.eclipse.jetty.ee10.webapp.WebAppContext>	componentUiExtensionWebContexts
private static final String	CONTAINER_JAR_PATTERN
private Collection<ContentViewer>	contentViewers
private Collection<org.eclipse.jetty.ee10.webapp.WebAppContext>	contentViewerWebContexts
private static final String	CONTEXT_PATH_ALL
private static final String	CONTEXT_PATH_NIFI
private static final String	CONTEXT_PATH_NIFI_API
private DecommissionTask	decommissionTask
private static final String	DEFAULT_NAR_PROVIDER_CONFLICT_RESOLUTION
private static final String	DEFAULT_NAR_PROVIDER_POLL_INTERVAL
private final org.eclipse.jetty.deploy.DeploymentManager	deploymentManager
private DiagnosticsFactory	diagnosticsFactory
private static final Duration	EXTENSION_UI_POLL_INTERVAL
private ExtensionMapping	extensionMapping
private final JettyServer.ExtensionUiLoadTask	extensionUiLoadTask
private final BlockingQueue<Bundle>	extensionUisToLoad
private static final String	HOST_UNSPECIFIED
private static final String	HTTP_SCHEME
private static final String	HTTPS_SCHEME
private static final org.slf4j.Logger	logger
private static final String	NAR_DEPENDENCIES_PATH
private static final String	NAR_PROVIDER_CONFLICT_RESOLUTION
private static final String	NAR_PROVIDER_IMPLEMENTATION_PROPERTY
private static final String	NAR_PROVIDER_POLL_INTERVAL_PROPERTY
private static final String	NAR_PROVIDER_PREFIX
private static final String	NAR_PROVIDER_RESTRAIN_PROPERTY
private NarAutoLoader	narAutoLoader
private ExternalResourceProviderService	narProviderService
private NiFiProperties	props
private static final RequestFilterProvider	REQUEST_FILTER_PROVIDER
private static final Set<String>	REQUIRED_CONTEXT_PATHS
private static final RequestFilterProvider	REST_API_REQUEST_FILTER_PROVIDER
private org.eclipse.jetty.server.Server	server
private static final String	SPRING_SECURITY_FILTER_CHAIN
private SSLContext	sslContext
private StatusHistoryDumpFactory	statusHistoryDumpFactory
private Bundle	systemBundle
private static final String	WAR_EXTENSION
private static final int	WEB_APP_MAX_FORM_CONTENT_SIZE
private org.eclipse.jetty.ee10.webapp.WebAppContext	webApiContext

Constructor Summary

Constructors

Constructor	Description
JettyServer()	Default no-arg constructor for ServiceLoader

Method Summary

Modifier and Type	Method	Description
private void	addDocsServlets(org.eclipse.jetty.ee10.webapp.WebAppContext webAppContext)
private Map<String,ExternalResourceProvider>	buildExternalResourceProviders(SSLContext sslContext, ExtensionManager extensionManager, Predicate<ExternalResourceDescriptor> filter)
private void	clearWorkingDirectory()
private boolean	containsUiExtensionType(List<UiExtension> componentUiExtensionsForType, UiExtensionType extensionType)	Returns whether or not the specified ui extensions already contains an extension of the specified type.
private ExternalResourceProvider	createProviderInstance(ExtensionManager extensionManager, String providerClass, String providerId, ExternalResourceProviderInitializationContext context)	In case the provider class is not an implementation of ExternalResourceProvider the method tries to instantiate it as a NarProvider.
private String	extractComponentType(String line)	Extracts the component type.
private Map<File,Bundle>	findWars(Set<Bundle> bundles)
protected List<URI>	getApplicationUrls()
ClusterDetailsFactory	getClusterDetailsFactory()
DecommissionTask	getDecommissionTask()
DiagnosticsFactory	getDiagnosticsFactory()
private File	getDocsDir()	Returns a File object for the directory containing NIFI documentation.
private org.eclipse.jetty.ee10.servlet.ErrorPageErrorHandler	getErrorHandler()
StatusHistoryDumpFactory	getStatusHistoryDumpFactory()
DiagnosticsFactory	getThreadDumpFactory()
private File	getWebApiDocsDir()
private File	getWebAppTempDirectory(File warFile)
private void	identifyUiExtensionsForComponents(Map<UiExtensionType,List<String>> uiExtensions, File warFile)	Identifies all known UI extensions and stores them in the specified map.
void	init()
void	initialize(NiFiProperties properties, Bundle systemBundle, Set<Bundle> bundles, ExtensionMapping extensionMapping)
void	loadExtensionUis(Collection<Bundle> bundles)
private org.eclipse.jetty.server.Handler	loadInitialWars(Set<Bundle> bundles)
private org.eclipse.jetty.ee10.webapp.WebAppContext	loadWar(File warFile, String contextPath, ClassLoader parentClassLoader)
private JettyServer.ExtensionUiInfo	loadWars(Map<File,Bundle> warToBundleLookup)
private void	performInjectionForComponentUis(Collection<org.eclipse.jetty.ee10.webapp.WebAppContext> componentUiExtensionWebContexts, NiFiWebConfigurationContext configurationContext, org.eclipse.jetty.ee10.servlet.FilterHolder securityFilter)
private void	performInjectionForContentViewerUis(Collection<org.eclipse.jetty.ee10.webapp.WebAppContext> contentViewerWebContexts, org.springframework.web.context.WebApplicationContext webApiApplicationContext, org.eclipse.jetty.ee10.servlet.FilterHolder securityFilter)
private void	processExtensionUiBundle(Bundle bundle)
private void	readUiExtensions(Map<UiExtensionType,List<String>> uiExtensions, UiExtensionType uiExtensionType, JarFile jarFile, JarEntry jarEntry)
void	start()
private void	startUpFailure(Throwable t)
void	stop()
private void	unloadApp(BundleCoordinate bundleCoordinate, org.eclipse.jetty.deploy.App app)
void	unloadExtensionUis(Collection<Bundle> bundles)
private void	unloadExtensionUis(Bundle bundle)

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final org.slf4j.Logger logger

ALLOWED_CONTEXT_PATHS_PARAMETER

private static final String ALLOWED_CONTEXT_PATHS_PARAMETER

See Also:

• Constant Field Values

CONTAINER_JAR_PATTERN

private static final String CONTAINER_JAR_PATTERN

See Also:

• Constant Field Values

CONTEXT_PATH_ALL

private static final String CONTEXT_PATH_ALL

See Also:

• Constant Field Values

CONTEXT_PATH_NIFI

private static final String CONTEXT_PATH_NIFI

See Also:

• Constant Field Values

CONTEXT_PATH_NIFI_API

private static final String CONTEXT_PATH_NIFI_API

See Also:

• Constant Field Values

REQUIRED_CONTEXT_PATHS

private static final Set<String> REQUIRED_CONTEXT_PATHS

REQUEST_FILTER_PROVIDER

private static final RequestFilterProvider REQUEST_FILTER_PROVIDER

REST_API_REQUEST_FILTER_PROVIDER

private static final RequestFilterProvider REST_API_REQUEST_FILTER_PROVIDER

NAR_PROVIDER_PREFIX

private static final String NAR_PROVIDER_PREFIX

See Also:

• Constant Field Values

NAR_PROVIDER_POLL_INTERVAL_PROPERTY

private static final String NAR_PROVIDER_POLL_INTERVAL_PROPERTY

See Also:

• Constant Field Values

NAR_PROVIDER_CONFLICT_RESOLUTION

private static final String NAR_PROVIDER_CONFLICT_RESOLUTION

See Also:

• Constant Field Values

NAR_PROVIDER_RESTRAIN_PROPERTY

private static final String NAR_PROVIDER_RESTRAIN_PROPERTY

See Also:

• Constant Field Values

NAR_PROVIDER_IMPLEMENTATION_PROPERTY

private static final String NAR_PROVIDER_IMPLEMENTATION_PROPERTY

See Also:

• Constant Field Values

DEFAULT_NAR_PROVIDER_POLL_INTERVAL

private static final String DEFAULT_NAR_PROVIDER_POLL_INTERVAL

See Also:

• Constant Field Values

DEFAULT_NAR_PROVIDER_CONFLICT_RESOLUTION

private static final String DEFAULT_NAR_PROVIDER_CONFLICT_RESOLUTION

See Also:

• Constant Field Values

NAR_DEPENDENCIES_PATH

private static final String NAR_DEPENDENCIES_PATH

See Also:

• Constant Field Values

WAR_EXTENSION

private static final String WAR_EXTENSION

See Also:

• Constant Field Values

WEB_APP_MAX_FORM_CONTENT_SIZE

private static final int WEB_APP_MAX_FORM_CONTENT_SIZE

See Also:

• Constant Field Values

APPLICATION_PATH

private static final String APPLICATION_PATH

See Also:

• Constant Field Values

HTTPS_SCHEME

private static final String HTTPS_SCHEME

See Also:

• Constant Field Values

HTTP_SCHEME

private static final String HTTP_SCHEME

See Also:

• Constant Field Values

HOST_UNSPECIFIED

private static final String HOST_UNSPECIFIED

See Also:

• Constant Field Values

SPRING_SECURITY_FILTER_CHAIN

private static final String SPRING_SECURITY_FILTER_CHAIN

See Also:

• Constant Field Values

EXTENSION_UI_POLL_INTERVAL

private static final Duration EXTENSION_UI_POLL_INTERVAL

deploymentManager

private final org.eclipse.jetty.deploy.DeploymentManager deploymentManager

server

private org.eclipse.jetty.server.Server server

props

private NiFiProperties props

sslContext

private SSLContext sslContext

systemBundle

private Bundle systemBundle

bundles

private Set<Bundle> bundles

extensionMapping

private ExtensionMapping extensionMapping

narAutoLoader

private NarAutoLoader narAutoLoader

narProviderService

private ExternalResourceProviderService narProviderService

diagnosticsFactory

private DiagnosticsFactory diagnosticsFactory

decommissionTask

private DecommissionTask decommissionTask

statusHistoryDumpFactory

private StatusHistoryDumpFactory statusHistoryDumpFactory

clusterDetailsFactory

private ClusterDetailsFactory clusterDetailsFactory

webApiContext

private org.eclipse.jetty.ee10.webapp.WebAppContext webApiContext

contentViewerWebContexts

private Collection<org.eclipse.jetty.ee10.webapp.WebAppContext> contentViewerWebContexts

contentViewers

private Collection<ContentViewer> contentViewers

componentUiExtensions

private UiExtensionMapping componentUiExtensions

componentUiExtensionWebContexts

private Collection<org.eclipse.jetty.ee10.webapp.WebAppContext> componentUiExtensionWebContexts

appsByBundleCoordinate

private final Map<BundleCoordinate,List<org.eclipse.jetty.deploy.App>> appsByBundleCoordinate

extensionUisToLoad

private final BlockingQueue<Bundle> extensionUisToLoad

extensionUiLoadTask

private final JettyServer.ExtensionUiLoadTask extensionUiLoadTask

Constructor Details

JettyServer

public JettyServer()

Default no-arg constructor for ServiceLoader

Method Details

init

public void init()

clearWorkingDirectory

private void clearWorkingDirectory()

loadInitialWars

private org.eclipse.jetty.server.Handler loadInitialWars(Set<Bundle> bundles)

loadExtensionUis

public void loadExtensionUis(Collection<Bundle> bundles)

Specified by:

loadExtensionUis in interface ExtensionUiLoader

processExtensionUiBundle

private void processExtensionUiBundle(Bundle bundle)

unloadExtensionUis

public void unloadExtensionUis(Collection<Bundle> bundles)

Specified by:

unloadExtensionUis in interface ExtensionUiLoader

unloadExtensionUis

private void unloadExtensionUis(Bundle bundle)

unloadApp

private void unloadApp(BundleCoordinate bundleCoordinate,
 org.eclipse.jetty.deploy.App app)

loadWars

private JettyServer.ExtensionUiInfo loadWars(Map<File,Bundle> warToBundleLookup)

containsUiExtensionType

private boolean containsUiExtensionType(List<UiExtension> componentUiExtensionsForType,
 UiExtensionType extensionType)

Returns whether or not the specified ui extensions already contains an extension of the specified type.

Parameters:

componentUiExtensionsForType - ui extensions for the type

extensionType - type of ui extension

Returns:

whether or not the specified ui extensions already contains an extension of the specified type

findWars

private Map<File,Bundle> findWars(Set<Bundle> bundles)

readUiExtensions

private void readUiExtensions(Map<UiExtensionType,List<String>> uiExtensions,
 UiExtensionType uiExtensionType,
 JarFile jarFile,
 JarEntry jarEntry)
                       throws IOException

Throws:

IOException

identifyUiExtensionsForComponents

private void identifyUiExtensionsForComponents(Map<UiExtensionType,List<String>> uiExtensions,
 File warFile)

Identifies all known UI extensions and stores them in the specified map.

Parameters:

uiExtensions - extensions

warFile - war

extractComponentType

private String extractComponentType(String line)

Extracts the component type. Trims the line and considers comments. Returns null if no type was found.

Parameters:

line - line

Returns:

type

loadWar

private org.eclipse.jetty.ee10.webapp.WebAppContext loadWar(File warFile,
 String contextPath,
 ClassLoader parentClassLoader)

getWebAppTempDirectory

private File getWebAppTempDirectory(File warFile)

addDocsServlets

private void addDocsServlets(org.eclipse.jetty.ee10.webapp.WebAppContext webAppContext)

getDocsDir

private File getDocsDir()

Returns a File object for the directory containing NIFI documentation.

Formerly, if the docsDirectory did not exist NIFI would fail to start with an IllegalStateException and a rather unhelpful log message. NIFI-2184 updates the process such that if the docsDirectory does not exist an attempt will be made to create the directory. If that is successful NIFI will no longer fail and will start successfully barring any other errors. The side effect of the docsDirectory not being present is that the documentation links under the 'General' portion of the help page will not be accessible, but at least the process will be running.

Returns:

A File object to the documentation directory; else startUpFailure called.

getWebApiDocsDir

private File getWebApiDocsDir()

getApplicationUrls

protected List<URI> getApplicationUrls()

start

public void start()

Specified by:

start in interface NiFiServer

buildExternalResourceProviders

private Map<String,ExternalResourceProvider> buildExternalResourceProviders(SSLContext sslContext,
 ExtensionManager extensionManager,
 Predicate<ExternalResourceDescriptor> filter)
                                                                     throws ClassNotFoundException,
InstantiationException,
IllegalAccessException,
InvocationTargetException,
NoSuchMethodException

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException

InvocationTargetException

NoSuchMethodException

createProviderInstance

private ExternalResourceProvider createProviderInstance(ExtensionManager extensionManager,
 String providerClass,
 String providerId,
 ExternalResourceProviderInitializationContext context)
                                                 throws InstantiationException,
IllegalAccessException,
ClassNotFoundException,
InvocationTargetException,
NoSuchMethodException

In case the provider class is not an implementation of ExternalResourceProvider the method tries to instantiate it as a NarProvider. NarProvider instances are wrapped into an adapter in order to envelope the support.

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException

InvocationTargetException

NoSuchMethodException

getDiagnosticsFactory

public DiagnosticsFactory getDiagnosticsFactory()

Specified by:

getDiagnosticsFactory in interface NiFiServer

getThreadDumpFactory

public DiagnosticsFactory getThreadDumpFactory()

Specified by:

getThreadDumpFactory in interface NiFiServer

getDecommissionTask

public DecommissionTask getDecommissionTask()

Specified by:

getDecommissionTask in interface NiFiServer

getClusterDetailsFactory

public ClusterDetailsFactory getClusterDetailsFactory()

Specified by:

getClusterDetailsFactory in interface NiFiServer

getStatusHistoryDumpFactory

public StatusHistoryDumpFactory getStatusHistoryDumpFactory()

Specified by:

getStatusHistoryDumpFactory in interface NiFiServer

performInjectionForComponentUis

private void performInjectionForComponentUis(Collection<org.eclipse.jetty.ee10.webapp.WebAppContext> componentUiExtensionWebContexts,
 NiFiWebConfigurationContext configurationContext,
 org.eclipse.jetty.ee10.servlet.FilterHolder securityFilter)

performInjectionForContentViewerUis

private void performInjectionForContentViewerUis(Collection<org.eclipse.jetty.ee10.webapp.WebAppContext> contentViewerWebContexts,
 org.springframework.web.context.WebApplicationContext webApiApplicationContext,
 org.eclipse.jetty.ee10.servlet.FilterHolder securityFilter)

startUpFailure

private void startUpFailure(Throwable t)

initialize

public void initialize(NiFiProperties properties,
 Bundle systemBundle,
 Set<Bundle> bundles,
 ExtensionMapping extensionMapping)

Specified by:

initialize in interface NiFiServer

stop

public void stop()

Specified by:

stop in interface NiFiServer

getErrorHandler

private org.eclipse.jetty.ee10.servlet.ErrorPageErrorHandler getErrorHandler()