Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol
Interface ConfServerProtocolHandshakeOptions

All Known Implementing Classes:
ConfServerProtocol

public interface ConfServerProtocolHandshakeOptions

Dedicated interface to represent Configuration Server protocol handshake parameters.

See Also:
ConfServerProtocol

Method Summary
 int getClientApplicationType()
          Returns type of the client application as defined in CfgAppType enumeration.
 java.lang.String getClientName()
          Returns client applications' name.
 java.lang.String getUserName()
          Returns the name of a user in the Genesys Configuration Layer.
 java.lang.String getUserPassword()
          Deprecated. The getter behaviour has been changed. Now it returns only empty string or null.
 boolean getUseSession()
          Gets session usage flag.
 void setClientApplicationType(int clientType)
          Sets type of the client application as defined in CfgAppType enumeration.
 void setClientName(java.lang.String clientName)
          Sets client applications' name.
 void setUseLocalization(boolean value)
          Sets flag for retrieving and adding the information from data resource repository corresponding to the default localization settings.
If this value is set to true, the handshake procedure will use specific configuration server protocol request to retrieve localization information (RequestReadLocale).
 void setUserName(java.lang.String userName)
          Sets the name of a user in the Genesys Configuration Layer.
 void setUserPassword(java.lang.String userPassword)
          Sets the password of a user in the Genesys Configuration Layer.
 void setUseSession(boolean useSession)
          Sets session usage flag.
 void useChangePasswordRegistration(java.lang.String newUserPassword)
          UseChangePasswordRegistration(String newUserPassword) method is used when the protocol's user is marked for password change in the CME environment.
 boolean useLocalization()
          Returns flag for retrieving and adding the information from data resource repository corresponding to the default localization settings.
If this value is set to true, the handshake procedure will use specific configuration server protocol request to retrieve localization information (RequestReadLocale).
 

Method Detail

getClientApplicationType

int getClientApplicationType()
Returns type of the client application as defined in CfgAppType enumeration.

Returns:
type of the client application
See Also:
CfgAppType, setClientApplicationType(int)

setClientApplicationType

void setClientApplicationType(int clientType)
Sets type of the client application as defined in CfgAppType enumeration.

Parameters:
clientType - integer representation of type of the client application
See Also:
CfgAppType, CfgAppType.ordinal()

getClientName

java.lang.String getClientName()
Returns client applications' name.

Returns:
client application name
See Also:
setClientName(String)

setClientName

void setClientName(java.lang.String clientName)
Sets client applications' name.

Parameters:
clientName - client application name

getUserName

java.lang.String getUserName()
Returns the name of a user in the Genesys Configuration Layer.

Returns:
the name of a user
See Also:
setUserName(String)

setUserName

void setUserName(java.lang.String userName)
Sets the name of a user in the Genesys Configuration Layer.

Parameters:
userName - name of a user

getUserPassword

@Deprecated
java.lang.String getUserPassword()
Deprecated. The getter behaviour has been changed. Now it returns only empty string or null.

Returns the password of a user in the Genesys Configuration Layer.

Returns:
empty string (if the property has been assigned) or null.
See Also:
setUserPassword(String)

setUserPassword

void setUserPassword(java.lang.String userPassword)
Sets the password of a user in the Genesys Configuration Layer.

Parameters:
userPassword - the password of a user

useLocalization

boolean useLocalization()
Returns flag for retrieving and adding the information from data resource repository corresponding to the default localization settings.
If this value is set to true, the handshake procedure will use specific configuration server protocol request to retrieve localization information (RequestReadLocale).

Localization read request will be sent for server default Language ID.
In case of multiple languages configuration, application should handle localization data explicitly using RequestReadLocale/EventLocaleRead.
To read list of configured Language IDs on a configuration server, it is possible to use RequestGetLocaleSets/EventLocaleSets.

Returns:
localization information usage flag
See Also:
setUseLocalization(boolean)

setUseLocalization

void setUseLocalization(boolean value)
Sets flag for retrieving and adding the information from data resource repository corresponding to the default localization settings.
If this value is set to true, the handshake procedure will use specific configuration server protocol request to retrieve localization information (RequestReadLocale).

Localization read request will be sent for server default Language ID.
In case of multiple languages configuration, application should handle localization data explicitly using RequestReadLocale/EventLocaleRead.
To read list of configured Language IDs on a configuration server, it is possible to use RequestGetLocaleSets/EventLocaleSets.

Parameters:
value - localization information usage flag
See Also:
ConfServerProtocol.getServerContext(), ConfServerContext.getMetadata(), CfgDescription.getLocalizedName()

getUseSession

boolean getUseSession()
Gets session usage flag. Session usage is enforced when it is set to true.

Session Usage.

  1. Enforce session usage.
  2. Open protocol.
  3. Check if session is restored. If it is not, register for notifications.

Notification registration is needed only if the protocol opened without session restored, otherwise notification state is restored on the server side.

Please note, that if session is restored the protocol will issue RequestHistoryLog to server. RequestHistoryLog provides all changes that happened after the last time the protocol was closed. Upon receiving the request server sends all changes (event per change) that happened to any object the protocol was registered to receive notifications on whether explicitly (by registering on notifications) or via restoring session. So, be prepared to receive some updates if you use session restoration.

Returns:
true if session is used
See Also:
setUseSession(boolean), ConfServerProtocol.getServerContext(), ConfServerContext.getSessionId(), ConfServerContext.isSessionRestored(), ConfServerContext.getLastUpdateId()

setUseSession

void setUseSession(boolean useSession)
Sets session usage flag. Session usage is enforced when it is set to true.

Parameters:
useSession - whether session is used
See Also:
ConfServerProtocol.getServerContext(), ConfServerContext.getSessionId(), ConfServerContext.isSessionRestored(), ConfServerContext.getLastUpdateId()

useChangePasswordRegistration

void useChangePasswordRegistration(java.lang.String newUserPassword)
UseChangePasswordRegistration(String newUserPassword) method is used when the protocol's user is marked for password change in the CME environment.

When a person/user is marked for password change in the CME environment, calling the DuplexChannel.open() method will throw ChangePasswordException.

When user application get ChangePasswordException, it may use useChangePasswordRegistration(String) method before the channel opening (before calling the DuplexChannel.open() again). The protocol will use a different registration request changing the user password to the new value during the channel opening handshake. If the client/user registration is successful, the UserPassword is changed to the new user password value.

Parameters:
newUserPassword - new password for the user/person
See Also:
ChangePasswordException, DuplexChannel.open()

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.