|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfServerProtocolHandshakeOptions
Dedicated interface to represent Configuration Server protocol handshake parameters.
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 |
---|
int getClientApplicationType()
CfgAppType
enumeration.
CfgAppType
,
setClientApplicationType(int)
void setClientApplicationType(int clientType)
CfgAppType
enumeration.
clientType
- integer representation of type of the client applicationCfgAppType
,
CfgAppType.ordinal()
java.lang.String getClientName()
setClientName(String)
void setClientName(java.lang.String clientName)
clientName
- client application namejava.lang.String getUserName()
setUserName(String)
void setUserName(java.lang.String userName)
userName
- name of a user@Deprecated java.lang.String getUserPassword()
setUserPassword(String)
void setUserPassword(java.lang.String userPassword)
userPassword
- the password of a userboolean useLocalization()
RequestReadLocale
).
Localization read request will be sent for server default Language ID.RequestReadLocale
/EventLocaleRead
.RequestGetLocaleSets
/EventLocaleSets
.
setUseLocalization(boolean)
void setUseLocalization(boolean value)
RequestReadLocale
).
Localization read request will be sent for server default Language ID.RequestReadLocale
/EventLocaleRead
.RequestGetLocaleSets
/EventLocaleSets
.
value
- localization information usage flagConfServerProtocol.getServerContext()
,
ConfServerContext.getMetadata()
,
CfgDescription.getLocalizedName()
boolean getUseSession()
setUseSession(boolean)
,
ConfServerProtocol.getServerContext()
,
ConfServerContext.getSessionId()
,
ConfServerContext.isSessionRestored()
,
ConfServerContext.getLastUpdateId()
void setUseSession(boolean useSession)
useSession
- whether session is usedConfServerProtocol.getServerContext()
,
ConfServerContext.getSessionId()
,
ConfServerContext.isSessionRestored()
,
ConfServerContext.getLastUpdateId()
void useChangePasswordRegistration(java.lang.String newUserPassword)
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.
newUserPassword
- new password for the user/personChangePasswordException
,
DuplexChannel.open()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |