Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.commons.protocols
Class ProtocolConfiguration

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.commons.protocols.ProtocolConfiguration
Direct Known Subclasses:
BasicChatConfiguration, CallbackConfiguration, ConfServerConfiguration, EmailConfiguration, EspEmailConfiguration, FlexChatConfiguration, InteractionServerConfiguration, LcaConfiguration, MessageServerConfiguration, OutboundServerConfiguration, RoutingCustomServerConfiguration, ScsConfiguration, StatServerConfiguration, TServerConfiguration, UcsConfiguration

Deprecated. Use Endpoint to manage protocol's configuration.

@Deprecated
public abstract class ProtocolConfiguration
extends java.lang.Object

Protocol Manager Application Block is deprecated.

See Also:
ClientConnectionOptions, ClientADDPOptions, PropertyConfiguration, KeyValueConfiguration, Endpoint, WarmStandbyConfiguration, ClientConfigurationHelper

Constructor Summary
protected ProtocolConfiguration(java.lang.String name, java.lang.Class protocolType)
          Deprecated.  
 
Method Summary
 java.lang.Integer getAddpClientTimeout()
          Deprecated.  
 java.lang.Integer getAddpServerTimeout()
          Deprecated.  
 java.lang.String getAddpTrace()
          Deprecated.  
 javax.net.ssl.SSLContext getBackupSSLContext()
          Deprecated.  
 SSLExtendedOptions getBackupSSLOptions()
          Deprecated.  
 FaultToleranceMode getFaultTolerance()
          Deprecated.  
 java.lang.String getLocalBindingHost()
          Deprecated.  
 java.lang.Integer getLocalBindingPort()
          Deprecated.  
 java.lang.String getName()
          Deprecated.  
 javax.net.ssl.SSLContext getPrimarySSLContext()
          Deprecated.  
 SSLExtendedOptions getPrimarySSLOptions()
          Deprecated.  
protected  java.lang.Class getProtocolType()
          Deprecated.  
 java.net.URI getUri()
          Deprecated.  
 java.lang.Short getWarmStandbyAttempts()
          Deprecated. Get the number of reconnection attempts for Warm Standby.
 java.lang.Short getWarmStandbySwitchovers()
          Deprecated. Get the number of primary/backup switchovers for Warm Standby.
 java.lang.Integer getWarmStandbyTimeout()
          Deprecated. Get the timeout (in milliseconds) between the reconnection attempts for Warm Standby.
 java.net.URI getWarmStandbyUri()
          Deprecated. Get the standby URI for Warm Standby.
 java.lang.Boolean isBackupTLSEnabled()
          Deprecated.  
 java.lang.Boolean isPrimaryTLSEnabled()
          Deprecated.  
 java.lang.Boolean isUseAddp()
          Deprecated.  
 java.lang.Boolean isUseTls()
          Deprecated. TLS is configured separately with SSLContext and SSLEngine
 void setAddpClientTimeout(java.lang.Integer value)
          Deprecated.  
 void setAddpServerTimeout(java.lang.Integer value)
          Deprecated.  
 void setAddpTrace(java.lang.String value)
          Deprecated.  
 void setBackupSSLContext(javax.net.ssl.SSLContext backupSSLContext)
          Deprecated. Sets SSLContext instance to be used for warm standby backup connection.
 void setBackupSSLOptions(SSLExtendedOptions backupSSLOptions)
          Deprecated. Sets additional SSL parameters for warm standby backup connection.
 void setBackupTLSEnabled(java.lang.Boolean backupTLSEnabled)
          Deprecated. Allows/disables immediate TLS turning on upon connection to backup server.
 void setFaultTolerance(FaultToleranceMode value)
          Deprecated.  
 void setLocalBindingHost(java.lang.String localBindingHost)
          Deprecated.  
 void setLocalBindingPort(java.lang.Integer localBindingPort)
          Deprecated.  
 void setName(java.lang.String value)
          Deprecated.  
 void setPrimarySSLContext(javax.net.ssl.SSLContext primarySSLContext)
          Deprecated. Sets SSLContext instance for default server connection and/or warm standby primary connection.
 void setPrimarySSLOptions(SSLExtendedOptions primarySSLOptions)
          Deprecated. Sets additional SSL parameters for default server connection and/or warm standby primary connection.
 void setPrimaryTLSEnabled(java.lang.Boolean primaryTLSEnabled)
          Deprecated. Allows/disables immediate TLS turning on upon connection to primary server.
 void setUri(java.lang.String host, int port)
          Deprecated.  
 void setUri(java.net.URI value)
          Deprecated.  
 void setUseAddp(java.lang.Boolean value)
          Deprecated.  
 void setUseTls(java.lang.Boolean useTls)
          Deprecated. TLS is configured separately with SSLContext and SSLEngine
 void setWarmStandbyAttempts(java.lang.Short value)
          Deprecated. Set the number of reconnection attempts for Warm Standby.
 void setWarmStandbySwitchovers(java.lang.Short value)
          Deprecated. Set the number of primary/backup switchovers for Warm Standby.
 void setWarmStandbyTimeout(java.lang.Integer value)
          Deprecated. Set the new timeout value (in milliseconds) between the reconnection attempts for Warm Standby.
 void setWarmStandbyUri(java.lang.String host, int port)
          Deprecated. Set the standby URI for Warm Standby, using the host and port as parameters.
 void setWarmStandbyUri(java.net.URI value)
          Deprecated. Set the standby URI for Warm Standby.
 java.lang.String toString()
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProtocolConfiguration

