Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.connection.configuration
Interface ClientADDPOptions

All Known Subinterfaces:
ClientConnectionOptions
All Known Implementing Classes:
AbstractConnectionConfiguration, KeyValueConfiguration, ManagedConfiguration, PropertyConfiguration

public interface ClientADDPOptions

Interface to represent client side ADDP configuration properties. It represents set of typified properties which are implemented by and stored inside of AbstractConnectionConfiguration structure.

See Also:
AbstractConnectionConfiguration, PropertyConfiguration, KeyValueConfiguration

Nested Class Summary
static class ClientADDPOptions.AddpTraceMode
          Configuration option values for ADDP traces enabling in the client and server logs.
 
Method Summary
 java.lang.Integer getAddpClientTimeout()
          Returns client side ADDP timeout value in seconds or null.
 java.lang.Integer getAddpServerTimeout()
          Returns server side ADDP timeout value in seconds or null.
 java.lang.String getAddpTrace()
          Deprecated.  
 ClientADDPOptions.AddpTraceMode getAddpTraceMode()
          Configuration option value for ADDP traces enabling in the client and server logs.
 boolean isUseAddp()
          Returns ADDP protocol enabling flag.
 void setAddpClientTimeout(java.lang.Integer timeout)
          Sets client side ADDP timeout value (in seconds).
 void setAddpServerTimeout(java.lang.Integer timeout)
          Sets server side ADDP timeout value (in seconds).
 void setAddpTrace(java.lang.String traceMode)
          Deprecated.  
 void setAddpTraceMode(ClientADDPOptions.AddpTraceMode traceMode)
          Configuration option value for ADDP traces enabling in the client and server logs.
 void setUseAddp(boolean useAddp)
          Sets ADDP protocol enabling flag.
 

Method Detail

setUseAddp

void setUseAddp(boolean useAddp)
Sets ADDP protocol enabling flag.

Parameters:
useAddp - ADDP enabling flag

isUseAddp

boolean isUseAddp()
Returns ADDP protocol enabling flag.

Returns:
true if ADDP should be enabled

setAddpClientTimeout

void setAddpClientTimeout(java.lang.Integer timeout)
Sets client side ADDP timeout value (in seconds).

Parameters:
timeout - client side timeout (seconds)
See Also:
setUseAddp(boolean), setAddpTraceMode(AddpTraceMode)

getAddpClientTimeout

java.lang.Integer getAddpClientTimeout()
Returns client side ADDP timeout value in seconds or null.

Returns:
client side timeout (seconds)
See Also:
setUseAddp(boolean)

setAddpServerTimeout

void setAddpServerTimeout(java.lang.Integer timeout)
Sets server side ADDP timeout value (in seconds).

Parameters:
timeout - server side timeout (seconds)
See Also:
setUseAddp(boolean), setAddpTraceMode(AddpTraceMode)

getAddpServerTimeout

java.lang.Integer getAddpServerTimeout()
Returns server side ADDP timeout value in seconds or null.

Returns:
server side timeout (seconds) or null
See Also:
isUseAddp()

setAddpTrace

@Deprecated
void setAddpTrace(java.lang.String traceMode)
Deprecated. 

Sets configuration option value for ADDP traces enabling in the client and server logs.
Values mean:

Parameters:
traceMode - ADDP tracing option value
See Also:
setUseAddp(boolean), setAddpTraceMode(AddpTraceMode)

getAddpTrace

@Deprecated
java.lang.String getAddpTrace()
Deprecated. 

Returns configuration option value for ADDP traces enabling in the client and server logs.

Returns:
ADDP tracing option value
See Also:
setAddpTraceMode(AddpTraceMode), getAddpTraceMode()

setAddpTraceMode

void setAddpTraceMode(ClientADDPOptions.AddpTraceMode traceMode)
Configuration option value for ADDP traces enabling in the client and server logs.

Parameters:
traceMode - addp trace mode property value
See Also:
setUseAddp(boolean)

getAddpTraceMode

ClientADDPOptions.AddpTraceMode getAddpTraceMode()
Configuration option value for ADDP traces enabling in the client and server logs.

Returns:
addp trace mode property value
See Also:
setAddpTraceMode(AddpTraceMode)

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.