PublisherServerConnection
@Deprecated public interface RemoteServerConfig extends Config
Any Remote Servers configured for a Publisher will be connected to as the server starts. It is not permitted to change Remote Server configuration after the Diffusion Server has started. However, Remote Servers may be programmatically added by Publishers after the server has started using the Publisher API.
Modifier and Type | Method and Description |
---|---|
Credentials |
getCredentials()
Deprecated.
Gets the credentials for the connection.
|
PublisherServerConnectionFailPolicy |
getFailPolicy()
Deprecated.
Gets the failure policy.
|
String |
getHost()
Deprecated.
Gets the value of the host property.
|
int |
getInputBufferSize()
Deprecated.
Gets the input buffer size.
|
String |
getKeyStoreFileLocation()
Deprecated.
Gets the KeyStore file.
|
String |
getKeyStorePassword()
Deprecated.
Gets the KeyStore password.
|
int |
getOutputBufferSize()
Deprecated.
Gets the output buffer size.
|
int |
getPort()
Deprecated.
Gets the value of the port property.
|
String |
getQueueDefinition()
Deprecated.
Gets the queue definition name.
|
long |
getRetryInterval()
Deprecated.
Gets the retry interval.
|
String |
getServerName()
Deprecated.
Gets the server name.
|
boolean |
isSSL()
Deprecated.
Gets the value of the ssl property.
|
void |
setCredentials(Credentials credentials)
Deprecated.
Sets the credentials to use for the server connection
|
void |
setFailPolicy(PublisherServerConnectionFailPolicy policy)
Deprecated.
Sets the failure policy.
|
void |
setInputBufferSize(int size)
Deprecated.
Sets the size of the input buffer for the connection.
|
void |
setKeyStoreFileLocation(String keyStore)
Deprecated.
Sets the KeyStore file location.
|
void |
setKeyStorePassword(String password)
Deprecated.
Sets the KeyStore password.
|
void |
setOutputBufferSize(int size)
Deprecated.
Sets the output buffer size for the connection.
|
void |
setQueueDefinition(String definitionName)
Deprecated.
Sets the queue definition to use for the connection.
|
void |
setRetryInterval(long interval)
Deprecated.
Sets the retry interval.
|
void |
setSSL(boolean ssl)
Deprecated.
Sets the value of the ssl property.
|
String getServerName()
String getHost()
int getPort()
void setSSL(boolean ssl) throws ConfigException
If true then the connection to the server will be a secure connection over SSL. In this case the server port must represent an SSL client connector at the server. The KeyStore properties must be supplied for secure connections.
By default this is false.
ssl
- if SSL connection required.ConfigException
- if unable to set the propertyboolean isSSL()
void setKeyStoreFileLocation(String keyStore) throws ConfigException
This specifies the path of the KeyStore file defining the SSL context. This is ignored if ssl=false but must be supplied if ssl=true.
By default no KeyStore file is specified.
keyStore
- The path of the KeyStore file defining the SSL context.ConfigException
- if unable to set the propertyString getKeyStoreFileLocation()
void setKeyStorePassword(String password) throws ConfigException
This should be set if ssl=true, otherwise it is ignored.
password
- The KeyStore password. This is ignored if ssl=false.ConfigException
- if unable to set the propertyString getKeyStorePassword()
void setInputBufferSize(int size) throws ConfigException
This defines the size of the buffer used to receive messages from the remote server and should match the output buffer size used at the remote server.
If not specified then 64k is assumed.
size
- input buffer sizeConfigException
- if unable to set the propertyint getInputBufferSize()
void setOutputBufferSize(int size) throws ConfigException
This is the size of the buffer to use for ending messages to the remote server and should ideally match the input buffer size used by that server.
If this is not specified then 64k is assumed.
size
- the output buffer sizeConfigException
- if unable to set the propertyint getOutputBufferSize()
void setFailPolicy(PublisherServerConnectionFailPolicy policy) throws ConfigException
This indicates what to do if the connection can not be made to the server when the publisher starts.
If not specified then PublisherServerConnectionFailPolicy.DEFAULT
is assumed.
policy
- the failure policyConfigException
- if unable to set the propertyPublisherServerConnectionFailPolicy getFailPolicy()
void setRetryInterval(long interval) throws ConfigException
If the failure policy for a server is
PublisherServerConnectionFailPolicy.RETRY
then this is the
interval at which the connection to the server will be retried.
If not specified then 5 seconds is assumed.
interval
- in millisecondsConfigException
- if unable to set the propertylong getRetryInterval()
void setCredentials(Credentials credentials) throws ConfigException
If not specified then it is assumed that credentials are not required for the connection.
credentials
- the credentialsConfigException
- if unable to set the propertyCredentials getCredentials()
void setQueueDefinition(String definitionName) throws ConfigException
Publisher to Server connection use an outbound queue for sending messages to the remote server.
This may be specified to indicate a queue definition to use. If specified
then it must represent the name of a configured queue definition. If not
specified then the default queue
definition
is used.
definitionName
- the name of a queue definitionConfigException
- if unable to set the propertyString getQueueDefinition()
Copyright © 2016 Push Technology Ltd. All Rights Reserved.