docs.org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer.index.html Maven / Gradle / Ivy

Go to download





Distributed Map Cache Client Service




	Description:

	A Controller Service that starts an embedded server and listens for connections from clients. The
	server provides the ability to query the cache, add data to the cache, and remove data from the cache.



	
		Properties:
	
	In the list below, the names of required properties appear
		in bold. Any other properties (not in bold) are considered optional.
		If a property has a default value, it is indicated. If a property
		supports the use of the NiFi Expression Language (or simply,
		"expression language"), that is also indicated.

	
		Port
			
				The port to listen on for incoming connections
				Default value: 4557
				Supports expression language: false
			
		SSL Context Service
			
				If specified, this service will be used to create an SSL Context that will be used to secure communications; if not specified, communications will not be secure
				Default value: no default
				Supports expression language: false
			
		Maximum Cache Entries
			
				The maximum number of cache entries that the cache can hold
				
Default value: 10,000
				Supports expression language: false
			
		Eviction Strategy
			
				Determines which strategy should be used to evict values from the cache to make room for new entries. Valid values: 
					Least Frequently Used, Least Recently Used, and First In, First Out
				
Default value: Least Frequently Used
				Supports expression language: false
			
		Persistence Directory
			
				If specified, the cache will be persisted in the given directory; if not specified, the cache will be in-memory only
				Default value: no default (in-memory)
				Supports expression language: true - JVM and System Properties Only
			
	

	
		Below is an example of how to create a distributed map cache server for clients to connect to.
		Note that the identifier in this example is cache-server. If you are using this template
		to create your own DistributedMapCache server, replace the values in this template with values that are
		suitable for your system. Possible options for Port, Maximum Cache Entries,
		Eviction Strategy, SSL Context Service, and
		Persistence Directory
	

	<?xml version="1.0" encoding="UTF-8" ?>
<services>
    <service>
        <identifier>cache-server</identifier>
        <class>org.apache.nifi.distributed.cache.client.DistributedMapCacheServer</class>
        <property name="Port">4557</property>
        <property name="Maximum Cache Entries">10000</property>
        <property name="Eviction Strategy">Least Recently Used</property>
    </service>
</services>
	

	See Also:
	
		Distributed Map Cache Client Service
		Standard SSL Context Service