protected ProtocolConfiguration(java.lang.String name,
                                java.lang.Class protocolType)
Deprecated. 
Method Detail

getProtocolType

protected final java.lang.Class getProtocolType()
Deprecated. 

getName

public final java.lang.String getName()
Deprecated. 

setName

public final void setName(java.lang.String value)
Deprecated. 

getUri

public final java.net.URI getUri()
Deprecated. 

setUri

public final void setUri(java.net.URI value)
Deprecated. 

setUri

public final void setUri(java.lang.String host,
                         int port)
Deprecated. 

getWarmStandbyUri

public final java.net.URI getWarmStandbyUri()
Deprecated. 
Get the standby URI for Warm Standby.

Returns:
standby URI

setWarmStandbyUri

public final void setWarmStandbyUri(java.net.URI value)
Deprecated. 
Set the standby URI for Warm Standby.

Parameters:
value - URI for the standby endpoint

setWarmStandbyUri

public final void setWarmStandbyUri(java.lang.String host,
                                    int port)
Deprecated. 
Set the standby URI for Warm Standby, using the host and port as parameters.

Parameters:
host - host for the standby URI
port - port number for the standby URI

getWarmStandbyAttempts

public final java.lang.Short getWarmStandbyAttempts()
Deprecated. 
Get the number of reconnection attempts for Warm Standby.

Returns:
the maximum number of reconnection attempts

setWarmStandbyAttempts

public final void setWarmStandbyAttempts(java.lang.Short value)
Deprecated. 
Set the number of reconnection attempts for Warm Standby.

Parameters:
value - the maximum number of reconnection attempts

getWarmStandbySwitchovers

public final java.lang.Short getWarmStandbySwitchovers()
Deprecated. 
Get the number of primary/backup switchovers for Warm Standby.

Returns:
the number of allowed primary/backup switchovers

setWarmStandbySwitchovers

public final void setWarmStandbySwitchovers(java.lang.Short value)
Deprecated. 
Set the number of primary/backup switchovers for Warm Standby. If this parameter is not set, or if it is set to null, then an unlimited number of switchovers are allowed. If this parameter is set to 0 then switchover will not happen.

Parameters:
value - the number of allowed primary/backup switchovers

getWarmStandbyTimeout

public final java.lang.Integer getWarmStandbyTimeout()
Deprecated. 
Get the timeout (in milliseconds) between the reconnection attempts for Warm Standby.

Returns:
the current timeout value (in milliseconds)

setWarmStandbyTimeout

public final void setWarmStandbyTimeout(java.lang.Integer value)
Deprecated. 
Set the new timeout value (in milliseconds) between the reconnection attempts for Warm Standby.

Parameters:
value - the new timeout value (in milliseconds)

getAddpClientTimeout

public final java.lang.Integer getAddpClientTimeout()
Deprecated. 

setAddpClientTimeout

public final void setAddpClientTimeout(java.lang.Integer value)
Deprecated. 

getAddpServerTimeout

public final java.lang.Integer getAddpServerTimeout()
Deprecated. 

setAddpServerTimeout

public final void setAddpServerTimeout(java.lang.Integer value)
Deprecated. 

isUseAddp

public final java.lang.Boolean isUseAddp()
Deprecated. 

setUseAddp

public final void setUseAddp(java.lang.Boolean value)
Deprecated. 

getAddpTrace

public final java.lang.String getAddpTrace()
Deprecated. 

setAddpTrace

public final void setAddpTrace(java.lang.String value)
Deprecated. 

getFaultTolerance

public final FaultToleranceMode getFaultTolerance()
Deprecated. 

setFaultTolerance

public final void setFaultTolerance(FaultToleranceMode value)
Deprecated. 

isUseTls

