|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.connection.configuration.AbstractConnectionConfiguration
public abstract class AbstractConnectionConfiguration
AbstractConnectionConfiguration
is an abstract class which implements
common methods assuming that real container can hold only string values.
It is used in all concrete implementations such as KeyValueConfiguration or
PropertyConfiguration.
KeyValueConfiguration
,
PropertyConfiguration
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.genesyslab.platform.commons.connection.configuration.ClientADDPOptions |
---|
ClientADDPOptions.AddpTraceMode |
Field Summary |
---|
Fields inherited from interface com.genesyslab.platform.commons.connection.configuration.ClientConnectionOptions |
---|
IP_VERSION_4_6, IP_VERSION_6_4 |
Constructor Summary | |
---|---|
AbstractConnectionConfiguration()
|
Method Summary | |
---|---|
ConnectionConfiguration |
clone()
|
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 |
getBoolean(java.lang.String name)
Returns boolean parameter value. |
boolean |
getBoolean(java.lang.String name,
boolean defaultValue)
Returns boolean parameter value. |
java.lang.Integer |
getInteger(java.lang.String name)
Gets integer parameter value from the configuration. |
java.lang.Integer |
getInteger(java.lang.String name,
java.lang.Integer defaultValue)
Gets integer parameter value from the configuration. |
java.lang.String |
getIPVersion()
|
java.lang.String |
getLocalBindingHost()
Returns hostname or network interface to be used for client socket local binding. |
java.lang.Integer |
getLocalBindingPort()
Returns TCP/IP port to be used for client socket local binding. |
java.lang.String |
getOption(java.lang.String name)
Gets string parameter value from the configuration. |
java.lang.String |
getStringsEncoding()
Returns charset encoding name which represents encoding on the other side of the connection. |
java.lang.String |
getTLSVersion()
Deprecated. |
boolean |
isIPv6Enabled()
|
boolean |
isTLSEnabled()
Checks if a security protocol is enabled. |
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 |
setBoolean(java.lang.String name,
boolean value)
Sets boolean parameter in the configuration. |
void |
setInteger(java.lang.String name,
java.lang.Integer value)
Sets integer parameter in the configuration. |
void |
setIPv6Enabled(boolean enableIPv6)
|
void |
setIPVersion(java.lang.String ipVersion)
Sets IP version selection order for address resolution. |
void |
setLocalBindingHost(java.lang.String localBindingHost)
Sets hostname or network interface to be used for client socket local binding. |
void |
setLocalBindingPort(java.lang.Integer localBindingPort)
Sets TCP/IP port to be used for client socket local binding. |
void |
setStringsEncoding(java.lang.String stringsEncoding)
Sets charset encoding name which represents encoding on the other side of the connection. |
void |
setTLSEnabled(boolean enabled)
Sets "TLS enabled" flag. |
void |
setTLSVersion(java.lang.String tlsVersion)
Deprecated. |
void |
setUseAddp(boolean useAddp)
Sets ADDP protocol enabling flag. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.genesyslab.platform.commons.connection.configuration.ConnectionConfiguration |
---|
getOption, setOption |
Constructor Detail |
---|
public AbstractConnectionConfiguration()
Method Detail |
---|
public java.lang.String getOption(java.lang.String name)
null
.
getOption
in interface ConnectionConfiguration
name
- name (key) of the parameter
public boolean getBoolean(java.lang.String name)
getBoolean
in interface ConnectionConfiguration
name
- name of an option
public boolean getBoolean(java.lang.String name, boolean defaultValue)
getBoolean
in interface ConnectionConfiguration
name
- name of an optiondefaultValue
- value returned when there is no such option or
option could not be parsed.
public java.lang.Integer getInteger(java.lang.String name)
null
.
getInteger
in interface ConnectionConfiguration
name
- name (key) of the parameter
public java.lang.Integer getInteger(java.lang.String name, java.lang.Integer defaultValue)
getInteger
in interface ConnectionConfiguration
name
- name (key) of the parameterdefaultValue
- value to return if parameter is not found
public void setBoolean(java.lang.String name, boolean value)
setBoolean
in interface ConnectionConfiguration
name
- name (key) of the parametervalue
- boolean value to setpublic void setInteger(java.lang.String name, java.lang.Integer value)
setInteger
in interface ConnectionConfiguration
name
- name (key) of the parametervalue
- integer value to setpublic ConnectionConfiguration clone() throws java.lang.CloneNotSupportedException
clone
in interface ConnectionConfiguration
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public void setStringsEncoding(java.lang.String stringsEncoding)
ClientConnectionOptions
null
means that client and server use the same encoding.
setStringsEncoding
in interface ClientConnectionOptions
stringsEncoding
- server side charset encoding or nullpublic java.lang.String getStringsEncoding()
ClientConnectionOptions
getStringsEncoding
in interface ClientConnectionOptions
public void setLocalBindingHost(java.lang.String localBindingHost)
ClientConnectionOptions
setLocalBindingHost
in interface ClientConnectionOptions
localBindingHost
- local binding host for client protocol connection or nullpublic java.lang.String getLocalBindingHost()
ClientConnectionOptions
getLocalBindingHost
in interface ClientConnectionOptions
public void setLocalBindingPort(java.lang.Integer localBindingPort)
ClientConnectionOptions
setLocalBindingPort
in interface ClientConnectionOptions
localBindingPort
- local binding port for client protocol connection or nullpublic java.lang.Integer getLocalBindingPort()
ClientConnectionOptions
getLocalBindingPort
in interface ClientConnectionOptions
public void setIPv6Enabled(boolean enableIPv6)
setIPv6Enabled
in interface ClientConnectionOptions
public boolean isIPv6Enabled()
isIPv6Enabled
in interface ClientConnectionOptions
public void setIPVersion(java.lang.String ipVersion)
ClientConnectionOptions
setIPVersion
in interface ClientConnectionOptions
ipVersion
- IP versions orderClientConnectionOptions.IP_VERSION_4_6
,
ClientConnectionOptions.IP_VERSION_6_4
public java.lang.String getIPVersion()
getIPVersion
in interface ClientConnectionOptions
public void setUseAddp(boolean useAddp)
ClientADDPOptions
setUseAddp
in interface ClientADDPOptions
useAddp
- ADDP enabling flagpublic boolean isUseAddp()
ClientADDPOptions
isUseAddp
in interface ClientADDPOptions
public void setAddpClientTimeout(java.lang.Integer timeout)
ClientADDPOptions
setAddpClientTimeout
in interface ClientADDPOptions
timeout
- client side timeout (seconds)ClientADDPOptions.setUseAddp(boolean)
,
ClientADDPOptions.setAddpTraceMode(AddpTraceMode)
public java.lang.Integer getAddpClientTimeout()
ClientADDPOptions
getAddpClientTimeout
in interface ClientADDPOptions
ClientADDPOptions.setUseAddp(boolean)
public void setAddpServerTimeout(java.lang.Integer timeout)
ClientADDPOptions
setAddpServerTimeout
in interface ClientADDPOptions
timeout
- server side timeout (seconds)ClientADDPOptions.setUseAddp(boolean)
,
ClientADDPOptions.setAddpTraceMode(AddpTraceMode)
public java.lang.Integer getAddpServerTimeout()
ClientADDPOptions
getAddpServerTimeout
in interface ClientADDPOptions
ClientADDPOptions.isUseAddp()
@Deprecated public void setAddpTrace(java.lang.String traceMode)
"local"
(or "true"
, "yes"
, "on"
) -
log ADDP traces on client side only,"remote"
- query server to log ADDP traces in server logs,"both"
(or "full"
) - log ADDP traces on client side and
query server to log ADDP traces in server logs,"none"
or any illegal value - do not log ADDP traces.
setAddpTrace
in interface ClientADDPOptions
traceMode
- ADDP tracing option valuesetUseAddp(boolean)
,
ClientADDPOptions.setAddpTraceMode(AddpTraceMode)
@Deprecated public java.lang.String getAddpTrace()
getAddpTrace
in interface ClientADDPOptions
setAddpTrace(String)
,
getAddpTraceMode()
public void setAddpTraceMode(ClientADDPOptions.AddpTraceMode traceMode)
setAddpTraceMode
in interface ClientADDPOptions
traceMode
- ADDP trace mode property valuesetUseAddp(boolean)
public ClientADDPOptions.AddpTraceMode getAddpTraceMode()
getAddpTraceMode
in interface ClientADDPOptions
ClientADDPOptions.setAddpTraceMode(AddpTraceMode)
public void setTLSEnabled(boolean enabled)
ClientConnectionOptions
setTLSEnabled
in interface ClientConnectionOptions
enabled
- "TLS enabled" flagpublic boolean isTLSEnabled()
ClientConnectionOptions
isTLSEnabled
in interface ClientConnectionOptions
@Deprecated public java.lang.String getTLSVersion()
@Deprecated public void setTLSVersion(java.lang.String tlsVersion)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |