Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol
Interface MessageServerProtocolHandshakeOptions

All Known Implementing Classes:
MessageServerProtocol

public interface MessageServerProtocolHandshakeOptions

Dedicated interface to represent Message Server protocol handshake parameters.

See Also:
MessageServerProtocol

Method Summary
 java.lang.String getClientHost()
          Returns client host.
 int getClientId()
          Gets identification number of log records' source.
By design it is DBID of client CME application.
 java.lang.String getClientName()
          Returns the Message Server client name for connection handshake procedure.
 int getClientType()
          Returns type of application to be used in the logs.
 void setClientHost(java.lang.String host)
          Sets client host to pass to server.
This value will be automatically attached to LogMessage before sending if message does not declare own value.
 void setClientId(java.lang.Integer clientId)
          Sets identification number of log records' source.
By design it is DBID of client CME application.
This value will be automatically attached to all LogMessages before sending if it is not null.
 void setClientName(java.lang.String clientName)
          Sets the Message Server client name for connection handshake procedure.
 void setClientType(int clientType)
          Sets type of application to be used in the logs.
 

Method Detail

getClientId

int getClientId()
Gets identification number of log records' source.
By design it is DBID of client CME application.

Returns:
ClientId or 0 if it is not set

setClientId

void setClientId(java.lang.Integer clientId)
Sets identification number of log records' source.
By design it is DBID of client CME application.
This value will be automatically attached to all LogMessages before sending if it is not null.

Parameters:
clientId - client identification number

getClientName

java.lang.String getClientName()
Returns the Message Server client name for connection handshake procedure. Usually it represents client application name.

Returns:
client name
See Also:
setClientName(String)

setClientName

void setClientName(java.lang.String clientName)
Sets the Message Server client name for connection handshake procedure. Usually it represents client application name.

Parameters:
clientName - client name

getClientType

int getClientType()
Returns type of application to be used in the logs.

Returns:
application type
See Also:
setClientType(int)

setClientType

void setClientType(int clientType)
Sets type of application to be used in the logs.

Parameters:
clientType - application type

getClientHost

java.lang.String getClientHost()
Returns client host.

Returns:
client host
See Also:
setClientHost(String), RequestLogMessage.setClientHost(String)

setClientHost

void setClientHost(java.lang.String host)
Sets client host to pass to server.
This value will be automatically attached to LogMessage before sending if message does not declare own value.

Parameters:
host - client host
See Also:
RequestLogMessage.setClientHost(String)

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.