public interface ServerConfig extends RootConfig
When in a server VM the server configuration may be obtained using
ConfigManager.getServerConfig()
This is server side only. Properties common to the server and client environments are defined by the supertype.
Modifier and Type | Method and Description |
---|---|
ConnectorConfig |
addConnector(String name)
Add a connector.
|
PublisherConfig |
addPublisher(String publisherName,
String className)
Adds a new Publisher to the list of configured Publishers.
|
WebServerConfig |
addWebServer(String webServerName)
Add a new Web Server Configuration.
|
AutoDeploymentConfig |
getAutoDeployment()
Gets the Auto Deployment Configuration details.
|
ConflationConfig |
getConflation()
Get the conflation configuration.
|
ConnectorConfig |
getConnector(String name)
Get the configuration for a named connector.
|
List<ConnectorConfig> |
getConnectors()
Returns the list of connectors defined for this server.
|
FanOutConfig |
getFanOut()
Get the FanOut configuration.
|
GeoIpConfig |
getGeoIp()
Gets the Geo IP config details.
|
HooksConfig |
getHooks()
Gets the Server Hooks Configuration.
|
LoggingConfig |
getLogging()
Get the logging configuration.
|
ManagementConfig |
getManagement()
Get Management configuration.
|
MimesConfig |
getMimes()
Get mime types configuration.
|
MultiplexerConfig |
getMultiplexerConfiguration()
Get the multiplexer configuration.
|
PublisherConfig |
getPublisher(String publisherName)
Returns a named publisher configuration.
|
List<PublisherConfig> |
getPublishers()
Returns the list of Publishers defined for this server.
|
QueuesConfig |
getQueues()
Gets the queues configuration details.
|
ReplicationConfig |
getReplication()
Get replication configuration.
|
SecurityConfig |
getSecurity()
Gets the security configuration details.
|
SelectorThreadPoolsConfig |
getSelectorThreadPools()
Gets the selector thread pools configuration.
|
String |
getServerName()
Returns the server name.
|
StatisticsConfig |
getStatistics()
Get statistics configuration.
|
UserLibrariesConfig |
getUserLibraries()
Gets the user library configuration.
|
WebServerConfig |
getWebServer(String webServerName)
Get a named Web Server configuration.
|
List<WebServerConfig> |
getWebServers()
Gets the list of configured web servers.
|
WhoIsConfig |
getWhois()
Gets the WhoIs configuration details.
|
MultiplexerConfig |
setMultiplexerConfiguration(MultiplexerConfig config)
Sets the multiplexer configuration.
|
void |
setServerName(String name)
Sets the server name.
|
addMultiplexer, getCharset, getDefaultDeltaMessageCapacity, getDefaultLoadMessageCapacity, getDefaultMultiplexerDefinition, getFormatting, getMaximumMessageSize, getMessageLengthSize, getMultiplexer, getMultiplexers, getNumberOfReadSelectors, getThreads, getTimeouts, getWriteSelectors, isClient, isLoggingMessageData, isServer, setCharset, setDefaultDeltaMessageCapacity, setDefaultLoadMessageCapacity, setDefaultMultiplexerDefinition, setLogMessageData, setMaximumMessageSize, setMessageLengthSize, setNumberOfReadSelectors
void setServerName(String name) throws ConfigException
The server name is used to identify this server if running in a cluster. This will also be used as a prefix for client IDs.
If not specified the local host name will be used.
name
- the server nameConfigException
- if unable to set the server nameString getServerName()
List<ConnectorConfig> getConnectors()
ConnectorConfig getConnector(String name)
name
- the connector nameConnectorConfig addConnector(String name) throws ConfigException
Connectors may only be configured before the server is started.
name
- the connector nameConfigException
- if unable to add connectorMultiplexerConfig setMultiplexerConfiguration(MultiplexerConfig config) throws ConfigException
config
- multiplexer configurationConfigException
MultiplexerConfig getMultiplexerConfiguration()
List<PublisherConfig> getPublishers()
PublisherConfig getPublisher(String publisherName)
publisherName
- the publisher namePublisherConfig addPublisher(String publisherName, String className) throws ConfigException
Publishers must be configured before the server is started (though additional Publisher can be dynamically deployed at runtime).
publisherName
- the name of the Publisher. This must be different
from any existing Publisher.className
- The full class name of a Java class that implements the
Publisher. This class must extend the Java API Publisher class and
provide implementations of methods as required. The class file
must be available on the classpath of the Diffusion Server (or in
the usr-lib or ext folder).ConfigException
- if there is already a Publisher defined with the
given name or class name invalid.List<WebServerConfig> getWebServers()
WebServerConfig getWebServer(String webServerName)
webServerName
- the web server nameWebServerConfig addWebServer(String webServerName) throws ConfigException
Web server configurations are used to specify the Web server behaviour of connectors that wish to handle HTTP connections or act as file servers.
webServerName
- the Web Server Name which must be unique.ConfigException
- if unable to add Web Server configurationSecurityConfig getSecurity()
This allows server specific security details such as the name of an authorisation handler class.
WhoIsConfig getWhois()
This allows details relating to the Who Is service to be defined. The service is used to resolve client connection information.
AutoDeploymentConfig getAutoDeployment()
This allows details relating to the automatic deplyment of Publishers to be defined.
GeoIpConfig getGeoIp()
This allows details relating o the GeoIp database to be defined. Normally this would not need to be changed in any way as default behaviour is usually what is required.
UserLibrariesConfig getUserLibraries()
This allows a set of user libraries from which user written code may be loaded to be defined.
HooksConfig getHooks()
This allows server hooks such as startUp and shutDown hooks to be defined.
ManagementConfig getManagement()
This allows system management details to be defined.
MimesConfig getMimes()
Common mime types used in HTTP deployments.
StatisticsConfig getStatistics()
Allows the statistics that are to be produced to be configured.
At this point in time this is minimal.
ReplicationConfig getReplication()
The replication configuration is used to control the replication of sessions or topics across a cluster.
ConflationConfig getConflation()
This allows conflation properties to be configured.
LoggingConfig getLogging()
This allows logging properties to be configured.
SelectorThreadPoolsConfig getSelectorThreadPools()
FanOutConfig getFanOut()
This is used to configure a secondary server to connect to a primary server in fan out mode.
QueuesConfig getQueues()
This allows queue definitions to be configured.
Copyright © 2016 Push Technology Ltd. All Rights Reserved.