Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.confserver.requests.security
Class RequestChangePassword

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.configuration.protocol.confserver.requests.security.RequestChangePassword
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestChangePassword
extends Message

Changes password for specified user. Unlike RequestUpdateObject, circumvents permission check on ability to change Person object.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestChangePassword create()
          Creates instance of RequestChangePassword with no parameters set.
static RequestChangePassword create(java.lang.String userName, java.lang.String userPassword, java.lang.String newUserPassword)
          Deprecated. Use create() without arguments and then call needed setters.
abstract  java.lang.String getNewUserPassword()
          The new password of the user in the Genesys Configuration Layer.
abstract  KeyValueCollection getParameters()
          TKVList containing additional parameters (if needed)
abstract  java.lang.Integer getReferenceId()
          Reference ID to connect response to request.
abstract  java.lang.String getUserName()
          The name of a user in the Genesys Configuration Layer.
abstract  java.lang.String getUserPassword()
          The password of a user in the Genesys Configuration Layer.
abstract  void setNewUserPassword(java.lang.String newUserPassword)
          The new password of the user in the Genesys Configuration Layer.
abstract  void setParameters(KeyValueCollection parameters)
          TKVList containing additional parameters (if needed)
abstract  void setReferenceId(int referenceId)
          Reference ID to connect response to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference ID to connect response to request.
abstract  void setUserName(java.lang.String userName)
          The name of a user in the Genesys Configuration Layer.
abstract  void setUserPassword(java.lang.String userPassword)
          The password of a user in the Genesys Configuration Layer.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static RequestChangePassword create()
Creates instance of RequestChangePassword with no parameters set.

Returns:
instance of RequestChangePassword

create

public static RequestChangePassword create(java.lang.String userName,
                                           java.lang.String userPassword,
                                           java.lang.String newUserPassword)
Deprecated. Use create() without arguments and then call needed setters.

Creates instance of RequestChangePassword.

Parameters:
userName - User Name - required only for the applications that are not treated as daemon applications (servers) by Configuration Server
userPassword - User Password - required only for the applications that are not treated as daemon applications (servers) by Configuration Server
newUserPassword - New User Password - required only for the applications that are not treated as daemon applications (servers) by Configuration Server
Returns:
instance of RequestChangePassword

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


getUserName

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


setUserName

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


getUserPassword

public abstract java.lang.String getUserPassword()
The password of a user in the Genesys Configuration Layer. Do not try to read back its value. Method 'get' always returns empty string if any value has been set, otherwise it returns null.


setUserPassword

public abstract void setUserPassword(java.lang.String userPassword)
The password of a user in the Genesys Configuration Layer. Do not try to read back its value. Method 'get' always returns empty string if any value has been set, otherwise it returns null.


getNewUserPassword

public abstract java.lang.String getNewUserPassword()
The new password of the user in the Genesys Configuration Layer. Do not try to read back its value. Method 'get' always returns empty string if any value has been set, otherwise it returns null.


setNewUserPassword

public abstract void setNewUserPassword(java.lang.String newUserPassword)
The new password of the user in the Genesys Configuration Layer. Do not try to read back its value. Method 'get' always returns empty string if any value has been set, otherwise it returns null.


getParameters

public abstract KeyValueCollection getParameters()
TKVList containing additional parameters (if needed)

Returns:
property value

setParameters

public abstract void setParameters(KeyValueCollection parameters)
TKVList containing additional parameters (if needed)

Parameters:
parameters - new value of the property

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.