Platform SDK Java 8.5 API Reference

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

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.RequestAuthenticate
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestAuthenticate
extends Message

Authenticates user's credentials, but does not register it on Configuration Server.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestAuthenticate create()
          Creates instance of RequestAuthenticate with no parameters set.
static RequestAuthenticate create(java.lang.String userName, java.lang.String userPassword)
          Creates instance of RequestAuthenticate.
abstract  java.lang.String getGSSToken()
          A GSS token bytes hex presentation of Kerberos ticket identifies an user.
abstract  java.lang.String getKerberosTicket()
          A Kerberos ticket bytes hex presentation identifies an user.
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 setGSSToken(java.lang.String gSSToken)
          A GSS token bytes hex presentation of Kerberos ticket identifies an user.
abstract  void setKerberosTicket(java.lang.String kerberosTicket)
          A Kerberos ticket bytes hex presentation identifies an user.
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 RequestAuthenticate create()
Creates instance of RequestAuthenticate with no parameters set.

Returns:
instance of RequestAuthenticate

create

public static RequestAuthenticate create(java.lang.String userName,
                                         java.lang.String userPassword)
Creates instance of RequestAuthenticate.

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
Returns:
instance of RequestAuthenticate

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.


getKerberosTicket

public abstract java.lang.String getKerberosTicket()
A Kerberos ticket bytes hex presentation identifies an user.


setKerberosTicket

public abstract void setKerberosTicket(java.lang.String kerberosTicket)
A Kerberos ticket bytes hex presentation identifies an user.


getGSSToken

public abstract java.lang.String getGSSToken()
A GSS token bytes hex presentation of Kerberos ticket identifies an user.


setGSSToken

public abstract void setGSSToken(java.lang.String gSSToken)
A GSS token bytes hex presentation of Kerberos ticket identifies an user.


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.