@Deprecated
public java.lang.Boolean isUseTls()
Deprecated. TLS is configured separately with SSLContext and SSLEngine

Returns:
true if both primaryTLSEnabled and backupTLSEnabled are set to true; false otherwise.
See Also:
SSLContextHelper, AbstractChannel.connectionContext(), ConnectionContext, ConnectionContext.setAttribute(String, Object), ConnectionContext.SSL_CONTEXT_KEY

setUseTls

@Deprecated
public void setUseTls(java.lang.Boolean useTls)
Deprecated. TLS is configured separately with SSLContext and SSLEngine

Sets value of useTls to both primaryTLSEnabled and backupTLSEnabled.

See Also:
SSLContextHelper, AbstractChannel.connectionContext(), ConnectionContext, ConnectionContext.setAttribute(String, Object), ConnectionContext.SSL_CONTEXT_KEY

getLocalBindingHost

public java.lang.String getLocalBindingHost()
Deprecated. 

setLocalBindingHost

public void setLocalBindingHost(java.lang.String localBindingHost)
Deprecated. 

getLocalBindingPort

public java.lang.Integer getLocalBindingPort()
Deprecated. 

setLocalBindingPort

public void setLocalBindingPort(java.lang.Integer localBindingPort)
Deprecated. 

isPrimaryTLSEnabled

public java.lang.Boolean isPrimaryTLSEnabled()
Deprecated. 

setPrimaryTLSEnabled

public void setPrimaryTLSEnabled(java.lang.Boolean primaryTLSEnabled)
Deprecated. 
Allows/disables immediate TLS turning on upon connection to primary server.

Parameters:
primaryTLSEnabled - If true, TLS will be immediately turned on upon connection. If false, TLS is not turned on by default, but can be turned on if autodetect feature is used.
See Also:
setFaultTolerance(FaultToleranceMode), setUri(java.net.URI), setUri(String, int)

getPrimarySSLContext

public javax.net.ssl.SSLContext getPrimarySSLContext()
Deprecated. 

setPrimarySSLContext

public void setPrimarySSLContext(javax.net.ssl.SSLContext primarySSLContext)
Deprecated. 
Sets SSLContext instance for default server connection and/or warm standby primary connection.

Parameters:
primarySSLContext - SSLContext to use for connection.
See Also:
setFaultTolerance(FaultToleranceMode), setUri(java.net.URI), setUri(String, int)

getPrimarySSLOptions

public SSLExtendedOptions getPrimarySSLOptions()
Deprecated. 

setPrimarySSLOptions

public void setPrimarySSLOptions(SSLExtendedOptions primarySSLOptions)
Deprecated. 
Sets additional SSL parameters for default server connection and/or warm standby primary connection.

Parameters:
primarySSLOptions - SSLExtendedOptions to use for connection.
See Also:
setFaultTolerance(FaultToleranceMode), setUri(java.net.URI), setUri(String, int)

isBackupTLSEnabled

public java.lang.Boolean isBackupTLSEnabled()
Deprecated. 

setBackupTLSEnabled

public void setBackupTLSEnabled(java.lang.Boolean backupTLSEnabled)
Deprecated. 
Allows/disables immediate TLS turning on upon connection to backup server.

Parameters:
backupTLSEnabled - If true, TLS will be immediately turned on upon connection. If false, TLS is not turned on by default, but can be turned on if autodetect feature is used.
See Also:
setFaultTolerance(FaultToleranceMode), setWarmStandbyUri(java.net.URI), setWarmStandbyUri(String, int)

getBackupSSLContext

public javax.net.ssl.SSLContext getBackupSSLContext()
Deprecated. 

setBackupSSLContext

public void setBackupSSLContext(javax.net.ssl.SSLContext backupSSLContext)
Deprecated. 
Sets SSLContext instance to be used for warm standby backup connection.

Parameters:
backupSSLContext - SSLContext to use for backup connection.
See Also:
setFaultTolerance(FaultToleranceMode), setWarmStandbyUri(java.net.URI), setWarmStandbyUri(String, int)

getBackupSSLOptions

public SSLExtendedOptions getBackupSSLOptions()
Deprecated. 

setBackupSSLOptions

public void setBackupSSLOptions(SSLExtendedOptions backupSSLOptions)
Deprecated. 
Sets additional SSL parameters for warm standby backup connection.

Parameters:
backupSSLOptions - SSLExtendedOptions to use for backup connection.
See Also:
setFaultTolerance(FaultToleranceMode), setWarmStandbyUri(java.net.URI), setWarmStandbyUri(String, int)

toString

public java.lang.String toString()
Deprecated. 
Overrides:
toString in class java.lang.Object

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.