Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons
Enum PsdkCustomization.PsdkOption

java.lang.Object
  extended by java.lang.Enum<PsdkCustomization.PsdkOption>
      extended by com.genesyslab.platform.commons.PsdkCustomization.PsdkOption
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PsdkCustomization.PsdkOption>
Enclosing class:
PsdkCustomization

public static enum PsdkCustomization.PsdkOption
extends java.lang.Enum<PsdkCustomization.PsdkOption>

Enumeration with declarations of supported Platform SDK core properties names.


Enum Constant Summary
AuthorizationTicketAcquirer
          System property "com.genesys.protocol.auth.ticket.acquirer".
ConnectionExecutorCoreThreadCount
          Redefine connection executor core thread count.
ConnExecKeepAlive
          System property "com.genesyslab.platform.commons.connection.executor.keepAliveTime".
ConnExecMaxPoolSize
          System property "com.genesyslab.platform.commons.connection.executor.maximumPoolSize".
ConnExecQueueSize
          System property "com.genesyslab.platform.commons.connection.executor.queueSize".
DefaultCharsetEncoding
          Default charset encoding for Platform SDK connections.
DisableLazyParsing
          Disable lazy parsing for a specified protocol .
DisableUnknownProtocolMessageDelivery
          Disables "unknown" incoming messages for all or for particular protocol type.
DisableXmlConfData
          Disable using XML based configuration data .
DOMDocumentBuilder
          Class name of custom Java DOM document builder factory.
KVBindingVersion
          Deprecated.  
LicenseManagerClass
          System property "com.genesyslab.platform.license".
LogConnectionTraffic
          Turn connection content traffic logging on .
NettyMaxServerBossThreads
          Option for the Netty Connection Layer implementation.
It sets limitation for maximum number of threads (maximum pool size) of the Boss Executor of the Netty connection factory.
Default value is Integer.MAX_VALUE.
NettyMaxServerWorkerThreads
          Option for the Netty Connection Layer implementation.
It sets limitation for maximum number of threads (maximum pool size) of the Worker Executor of the Netty connection factory.
Default value is Integer.MAX_VALUE.
NettyMinServerBossThreads
          Option for the Netty Connection Layer implementation.
It sets limitation for minimum number of threads (core pool size) of the Boss Executor of the Netty connection factory.
Default value is 0.
NettyMinServerWorkerThreads
          Option for the Netty Connection Layer implementation.
It sets limitation for minimum number of threads (core pool size) of the Worker Executor of the Netty connection factory.
Default value is 0.
NettyTransportType
          Option to change type of Netty "connection transport".
PsdkConnectionFactory
          PSDK Connection Layer implementation usage declaration.
Platform SDK for Java contains default Netty based implementation of the connection layer.
PsdkLoggerConsoleLevel
          Log messages level for filtering in the "simple" (console) logger factory.
Possible values are: <= 0 - prints all messages including DEBUG level; 1 - prints messages starting from INFO level - no DEBUG messages (default level); 2 - prints messages not lower than WARN level; 3 - prints only ERROR or FATAL ERROR messages; 4 - prints only FATAL ERROR messages; > 4 - do not print logs (works as NullLoggerImpl).

It represents system property "com.genesyslab.platform.commons.log.console.level".

PsdkLoggerDebug
          This option enables debug mode for the logger factory initialization logic itself.
PsdkLoggerFactory
          This option allows applications to initialize internal PSDK logging.
"Logger factory" means class name of a factory for logger objects which implements ILoggerFactory interface.
PsdkLoggerTraceMessages
          Enabling option for the Platform SDK Data Logger.
PsdkSocketAddressResolver
          Replaces default implementation of connections' Socket Address resolver.
PsdkTimerShutdownDelay
          PSDK timer shutdown delay (in milliseconds).
PsdkTlsDefaultVersion
          PSDK TLS default version.
StatServerClientCapabilities
          Enable sending of client capabilities to stat server.
SupportURIWithIncorrectSyntax
          Support URI with incorrect syntax.
TransportFactoryImpl
          Specifies default implementation of ExternalTransportFactory.
WebMediaProtocolIllegalUnicodeCharsReplacement
          System property "com.genesyslab.platform.WebMedia.illegal-unicode-chars-replacement".
