Package | Description |
---|---|
com.pushtechnology.diffusion.api.config |
Diffusion Configuration API
|
com.pushtechnology.diffusion.api.server |
Diffusion Embedded Server API
|
Modifier and Type | Method and Description |
---|---|
FanOutConnectionConfig |
FanOutConfig.addConnection(String name,
String url)
Add a new connection to a primary server.
|
ConnectionValidationPolicyConfig |
ConnectorConfig.addConnectionValidationPolicy(String name)
Add a new connection validation policy for the connector.
|
ConnectorConfig |
ServerConfig.addConnector(String name)
Add a connector.
|
void |
UserLibrariesConfig.addDirectory(String directory)
Add a user directory.
|
HTTPServiceConfig |
WebServerConfig.addHTTPService(String name,
String className,
String urlPattern)
Add an HTTP Service.
|
void |
ConnectorConfig.addIgnoreErrorsFrom(String ipAddress)
Add an IP address to ignore errors from.
|
FanOutLinkConfig |
FanOutConnectionConfig.addLink(String name,
String selector)
Adds a topic tree link to be replicated.
|
ValidationPolicyLocaleConfig |
ValidationPolicyConfig.addLocale(String country,
String language)
Adds a Locale to the policy.
|
LogConfig |
LoggingConfig.addLog(String name)
Deprecated.
since 6.4.0. This setting is used to configure the Diffusion
log implementation, which is deprecated in favor of Log4j 2.
The Diffusion log implementation will be removed in a future
release, together with this setting.
|
MimeConfig |
MimesConfig.addMime(String extension,
String type)
Add a mime.
|
ThreadPoolConfig |
ThreadsConfig.addPool(String name)
Add a new thread pool definition.
|
SelectorThreadPoolConfig |
SelectorThreadPoolsConfig.addPool(String name,
int size)
Add a selector thread pool to the set of those available.
|
PropertyConfig |
HTTPServiceConfig.addProperty(String name,
String value)
Add a service property.
|
PropertyConfig |
HTTPServiceConfig.addProperty(String name,
String type,
String value)
Add a service property.
|
QueueConfig |
QueuesConfig.addQueue(String name)
Add a queue definition.
|
VirtualHostRealmConfig |
VirtualHostConfig.addRealm(String name,
String path)
Add a realm.
|
VirtualHostRealmUserConfig |
VirtualHostRealmConfig.addUser(String name,
String password)
Add a realm user.
|
VirtualHostConfig |
FileServiceConfig.addVirtualHost(String name,
String host,
String documentRoot,
String homePage)
Add a new virtual host configuration.
|
WebServerConfig |
ServerConfig.addWebServer(String webServerName)
Add a new Web Server Configuration.
|
ClientServiceConfig |
WebServerConfig.removeClientService()
Remove Client Service.
|
FileServiceConfig |
WebServerConfig.removeFileService()
Remove File Service.
|
HTTPServiceConfig |
WebServerConfig.removeHTTPService(String name)
Remove a named HTTP Service.
|
LogConfig |
LoggingConfig.removeLog(String name)
Deprecated.
since 6.4.0. This setting is used to configure the Diffusion
log implementation, which is deprecated in favor of Log4j 2.
The Diffusion log implementation will be removed in a future
release, together with this setting.
|
VirtualHostRealmConfig |
VirtualHostConfig.removeRealm(String name)
Remove a named realm.
|
VirtualHostRealmUserConfig |
VirtualHostRealmConfig.removeUser(String name)
Remove a realm user.
|
VirtualHostConfig |
FileServiceConfig.removeVirtualHost(String name)
Remove virtual host.
|
void |
VirtualHostConfig.setAliasFile(String aliasFile)
Sets the alias file.
|
void |
LoggingConfig.setAsyncLogging(boolean asyncLogging)
Deprecated.
since 6.4.0. This setting is used to configure the Diffusion
log implementation, which is deprecated in favor of Log4j 2.
The Diffusion log implementation will be removed in a future
release, together with this setting.
|
void |
SecurityConfig.setAuthenticationHandlers(List<? extends AuthenticationHandlerConfig> handlers)
Authentication handlers, in order of decreasing precedence.
|
void |
ThreadsConfig.setBackgroundPoolSize(int size)
Sets the number of threads to use for the background thread pool.
|
void |
ConnectorConfig.setBacklog(int backlog)
Sets the backlog.
|
void |
WhoIsConfig.setCacheMaximumSize(int maximum)
Deprecated.
Sets the maximum size of the WhoIs cache.
|
void |
WhoIsConfig.setCacheRetentionTime(long retention)
Deprecated.
Sets retention time for WhoIs cache entries.
|
void |
VirtualHostCacheConfig.setCacheSizeLimit(int limit)
Sets the cache size limit.
|
void |
WhoIsConfig.setCacheTidyInterval(long interval)
Deprecated.
Sets the WhoIs cache tidy interval.
|
ClientServiceConfig |
WebServerConfig.setClientService(String name)
Add a client service.
|
void |
SessionConfig.setCompressionSchemes(Set<SessionConfig.CompressionScheme> schemes)
Set the compression schemes supported by this connector.
|
void |
VirtualHostConfig.setCompressionThreshold(int threshold)
Sets the compression threshold.
|
void |
QueueConfig.setConflates(boolean conflates)
Sets whether the queue has conflation enabled by default.
|
void |
ManagementConfig.setConnectionPort(int port)
Sets the JMX service port.
|
void |
FanOutConnectionConfig.setConnectionTimeout(int timeout)
Sets the connection timeout.
|
void |
TimeoutsConfig.setConnectionTimeout(long timeout)
Sets the connection timeout.
|
void |
ConnectorConfig.setConnectionTimeout(long timeout)
Sets the connection timeout for inbound connections.
|
void |
LoggingConfig.setConsoleLogLevel(LogDescription.LogLevel level)
Sets the console log level.
|
void |
LoggingConfig.setConsoleMonitoredLog(String path)
Sets the console monitored log path.
|
void |
ClientServiceConfig.setCookieDisabled(boolean disabled)
Sets the session cookie as enabled/disabled.
|
void |
ThreadPoolConfig.setCoreSize(int size)
Deprecated.
since 6.5, thread pools do not grow; this setting is no
longer used and will be removed in a future release
|
void |
ClientServiceConfig.setCORSOrigin(String origin)
Sets the CORS origin.
|
void |
LogConfig.setDateFormat(String dateFormat)
Deprecated.
Specifies a date format to use for formatting dates used in the %d part
of the file pattern (see {link
LogConfig.setFilePattern(String) ). |
void |
FormattingConfig.setDateFormat(String format)
Deprecated.
Sets the date format.
|
void |
FormattingConfig.setDateTimeFormat(String format)
Deprecated.
Sets the date and time format.
|
void |
VirtualHostConfig.setDebug(boolean debug)
Sets debug option.
|
void |
VirtualHostCacheConfig.setDebug(boolean debug)
Sets debug option.
|
void |
LoggingConfig.setDefaultLogDirectory(String directory)
Sets the default log directory path.
|
void |
QueuesConfig.setDefaultQueue(String queueDefinition)
Sets the name of the default queue definition.
|
void |
SelectorThreadPoolsConfig.setDefaultSelectorThreadPool(String defaultPoolName)
Sets the thread pool definition to use as default selector thread pool.
|
void |
WhoIsConfig.setEnabled(boolean enabled)
Deprecated.
Set WhoIs enabled.
|
void |
PersistenceConfig.setEnabled(boolean enabled)
Enable or disable the persistence service.
|
void |
ManagementConfig.setEnabled(boolean enabled)
Sets whether or not a remote JMX Connector is enabled or not.
|
void |
GeoIpConfig.setEnabled(boolean enabled)
Sets enabled flag.
|
void |
VirtualHostConfig.setErrorPage(String errorPage)
Sets the error page.
|
void |
TopicReplicationConfig.setExcludedPaths(Set<String> excludedPaths)
Set the excluded paths.
|
void |
ReplicationConfig.setExternalHost(String host)
Optionally override the host name that peer servers should use to connect
to this server.
|
void |
ReplicationConfig.setExternalPort(Integer port)
Optionally override the port that peer servers should use to connect to
this server.
|
void |
KeyStoreConfig.setFile(String keyStoreFile)
Sets the file path of the KeyStore.
|
void |
LogConfig.setFileAppend(boolean append)
Deprecated.
Sets the file append option.
|
void |
LogConfig.setFileCount(int fileCount)
Deprecated.
Sets the file count.
|
void |
VirtualHostCacheConfig.setFileLifeTime(long lifeTime)
Sets the file lifetime.
|
void |
LogConfig.setFileLimit(int limit)
Deprecated.
Sets the file limit.
|
void |
GeoIpConfig.setFileName(String fileName)
Sets the name of the Maxmind GeoCityIP city file.
|
void |
LogConfig.setFilePattern(String filePattern)
Deprecated.
Sets the file pattern.
|
FileServiceConfig |
WebServerConfig.setFileService(String name)
Add a file service.
|
void |
VirtualHostCacheConfig.setFileSizeLimit(int limit)
Sets the file size limit.
|
void |
WhoIsConfig.setHost(String host)
Deprecated.
Sets the whois host.
|
void |
ManagementConfig.setHost(String host)
Set the host.
|
void |
ConnectorConfig.setHost(String host)
Sets the host address to bind to.
|
void |
ThreadsConfig.setInboundPool(String poolDefinition)
Sets the thread pool definition to use for the inbound thread pool.
|
void |
TopicReplicationConfig.setIncludedPaths(Set<String> includedPaths)
Set the paths of the topic tree to include for replication.
|
void |
SocketConditioningConfig.setInputBufferSize(int size)
Sets the input buffer size.
|
void |
FanOutConnectionConfig.setInputBufferSize(int size)
Sets the input buffer size for the connection.
|
void |
SocketConditioningConfig.setKeepAlive(boolean keepAlive)
Sets the TCP keep alive option.
|
void |
ThreadPoolConfig.setKeepAlive(long keepAliveTime)
Deprecated.
since 6.5, thread pools do not grow; this setting is no
longer used and will be removed in a future release
|
void |
ReconnectConfig.setKeepAlive(long keepAlive)
Sets the keep alive value.
|
void |
ManagementConfig.setKeystoreConfig(KeyStoreConfig keystoreConfig)
Sets the keystore configuration.
|
void |
MultiplexerConfig.setLatencyWarning(long latencyValue)
Sets the latency warning threshold.
|
void |
LogConfig.setLevel(LogDescription.LogLevel level)
Deprecated.
Sets the starting log level.
|
void |
HTTPServiceConfig.setLog(String log)
Sets the log file.
|
void |
LogConfig.setLogDirectory(String directory)
Deprecated.
Sets the log directory.
|
void |
LoggingConfig.setLoggingQueueSize(int size)
Deprecated.
since 6.4.0. This setting is used to configure the Diffusion
log implementation, which is deprecated in favor of Log4j 2.
The Diffusion log implementation will be removed in a future
release, together with this setting.
|
void |
LoggingConfig.setLogThreadNames(boolean threadNameLogging)
Deprecated.
since 6.4.0. This setting is used to configure the Diffusion
log implementation, which is deprecated in favor of Log4j 2.
The Diffusion log implementation will be removed in a future
release, together with this setting.
|
void |
QueueConfig.setLowerThreshold(int threshold)
Sets the lower threshold.
|
void |
KeyStoreConfig.setMandatory(boolean mandatory)
Sets if keyStore is mandatory.
|
void |
QueueConfig.setMaximumBytes(long maximumBytes)
Sets the maximum size of the outbound message queue in bytes.
|
void |
QueueConfig.setMaximumDepth(int maximumDepth)
Sets the maximum depth of the queue.
|
void |
MultiplexerConfig.setMaximumEventQueueSize(int size)
Sets the maximum event queue size.
|
void |
HTTPServiceConfig.setMaximumInboundRequestSize(int maxSize)
Sets maximum inbound request size.
|
void |
ClientServiceConfig.setMaximumInboundRequestSize(int maxSize)
Sets the maximum inbound request size.
|
void |
ServerConfig.setMaximumMessageSize(int maxMessageSize)
Sets the maximum message size.
|
void |
SessionConfig.setMaximumQueuedBytes(long maximumQueuedBytes)
Sets the maximum number of bytes that can be used by all outbound message
queues of sessions using this connector.
|
void |
ReconnectConfig.setMaximumQueueDepth(int maxDepth)
Sets the maximum queue depth value.
|
void |
FanOutConnectionConfig.setMaximumQueueSize(int queueSize)
Sets the maximum queue size for messages queued to be sent to the primary
server.
|
void |
ThreadPoolConfig.setMaximumSize(int size)
Deprecated.
since 6.5, thread pools do not grow; this setting is no
longer used and will be removed in a future release
|
void |
ClientServiceConfig.setMessageSequenceTimeout(long timeout)
Sets the message sequence timeout.
|
void |
VirtualHostConfig.setMinify(boolean minify)
Sets minify option.
|
void |
MultiplexerConfig.setMonitorPeriod(long period)
Sets the multiplexer progress monitoring period.
|
void |
SocketConditioningConfig.setNoDelay(boolean noDelay)
Sets the no delay option.
|
void |
SocketConditioningConfig.setOutputBufferSize(int size)
Sets the output buffer size.
|
void |
FanOutConnectionConfig.setOutputBufferSize(int size)
Sets the output buffer size.
|
void |
ClientStatisticsConfig.setOutputFrequency(long frequency)
Sets the output frequency for statistics reports to the log.
|
void |
KeyStoreConfig.setPassword(String password)
Sets the keyStore password.
|
void |
FanOutConnectionConfig.setPassword(String password)
Sets a password to be used when authenticating with the primary server.
|
void |
ServerConfig.setPersistenceDirectory(String path)
Sets the name of a directory under which persistent files will be
maintained.
|
void |
WhoIsConfig.setPort(int port)
Deprecated.
Sets the WhoIs port.
|
void |
ConnectorConfig.setPort(int port)
Sets the port that the connector binds to.
|
void |
FanOutConnectionConfig.setPrincipal(String principal)
Sets the security principal to use when authenticating with the primary
server.
|
void |
ConnectorConfig.setProtocols(Set<ConnectorConfig.Protocol> protocols)
Sets the client protocols supported by this connector.
|
void |
WhoIsConfig.setProvider(String className)
Deprecated.
Sets the provider class.
|
void |
ConnectorConfig.setProxyProtocol(ConnectorConfig.ProxyProtocol protocol)
Sets the proxy protocol required for connection.
|
void |
SessionConfig.setQueueDefinition(String queueDefinition)
Sets the queue definition.
|
void |
ThreadPoolConfig.setQueueSize(int size)
Sets the queue size.
|
void |
ReplicationConfig.setQuorum(int quorum)
Sets the quorum size.
|
void |
FanOutConnectionConfig.setReconnectTimeout(int timeout)
Sets the overall reconnection timeout value.
|
void |
ReconnectConfig.setRecoveryBufferSize(int size)
Set the maximum number of sent messages that can be recovered on
reconnection.
|
void |
FanOutConnectionConfig.setRecoveryBufferSize(int size)
Set the recovery buffer size.
|
void |
ManagementConfig.setRegistryPort(int port)
Sets the RMI registry port.
|
void |
ConnectorConfig.setRequired(boolean required)
Sets a boolean value to specify if the connector is required on startup.
|
void |
ClientStatisticsConfig.setResetFrequency(long frequency)
Sets the reset frequency
|
void |
FanOutConnectionConfig.setRetryDelay(int delay)
Specifies the number of milliseconds to wait after failing to connect or
losing the connection to the primary server before trying to connect
again.
|
void |
SocketConditioningConfig.setReuseAddress(boolean reuseAddress)
Sets the reuse address option.
|
void |
LogConfig.setRotationPeriod(int period,
TimeUnit unit)
Deprecated.
Set the rotation period of the log file.
|
void |
ConnectorConfig.setSelectorThreadPoolDefinition(String definitionName)
Sets the thread pool definition.
|
void |
LoggingConfig.setServerLog(String serverLog)
Deprecated.
since 6.4.0. This setting is used to configure the Diffusion
log implementation, which is deprecated in favor of Log4j 2.
The Diffusion log implementation will be removed in a future
release, together with this setting.
|
void |
ServerConfig.setServerName(String name)
Sets the server name.
|
void |
HooksConfig.setShutdownHook(String className)
Sets the value of the shutdownHook property.
|
void |
ThreadPoolConfig.setSize(int size)
Sets the pool size.
|
void |
MultiplexerConfig.setSize(int size)
Sets the number of multiplexer threads.
|
void |
ConnectorConfig.setStartConditions(List<? extends ConnectorConfig.StartCondition> conditions)
Sets the conditions that must be satisfied before the connector is
automatically started.
|
void |
HooksConfig.setStartupHook(String className)
Sets the start up hook.
|
void |
VirtualHostConfig.setStatic(boolean isStatic)
Sets static option.
|
void |
PersistenceConfig.setStoreDirectory(String path)
Deprecated.
since 6.3
Use |
void |
SessionConfig.setSystemPingFrequency(long frequency)
Sets the system ping frequency.
|
void |
ConnectorConfig.setThreadPoolDefinition(String definitionName)
Sets the thread pool definition.
|
void |
WhoIsConfig.setThreads(int numberOfThreads)
Deprecated.
Sets the number of resolver threads used by the WhoIs service.
|
void |
FormattingConfig.setTimeFormat(String format)
Deprecated.
Sets the time format.
|
void |
FormattingConfig.setTimestampFormat(String format)
Deprecated.
Sets the timestamp format.
|
void |
MimeConfig.setType(String type)
Sets the associated mime type.
|
void |
QueueConfig.setUpperThreshold(int threshold)
Sets the upper threshold.
|
void |
ConnectorConfig.setValidationPolicyFile(String validationPolicyFile)
Sets a validation policy file.
|
void |
ConnectorConfig.setWebServer(String webServerName)
Sets the Web Server.
|
void |
ClientServiceConfig.setWebsocketOrigin(String origin)
Sets the WebSocket origin patten.
|
void |
FanOutConnectionConfig.setWriteTimeout(int timeout)
Sets the write timeout value.
|
void |
TimeoutsConfig.setWriteTimeout(long timeout)
Sets the value of the write timeout for blocking write operations.
|
void |
FileServiceConfig.setWriteTimeout(long timeout)
Sets the write timeout.
|
void |
LogConfig.setXmlFormat(boolean xmlFormat)
Deprecated.
Sets the XML format option.
|
Constructor and Description |
---|
DiffusionServer()
Constructor.
|
DiffusionServer(Properties bootstrapProps)
Constructor.
|
DiffusionServer(Properties bootstrapProps,
boolean embedded)
Constructor.
|
DiffusionServer(String propertiesDirectory,
boolean embedded)
Constructor.
|
Copyright © 2021 Push Technology Ltd. All Rights Reserved.