Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol
Interface InteractionServerProtocolHandshakeOptions

All Known Implementing Classes:
InteractionServerProtocol

public interface InteractionServerProtocolHandshakeOptions

Dedicated interface to represent Interaction Server protocol handshake parameters.

See Also:
InteractionServerProtocol

Method Summary
 java.lang.String getClientName()
          Returns the name of a client.
 InteractionClient getClientType()
          Returns the type of a client.
 java.lang.String getMediaType()
          Returns the type of media.
 java.lang.Integer getProxyId()
          Returns the proxy id.
 KeyValueCollection getRegistrationExtensions()
          Returns extended parameters of registration.
 void setClientName(java.lang.String nameOfClient)
          Sets the name of a client.
 void setClientType(InteractionClient typeOfClient)
          Sets the type of a client.
 void setMediaType(java.lang.String value)
          Sets the type of media.
 void setProxyId(java.lang.Integer idOfProxy)
          Sets the id of the proxy.
 void setRegistrationExtensions(KeyValueCollection registrationExt)
          Sets extended parameters of registration.
 

Method Detail

getClientType

InteractionClient getClientType()
Returns the type of a client.

Returns:
type of client
See Also:
setClientType(InteractionClient)

setClientType

void setClientType(InteractionClient typeOfClient)
Sets the type of a client.

Parameters:
typeOfClient - type of client

getClientName

java.lang.String getClientName()
Returns the name of a client.

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

setClientName

void setClientName(java.lang.String nameOfClient)
Sets the name of a client.

Parameters:
nameOfClient - name of client

getMediaType

java.lang.String getMediaType()
Returns the type of media. Used when client type is 'MediaServer'.

Returns:
type of media or null
See Also:
setMediaType(String)

setMediaType

void setMediaType(java.lang.String value)
Sets the type of media. Used when client type is 'MediaServer'.

Parameters:
value - type of media

getProxyId

java.lang.Integer getProxyId()
Returns the proxy id. Used when client type is 'Proxy'. After connection is opened actual proxy id can be obtained from server context.

Returns:
id of the proxy or null
See Also:
setProxyId(Integer), #getServerContext(), InteractionServerContext.getProxyId()

setProxyId

void setProxyId(java.lang.Integer idOfProxy)
Sets the id of the proxy. Used when client type is 'Proxy'. After connection is opened actual proxy id can be obtained from server context.

Parameters:
idOfProxy - id of the proxy

getRegistrationExtensions

KeyValueCollection getRegistrationExtensions()
Returns extended parameters of registration. After connection is opened actual parameters can be obtained from server context.

Returns:
registration extensions
See Also:
setRegistrationExtensions(KeyValueCollection), InteractionServerProtocol.getServerContext(), InteractionServerContext.getRegistrationExtensions()

setRegistrationExtensions

void setRegistrationExtensions(KeyValueCollection registrationExt)
Sets extended parameters of registration. After connection is opened actual parameters can be obtained from server context.

Parameters:
registrationExt - registration extensions
See Also:
getRegistrationExtensions(), InteractionServerProtocol.getServerContext(), InteractionServerContext.getRegistrationExtensions()

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.