WebMediaProtocolReplaceIllegalUnicodeChars
          System property "com.genesyslab.platform.WebMedia.replace-illegal-unicode-chars".
WebMediaProtocolTargetXmlVersion
          System property "com.genesyslab.platform.WebMedia.target-xml-version".
XMLTransformerFactory
          Class name of custom Java XML transformers factory.
XPathFactory
          Deprecated.  
 
Method Summary
 boolean isBrancheable()
          Returns the system properties key name of the Platform SDK Core Customization option.
 java.lang.String key()
          Returns the system properties key name of the Platform SDK Core Customization option.
static PsdkCustomization.PsdkOption valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static PsdkCustomization.PsdkOption[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

DefaultCharsetEncoding

public static final PsdkCustomization.PsdkOption DefaultCharsetEncoding
Default charset encoding for Platform SDK connections.

It may be used to adjust connections encoding in case of problem with different regional settings, different platform types, etc.

It represents system property "com.genesyslab.platform.defaultcharset".


PsdkConnectionFactory

public static final PsdkCustomization.PsdkOption PsdkConnectionFactory
PSDK Connection Layer implementation usage declaration.
Platform SDK for Java contains default Netty based implementation of the connection layer.

It represents system property "com.genesyslab.platform.commons.connection.factory.class".
Default value is "com.genesyslab.platform.commons.connection.impl.netty.NettyConnectionFactory".


NettyTransportType

public static final PsdkCustomization.PsdkOption NettyTransportType
Option to change type of Netty "connection transport".

At the moment Netty connections support two types of connection transport:

It represents system property "com.genesyslab.platform.commons.connection.impl.netty.transport".


NettyMinServerBossThreads

public static final PsdkCustomization.PsdkOption NettyMinServerBossThreads
Option for the Netty Connection Layer implementation.
It sets limitation for minimum number of threads (core pool size) of the Boss Executor of the Netty connection factory.
Default value is 0.

It represents system property "com.genesyslab.platform.commons.connection.impl.netty.min-boss-threads".


NettyMaxServerBossThreads

public static final PsdkCustomization.PsdkOption NettyMaxServerBossThreads
Option for the Netty Connection Layer implementation.
It sets limitation for maximum number of threads (maximum pool size) of the Boss Executor of the Netty connection factory.
Default value is Integer.MAX_VALUE.

It represents system property "com.genesyslab.platform.commons.connection.impl.netty.max-boss-threads".


NettyMinServerWorkerThreads

public static final PsdkCustomization.PsdkOption NettyMinServerWorkerThreads
Option for the Netty Connection Layer implementation.
It sets limitation for minimum number of threads (core pool size) of the Worker Executor of the Netty connection factory.
Default value is 0.

It represents system property "com.genesyslab.platform.commons.connection.impl.netty.min-worker-threads".


NettyMaxServerWorkerThreads

public static final PsdkCustomization.PsdkOption NettyMaxServerWorkerThreads
Option for the Netty Connection Layer implementation.
It sets limitation for maximum number of threads (maximum pool size) of the Worker Executor of the Netty connection factory.
Default value is Integer.MAX_VALUE.

It represents system property "com.genesyslab.platform.commons.connection.impl.netty.max-worker-threads".


AuthorizationTicketAcquirer

public static final PsdkCustomization.PsdkOption AuthorizationTicketAcquirer
System property "com.genesys.protocol.auth.ticket.acquirer". Use option for changing default implementation of AuthTicketAcquirer that used for acquiring authentication tickets for protocol authentication purposes. The default value is "com.genesyslab.platform.commons.protocol.auth.KerberosTicketAcquirer".
Note: the default implementation must have a default constructor.


ConnExecKeepAlive

public static final PsdkCustomization.PsdkOption ConnExecKeepAlive
System property "com.genesyslab.platform.commons.connection.executor.keepAliveTime".


ConnExecMaxPoolSize

public static final PsdkCustomization.PsdkOption ConnExecMaxPoolSize
System property "com.genesyslab.platform.commons.connection.executor.maximumPoolSize".


ConnExecQueueSize

public static final PsdkCustomization.PsdkOption ConnExecQueueSize
System property "com.genesyslab.platform.commons.connection.executor.queueSize".


LicenseManagerClass

public static final PsdkCustomization.PsdkOption LicenseManagerClass
System property "com.genesyslab.platform.license".


DOMDocumentBuilder

public static final PsdkCustomization.PsdkOption DOMDocumentBuilder
Class name of custom Java DOM document builder factory.

By default Platform SDK uses Java default document builder factory with DocumentBuilderFactory.newInstance().
Sometimes java applications may use custom/third-party DOM implementation which may lead to some issues while using it. In this case it is possible to switch Platform SDK to use specific DOM implementation instead of substituted JVM default.

Sun Java built-in default factory is "com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl".

It represents system property "com.genesyslab.platform.commons.xml-doc-builder-factory".


XMLTransformerFactory

public static final PsdkCustomization.PsdkOption XMLTransformerFactory
Class name of custom Java XML transformers factory.

By default Platform SDK uses Java default transformer factory with TransformerFactory.newInstance().
Sometimes java applications may use custom/third-party transformer implementation which may lead to some issues while using it. In this case it is possible to switch Platform SDK to use specific DOM implementation instead of substituted JVM default.

Sun Java built-in default factory is "com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl".

It represents system property "com.genesyslab.platform.commons.xml-transformer-factory".


XPathFactory

@Deprecated
public static final PsdkCustomization.PsdkOption XPathFactory
Deprecated. 
System property "com.genesyslab.platform.commons.xml-xpath-factory".


WebMediaProtocolTargetXmlVersion

public static final PsdkCustomization.PsdkOption WebMediaProtocolTargetXmlVersion
System property "com.genesyslab.platform.WebMedia.target-xml-version".

It may be branched for XML based Web Media protocols. So, possible branches are: "BasicChat", "FlexChat", "Callback", and "Email".


WebMediaProtocolReplaceIllegalUnicodeChars

public static final PsdkCustomization.PsdkOption WebMediaProtocolReplaceIllegalUnicodeChars
System property "com.genesyslab.platform.WebMedia.replace-illegal-unicode-chars".

It may be branched for XML based Web Media protocols. So, possible branches are: "BasicChat", "FlexChat", "Callback", and "Email".


WebMediaProtocolIllegalUnicodeCharsReplacement

public static final PsdkCustomization.PsdkOption WebMediaProtocolIllegalUnicodeCharsReplacement
System property "com.genesyslab.platform.WebMedia.illegal-unicode-chars-replacement".

It may be branched for XML based Web Media protocols. So, possible branches are: "BasicChat", "FlexChat", "Callback", and "Email".


DisableUnknownProtocolMessageDelivery

public static final PsdkCustomization.PsdkOption DisableUnknownProtocolMessageDelivery
Disables "unknown" incoming messages for all or for particular protocol type.

It represents system property "com.genesyslab.platform.disable-unknown-incoming-messages".

This option may be branched for specific protocol(s). Supported branch names are string representations of protocol description structures.
For example:


KVBindingVersion

@Deprecated
public static final PsdkCustomization.PsdkOption KVBindingVersion
Deprecated. 
System property "com.genesyslab.platform.commons.collections.kvbinding.version".


PsdkLoggerFactory

public static final PsdkCustomization.PsdkOption PsdkLoggerFactory
This option allows applications to initialize internal PSDK logging.
"Logger factory" means class name of a factory for logger objects which implements ILoggerFactory interface.

Platform SDK contains six built-in implementations of the factory:

This option also supports several short names ("aliases") for the factories: It also allows users to create and use custom implementations.

It represents system property "com.genesyslab.platform.commons.log.loggerFactory".

See Also:
Log.setLoggerFactory(ILoggerFactory)

PsdkLoggerDebug

public static final PsdkCustomization.PsdkOption PsdkLoggerDebug
This option enables debug mode for the logger factory initialization logic itself. It allows printing of error messages to the System.out in case of errors while logger factory is been created or initialized.

It represents system property "com.genesyslab.platform.commons.log.debug".


PsdkLoggerConsoleLevel

public static final PsdkCustomization.PsdkOption PsdkLoggerConsoleLevel
Log messages level for filtering in the "simple" (console) logger factory.
Possible values are:

It represents system property "com.genesyslab.platform.commons.log.console.level".


PsdkTlsDefaultVersion

public static final PsdkCustomization.PsdkOption PsdkTlsDefaultVersion
PSDK TLS default version.

System property "com.genesyslab.platform.commons.connection.tlsDefaultVersion".

Here are some predefined versions: "tls", "TLSv1", "TLSv1.1", "TLSv1.2"


PsdkLoggerTraceMessages

public static final PsdkCustomization.PsdkOption PsdkLoggerTraceMessages
Enabling option for the Platform SDK Data Logger.

By default Platform SDK 8.5+ does not record to the internal PSDK logs full content of protocol messages.

Setting this option to "true" enables usage of "data logger" ("com.genesyslab.platformmessages.request" and "com.genesyslab.platformmessages.receive"), so, it will be possible to record full messages content.

It represents system property "com.genesyslab.platform.trace-messages".

This option may be branched for specific protocol(s). Supported branch names are string representations of protocol description structures.
For example:


PsdkTimerShutdownDelay

public static final PsdkCustomization.PsdkOption PsdkTimerShutdownDelay
PSDK timer shutdown delay (in milliseconds).

System property "com.genesyslab.platform.commons.timer.shutdownDelay".

The default value is 0 (in PSDK 8.1.4 it was 6000)


StatServerClientCapabilities

public static final PsdkCustomization.PsdkOption StatServerClientCapabilities
Enable sending of client capabilities to stat server.

System property "com.genesyslab.platform.reporting.protocol.statserver.clientCapabilities".

The default value is true


ConnectionExecutorCoreThreadCount

public static final PsdkCustomization.PsdkOption ConnectionExecutorCoreThreadCount
Redefine connection executor core thread count.

System property "com.genesyslab.platform.commons.connection.executor.coreThreadCount".

The default value is 0

Note: It can be useful for Java 1.5 where value 1 can resolve a problem of first pool thread creation while main thread is blocked.


SupportURIWithIncorrectSyntax

public static final PsdkCustomization.PsdkOption SupportURIWithIncorrectSyntax
Support URI with incorrect syntax.

System property "com.genesyslab.platform.commons.protocol.supportURIWithIncorrectSyntax".

The default value is 1

Note: It helps PSDK to create endpoint with host or URI that contains invalid characters according to RFC (underscore character for example). In this case uri.getHost() and uri.getUserInfo() return null and uri.getPort() returns -1 and only uri.toString() can be useful.


LogConnectionTraffic

public static final PsdkCustomization.PsdkOption LogConnectionTraffic
Turn connection content traffic logging on .

System property "com.genesyslab.platform.commons.connection.logTraffic".

There is no default value (i.e. is null).

Supported values: all, in, out.

NOTE: The logging is processed on debug level.


DisableXmlConfData

public static final PsdkCustomization.PsdkOption DisableXmlConfData
Disable using XML based configuration data .

System property "com.genesyslab.platform.configuration.protocol.disableXmlConfData".

The default value is 0.

It avoids implicit using of the attributes and ignore it in serialization.


TransportFactoryImpl

public static final PsdkCustomization.PsdkOption TransportFactoryImpl
Specifies default implementation of ExternalTransportFactory.

System property "com.genesys.platform.protocol.transport.factory".

Default value is null.

Each instance of the the protocol will use a specified external transport by default. If it isn't reassigned in connection configuration.


PsdkSocketAddressResolver

public static final PsdkCustomization.PsdkOption PsdkSocketAddressResolver
Replaces default implementation of connections' Socket Address resolver.

System property "com.genesyslab.platform.commons.connection.socket-address-resolver".

Custom resolver implementation class must implement SocketAddressResolver.


DisableLazyParsing

public static final PsdkCustomization.PsdkOption DisableLazyParsing
Disable lazy parsing for a specified protocol .

System property "com.genesyslab.platform.configuration.protocol.disableLazyParsing".

The default value is 0.

It avoids implicit using of the attributes and ignore it in serialization.

Method Detail

values

public static PsdkCustomization.PsdkOption[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (PsdkCustomization.PsdkOption c : PsdkCustomization.PsdkOption.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static PsdkCustomization.PsdkOption valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

key

public java.lang.String key()
Returns the system properties key name of the Platform SDK Core Customization option.

Returns:
Key name of the property.

isBrancheable

public boolean isBrancheable()
Returns the system properties key name of the Platform SDK Core Customization option.

Returns:
Flag value meaning ability of the option to have branches.

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.