Configuration properties reference
From JPPF 6.3 Documentation
|
Main Page > Configuration properties reference |
1 Driver properties
| Name | Default value | Description |
| jppf.discovery.broadcast.exclude.ipv4 | null | Prevent broadcast to the specified IPv4 addresses (exclusive filter, server only) |
| jppf.discovery.broadcast.exclude.ipv6 | null | Prevent broadcast to the specified IPv6 addresses (exclusive filter, server only) |
| jppf.discovery.broadcast.include.ipv4 | null | Broadcast to the specified IPv4 addresses (inclusive filter, server only) |
| jppf.discovery.broadcast.include.ipv6 | null | Broadcast to the specified IPv6 addresses (inclusive filter, server only) |
| jppf.discovery.broadcast.interval | 5000 | UDP broadcast interval in milliseconds |
| jppf.discovery.enabled | true | Enable/disable server discovery via UDP multicast |
| jppf.java.path | null | Full path to the Java executable |
| jppf.jvm.options | null | JVM options for the node or server process |
| jppf.load.balancing.algorithm | proportional | Load balancing algorithm name |
| jppf.load.balancing.persistence | null | Class name of the implementation of a load-balancer persistence in the driver or client, with optional parameters |
| jppf.load.balancing.persistence.hash | SHA-1 | The hash function used to generate load-balancer state identifiers |
| jppf.load.balancing.profile | jppf | Load balancing parameters profile name |
| jppf.local.node.bias | true | Whether bias towards local node for scheduling is enabled in the driver |
| jppf.local.node.enabled | false | Whether to enable a node to run in the same JVM as the driver |
| jppf.management.enabled | true | Enable/disable management of the node or server |
| jppf.management.server.forwarder | null | Fully qualifed class name of a MBeanServerForwarder implementation with optional space-separated string parameters |
| jppf.management.ssl.enabled | false | Deprecated: management is now enabled on both plain and secure connections via "jppf.management.enabled" Enable/disable JMX via secure connections |
| jppf.management.ssl.port | 11193 | Deprecated: the secure management port is now the same as the server port given in "jppf.ssl.server.port" Secure JMX server port |
| jppf.node.idle | true | Whether a node is idle. This property is only set within a server. |
| jppf.node.management.port | 11198 | Node management port (to distinguish from server management port when local node is on) |
| jppf.node.max.jobs | Integer.MAX_VALUE | Maximum number of jobs that can be handled concurrently by a node |
| jppf.peer.<peer_name>.pool.size | 1 | Connection pool size for a manually configured peer driver connection - peer_name: one of the names defined in 'jppf.peers' |
| jppf.peer.<peer_name>.recovery.enabled | false | Heartbeat enabled flag for a manually configured peer driver connection. - peer_name: one of the names defined in 'jppf.peers' |
| jppf.peer.<peer_name>.server.host | localhost | Server host for a manually configured peer driver connection - peer_name: one of the names defined in 'jppf.peers' |
| jppf.peer.<peer_name>.server.port | 11111 | Server port for a manually configured peer driver connection - peer_name: one of the names defined in 'jppf.peers' |
| jppf.peer.<peer_name>.ssl.enabled | false | SSL enabled flag for a manually configured peer driver connection - peer_name: one of the names defined in 'jppf.peers' |
| jppf.peer.allow.orphans | false | Whether to send jobs to orphan peer servers |
| jppf.peer.discovery.enabled | false | Enable/disable peer server discovery |
| jppf.peer.pool.size | 1 | Size of discovered peer server connection pools |
| jppf.peer.recovery.enabled | false | Heartbeat enabled flag for a discovered peer driver connection. |
| jppf.peer.ssl.enabled | false | Toggle secure connections to remote peer servers |
| jppf.peers | null | Space-separated list of peer server names |
| jppf.peers.load.balance.threshold | Integer.MAX_VALUE | The number of connected nodes below which this driver load-balances to other peer drivers |
| jppf.recovery.enabled | false | Enable/disable recovery from hardware failures through a heartbeat mechanism |
| jppf.recovery.max.retries | 3 | Maximum number of pings to the node before the connection is considered broken |
| jppf.recovery.read.timeout | 15000 | Maximum ping response time from the node |
| jppf.recovery.reaper.pool.size | available processors | Number of threads allocated to the node connection reaper |
| jppf.redirect.err | null | File to redirect System.err to |
| jppf.redirect.err.append | false | Append to existing file (true) or create a new one (false) |
| jppf.redirect.out | null | File to redirect System.out to |
| jppf.redirect.out.append | false | Append to existing file (true) or create a new one (false) |
| jppf.resolve.addresses | true | Whether to resolve IP addresses |
| jppf.server.exitOnShutdown | false | Whether to exit the JVM when shutting the driver down |
| jppf.server.port | 11111 | Server port |
| jppf.ssl.client.distinct.truststore | false | Whether to use a separate trust store for client certificates (server only) |
| jppf.ssl.client.truststore.file | null | Path to the client trust store in the file system or classpath |
| jppf.ssl.configuration.file | null | Path to the SSL configuration in the file system or classpath |
| jppf.ssl.configuration.source | null | SSL configuration as an arbitrary source |
| jppf.ssl.enabled | false | Enabled/disable secure connections |
| jppf.ssl.server.port | -1 | Server port number for secure connections |
2 Node properties
| Name | Default value | Description |
| jppf.classloader.cache.size | 50 | Size of the class loader cache for the node |
| jppf.classloader.delegation | parent | Class loader delegation mode: 'parent' or 'url' |
| jppf.classloader.file.lookup | true | Enable/disable lookup of classpath resources in the file system |
| jppf.config.overrides.path | config/config-overrides.properties | Path to the temporary config overrides properties file |
| jppf.discovery.enabled | true | Enable/disable server discovery via UDP multicast |
| jppf.discovery.exclude.ipv4 | null | IPv4 exclusion patterns for server discovery |
| jppf.discovery.exclude.ipv6 | null | IPv6 exclusion patterns for server discovery |
| jppf.discovery.group | 230.0.0.1 | Server discovery: UDP multicast group |
| jppf.discovery.include.ipv4 | null | IPv4 inclusion patterns for server discovery |
| jppf.discovery.include.ipv6 | null | IPv6 inclusion patterns for server discovery |
| jppf.discovery.port | 11111 | Server discovery: UDP multicast port |
| jppf.discovery.timeout | 1000 | Server discovery timeout in milliseconds |
| jppf.idle.interruptIfRunning | true | Node idle mode: whether to shutdown the node at once when user activity resumes or wait until the node is no longer executing tasks |
| jppf.idle.mode.enabled | false | Enable/disable the idle mode |
| jppf.idle.poll.interval | 1000 | Node idle mode: how often the node will check for keyboard and mouse inactivity |
| jppf.idle.timeout | 300000 | Node idle mode: the time of keyboard and mouse inactivity before considering the node idle |
| jppf.java.path | null | Full path to the Java executable |
| jppf.jvm.options | null | JVM options for the node or server process |
| jppf.management.enabled | true | Enable/disable management of the node or server |
| jppf.management.host | null | Management server host |
| jppf.management.port | 11198 | Management remote connector port |
| jppf.management.server.forwarder | null | Fully qualifed class name of a MBeanServerForwarder implementation with optional space-separated string parameters |
| jppf.node.android | false | Whether the node is an Android node |
| jppf.node.classloading.batch.period | 100 | How often batched class loading requests are sent to the server |
| jppf.node.management.port | 11198 | Node management port (to distinguish from server management port when local node is on) |
| jppf.node.max.jobs | Integer.MAX_VALUE | Maximum number of jobs that can be handled concurrently by a node |
| jppf.node.offline | false | Whether the node runs in offline mode |
| jppf.node.provisioning.master | true | Whether the node is a master node |
| jppf.node.provisioning.master.uuid | null | UUID of the master node for a given slave node |
| jppf.node.provisioning.slave | false | Whether the node is a slave node |
| jppf.node.provisioning.slave.config.path | config | Directory where slave-specific configuration files are located |
| jppf.node.provisioning.slave.id | -1 | Id of a slave node generated by/scoped by its master. Unique within a single master's scope. Associate with "jppf.node.provisioning.master.uuid" to provide a globally unique id. |
| jppf.node.provisioning.slave.jvm.options | null | JVM options always added to the slave startup command |
| jppf.node.provisioning.slave.path.prefix | slave_nodes/node_ | Path prefix for the root directory of slave nodes |
| jppf.node.provisioning.startup.overrides.file | null | Path to an optional config overrides file for slaves launched at startup |
| jppf.node.provisioning.startup.overrides.source | null | An optional config overrides source (name of a class implementing org.jppf.utils.JPPFConfiguration.ConfigurationSourceReader or org.jppf.utils.JPPFConfiguration.ConfigurationSource) for slaves launched at startup |
| jppf.node.provisioning.startup.slaves | 0 | Number of slaves to launch upon master node startup |
| jppf.node.throttling.check.period | 2000 | How often the node throttling mechanism will check, expressed as an interval in milliseconds |
| jppf.processing.threads | available processors | Number of processing threads in the node |
| jppf.recovery.enabled | false | Enable/disable recovery from hardware failures through a heartbeat mechanism |
| jppf.redirect.err | null | File to redirect System.err to |
| jppf.redirect.err.append | false | Append to existing file (true) or create a new one (false) |
| jppf.redirect.out | null | File to redirect System.out to |
| jppf.redirect.out.append | false | Append to existing file (true) or create a new one (false) |
| jppf.resolve.addresses | true | Whether to resolve IP addresses |
| jppf.resource.cache.dir | sys.property "java.io.tmpdir" | Root location of the file-persisted caches |
| jppf.resource.cache.enabled | true | Whether the class loader resource cache is enabled |
| jppf.resource.cache.storage | file | Type of cache storage: either 'file' or 'memory' |
| jppf.server.connection.strategy | null | Fully qualified name of a class implementing org.jppf.node.connection.DriverConnectionStrategy |
| jppf.server.host | localhost | Server host name or IP address |
| jppf.server.port | 11111 | Server port |
| jppf.ssl.configuration.file | null | Path to the SSL configuration in the file system or classpath |
| jppf.ssl.configuration.source | null | SSL configuration as an arbitrary source |
| jppf.ssl.enabled | false | Enabled/disable secure connections |
| jppf.thread.manager.class | default | Type of thread pool to use in the node: either 'default' or 'org.jppf.server.node.fj.ThreadManagerForkJoin' |
3 Node screensaver properties
| Name | Default value | Description |
| jppf.screensaver.centerimage | org/jppf/node/jppf@home.gif | Path to the larger image at the center of the screen (built-in default screensaver) |
| jppf.screensaver.class | null | Class name of an implementation of org.jppf.node.screensaver.JPPFScreenSaver |
| jppf.screensaver.enabled | false | Enable/disable the screen saver |
| jppf.screensaver.fullscreen | false | Whether to display the screen saver in full screen mode |
| jppf.screensaver.handle.collisions | true | Handle collisions between moving logos (built-in default screensaver) |
| jppf.screensaver.height | 800 | Height in pixels (windowed mode) |
| jppf.screensaver.icon | org/jppf/node/jppf-icon.gif | Path to the image for the frame's icon (windowed mode) |
| jppf.screensaver.location.x | 0 | Screensaver's on-screen X coordinate (windowed mode) |
| jppf.screensaver.location.y | 0 | Screensaver's on-screen Y coordinate (windowed mode) |
| jppf.screensaver.logo.path | org/jppf/node/jppf_group_small.gif | Path(s) to the moving logo image(s) (built-in default screensaver) |
| jppf.screensaver.logos | 10 | Number of moving moving logos (built-in default screensaver) |
| jppf.screensaver.mouse.motion.close | true | Whether to close the screensaver on mouse motion (full screen mode) |
| jppf.screensaver.mouse.motion.delay | 500 | internal use |
| jppf.screensaver.node.listener | null | Class name of an implementation of org.jppf.node.screensaver.NodeIntegration |
| jppf.screensaver.speed | 100 | Speed of moving moving logos! from 1 to 100 (built-in default screensaver) |
| jppf.screensaver.status.panel.alignment | center | Hhorizontal alignment of the status panel (built-in default screensaver) |
| jppf.screensaver.title | JPPF screensaver | Title of the screensaver's JFrame in windowed mode |
| jppf.screensaver.width | 1000 | Width in pixels (windowed mode) |
4 Client properties
| Name | Default value | Description |
| <driver_name>.jppf.jmx.pool.size | 1 | Manually defined JMX connection pool size for a client-to-driver connection - driver_name: one of the driver names in 'jppf.drivers' |
| <driver_name>.jppf.max.jobs | Integer.MAX_VALUE | Manually defined maximum number of jobs that can be handled concurrently by a single connection - driver_name: one of the driver names in 'jppf.drivers' |
| <driver_name>.jppf.pool.size | 1 | Manually defined connection pool size for a client-to-driver connection - driver_name: one of the driver names in 'jppf.drivers' |
| <driver_name>.jppf.priority | 0 | Manually defined priority for a client-to-driver connection - driver_name: one of the driver names in 'jppf.drivers' |
| <driver_name>.jppf.recovery.enabled | false | Heartbeat enabled flag for a manually configured peer client connection - driver_name: one of the driver names in 'jppf.drivers' |
| <driver_name>.jppf.server.host | localhost | Manually defined driver host for a client-to-driver connection - driver_name: one of the driver names in 'jppf.drivers' |
| <driver_name>.jppf.server.port | 11111 | Manually defined driver port for a client-to-driver connection - driver_name: one of the driver names in 'jppf.drivers' |
| <driver_name>.jppf.ssl.enabled | false | Manually defined SSL enabled flag for a client-to-driver connection - driver_name: one of the driver names in 'jppf.drivers' |
| jppf.client.sysout.enabled | true | Whether the client should print connection events to stdout |
| jppf.discovery.acceptMultipleInterfaces | false | Whether to discover server connections from multiple network interfaces |
| jppf.discovery.enabled | true | Enable/disable server discovery via UDP multicast |
| jppf.discovery.exclude.ipv4 | null | IPv4 exclusion patterns for server discovery |
| jppf.discovery.exclude.ipv6 | null | IPv6 exclusion patterns for server discovery |
| jppf.discovery.group | 230.0.0.1 | Server discovery: UDP multicast group |
| jppf.discovery.include.ipv4 | null | IPv4 inclusion patterns for server discovery |
| jppf.discovery.include.ipv6 | null | IPv6 inclusion patterns for server discovery |
| jppf.discovery.port | 11111 | Server discovery: UDP multicast port |
| jppf.discovery.priority | 0 | Priority assigned to discovered server connections (client/admiin console) |
| jppf.discovery.timeout | 1000 | Server discovery timeout in milliseconds |
| jppf.drivers | default-driver | Names of the manually configured servers in the client |
| jppf.jmx.pool.size | 1 | JMX connection pool size when discovery is enabled |
| jppf.job.client.sla.default.policy | null | A default client-side execution policy to associate with submitted jobs when they don't have one |
| jppf.job.sla.default.policy | null | A default driver-side execution policy to associate with submitted jobs when they don't have one |
| jppf.load.balancing.algorithm | proportional | Load balancing algorithm name |
| jppf.load.balancing.persistence | null | Class name of the implementation of a load-balancer persistence in the driver or client, with optional parameters |
| jppf.load.balancing.persistence.hash | SHA-1 | The hash function used to generate load-balancer state identifiers |
| jppf.load.balancing.profile | jppf | Load balancing parameters profile name |
| jppf.local.execution.enabled | false | Enable/disable local execution in the client |
| jppf.local.execution.priority | 0 | Priority assigned to the client local executor |
| jppf.local.execution.threads | available processors | Maximum threads to use for local execution |
| jppf.max.jobs | Integer.MAX_VALUE | Maximum number of jobs that can be handled concurrently by a single connection for server connections discovered via UDP multicast |
| jppf.pool.size | 1 | Connection pool size for server connections discovered via UDP multicast |
| jppf.recovery.enabled | false | Enable/disable recovery from hardware failures through a heartbeat mechanism |
| jppf.remote.execution.enabled | true | Enable/disable remote execution (client only) |
| jppf.resolve.addresses | true | Whether to resolve IP addresses |
| jppf.server.host | localhost | Server host name or IP address |
| jppf.server.port | 11111 | Server port |
| jppf.ssl.configuration.file | null | Path to the SSL configuration in the file system or classpath |
| jppf.ssl.configuration.source | null | SSL configuration as an arbitrary source |
| jppf.ssl.enabled | false | Enabled/disable secure connections |
5 Desktop console properties
| Name | Default value | Description |
| jppf.admin.console.view.<view_name>.addto | Main | The built-in view a pluggable view is attached to. It must be one of the tabbed panes of the admin console. Possible values: Main | Topology | Charts - view_name: a user-assigned name for the view |
| jppf.admin.console.view.<view_name>.autoselect | false | Whether to automatically select the pluggable view - view_name: a user-assigned name for the view |
| jppf.admin.console.view.<view_name>.class | null | Name of a pluggable view class, extending org.jppf.ui.plugin.PluggableView - view_name: a user-assigned name for the view |
| jppf.admin.console.view.<view_name>.enabled | true | Enable / disable a pluggable view - view_name: a user-assigned name for the view |
| jppf.admin.console.view.<view_name>.icon | null | Path to the icon for a pluggable view, seen as the tab icon - view_name: a user-assigned name for the view |
| jppf.admin.console.view.<view_name>.position | -1 | The position at which a pluggable view is inserted withing the enclosing tabbed pane. A negative value means insert at the end - view_name: a user-assigned name for the view |
| jppf.admin.console.view.<view_name>.title | null | The title for the view, seen as the tab label - view_name: a user-assigned name for the view |
| jppf.ui.default.scrollbar.thickness | 10 | The default thickness of the scrollbars in the GUI |
| jppf.ui.splash | true | Whether to display the animated splash screen at console startup, defaults to false |
| jppf.ui.splash.delay | 500 | Interval between images in milliseconds |
| jppf.ui.splash.images | null | One or more paths to the images displayed in a rolling sequence (like a slide show), separated by '|' (pipe) characters |
| jppf.ui.splash.message | empty string | The fixed text displayed at center of the splash screen |
| jppf.ui.splash.message.color | 64, 64, 128 | The color of the fixed text displayed at center of the splash screen, as an 'r, g, b' or 'r, g, b, a' value |
6 Web console properties
| Name | Default value | Description |
| jppf.web.admin.refresh.interval | 3 | Interval in seconds between 2 refreshes of a page in the web admin console |
7 Desktop and Web consoles properties
| Name | Default value | Description |
| jppf.admin.refresh.interval.health | 3000 | Interval between updates of the JVM health data |
| jppf.admin.refresh.interval.stats | 1000 | Interval between updates of the server statistics |
| jppf.admin.refresh.interval.topology | 1000 | Interval between updates of the topology views |
| jppf.admin.refresh.system.info | false | Wether to refresh the nodes' system info as well (to use for node filtering on the client side) |
| jppf.gui.publish.mode | immediate_notifications | UI refresh mode for the job data panel: 'immediate_notifications' | 'deferred_notifications' | 'polling' |
| jppf.gui.publish.period | 1000 | Interval between updates of the job data view |
8 Common properties
| Name | Default value | Description |
| jppf.check.low.memory | true | Whether to check for low memory and trigger disk offloading |
| jppf.classloader.file.lookup | true | Enable/disable lookup of classpath resources in the file system |
| jppf.disk.overflow.threshold | 2.0 | Ratio of available heap over the size of an object to deserialize, below which disk overflow is triggered |
| jppf.gc.on.disk.overflow | true | Whether to call System.gc() and recompute the avalaible heap size before triggering disk overflow |
| jppf.jmxremote.protocol | jppf | The JMX remote protocol |
| jppf.length.buffer.pool.size | 100 | Temporary buffer pool size for reading lengths as ints (size 4) |
| jppf.low.memory.threshold | 32 | Minimum heap size in MB below which disk overflow is systematically triggered, to avoid heap fragmentation and ensure there's enough memory to deserialize job headers |
| jppf.notification.offload.memory.threshold | 80% of max heap size | Used heap in bytes above which notifications from task are offloaded to file. Defaults to 0.8 * maxHeapSize. |
| jppf.object.serialization.class | null | Serialization scheme: name of a class implementing org.jppf.serialization.JPPFSerialization |
| jppf.reconnect.initial.delay | 0 | Delay in seconds before the first (re)connection attempt |
| jppf.reconnect.interval | 1 | Frequency in seconds of reconnection attempts |
| jppf.reconnect.max.time | 60 | Time in seconds after which reconnection attempts stop. A negative value means never stop |
| jppf.resource.cache.dir | sys.property "java.io.tmpdir" | Root location of the file-persisted caches |
| jppf.script.default.language | javascript | Default script language for scripted property values |
| jppf.socket.buffer.size | 32768 | Receive/send buffer size for socket connections |
| jppf.socket.keepalive | false | Enable/disable socket keepalive |
| jppf.socket.max-idle | -1 | Seconds a socket connection can remain idle before being closed (client only) |
| jppf.socket.tcp_nodelay | true | Enable/disable Nagle's algorithm |
| jppf.temp.buffer.pool.size | 10 | Maximum size of temporary buffers pool |
| jppf.temp.buffer.size | 32768 | Size of temporary buffers used in I/O transfers |
9 .Net properties
| Name | Default value | Description |
| jppf.dotnet.bridge.initialized | false | Deprecated: jppf.dotnet.bridge.initialized.deprecated Whether the node is .Net-enabled |
10 SSL/TLS properties
| Name | Default value | Description |
| jppf.ssl.cipher.suites | null | Space-separated enabled cipher suites |
| jppf.ssl.client.auth | none | SSL client authentication level: 'none' | 'want' | 'need' |
| jppf.ssl.client.distinct.truststore | false | Whether to use a separate trust store for client certificates (server only) |
| jppf.ssl.client.truststore.file | null | Path to the client trust store in the file system or classpath |
| jppf.ssl.client.truststore.password | null | Plain text client trust store password |
| jppf.ssl.client.truststore.password.source | null | Client trust store password as an arbitrary source |
| jppf.ssl.client.truststore.source | null | Client trust store location as an arbitrary source |
| jppf.ssl.client.truststore.type | jks | Client trust store format, e.g. 'JKS' |
| jppf.ssl.context.protocol | TLSv1.2 | javax.net.ssl.SSLContext protocol |
| jppf.ssl.keystore.file | null | Path to the key store in the file system or classpath |
| jppf.ssl.keystore.password | null | Plain text key store password |
| jppf.ssl.keystore.password.source | null | Key store password as an arbitrary source |
| jppf.ssl.keystore.source | null | Key store location as an arbitrary source |
| jppf.ssl.keystore.type | jks | Key store format, e.g. 'JKS' |
| jppf.ssl.protocols | null | A list of space-separated enabled protocols |
| jppf.ssl.truststore.file | null | Path to the trust store in the file system or classpath |
| jppf.ssl.truststore.password | null | Plain text trust store password |
| jppf.ssl.truststore.password.source | null | Trust store password as an arbitrary source |
| jppf.ssl.truststore.source | null | Trust store location as an arbitrary source |
| jppf.ssl.truststore.type | jks | Trust store format, e.g. 'JKS' |
11 Memory usage optimization properties
| Name | Default value | Description |
| jppf.check.low.memory | true | Whether to check for low memory and trigger disk offloading |
| jppf.disk.overflow.threshold | 2.0 | Ratio of available heap over the size of an object to deserialize, below which disk overflow is triggered |
| jppf.gc.on.disk.overflow | true | Whether to call System.gc() and recompute the avalaible heap size before triggering disk overflow |
| jppf.low.memory.threshold | 32 | Minimum heap size in MB below which disk overflow is systematically triggered, to avoid heap fragmentation and ensure there's enough memory to deserialize job headers |
| jppf.notification.offload.memory.threshold | 80% of max heap size | Used heap in bytes above which notifications from task are offloaded to file. Defaults to 0.8 * maxHeapSize. |
| Main Page > Configuration properties reference |
