Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.runtime
Class ChatServerDefaultProtocolFactory

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.AbstractProtocolFactory
      extended by com.genesyslab.platform.webmedia.protocol.runtime.ChatServerDefaultProtocolFactory
All Implemented Interfaces:
ProtocolDescriptionSupport, ProtocolFactory, ProtocolFactory.MessageVerificationSupport

public class ChatServerDefaultProtocolFactory
extends AbstractProtocolFactory
implements ProtocolFactory.MessageVerificationSupport

Chat Server default protocol messages factory.
It is internally used by the Chat Server specific ServerChannel.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.genesyslab.platform.commons.protocol.ProtocolFactory
ProtocolFactory.MessageVerificationReason, ProtocolFactory.MessageVerificationSupport
 
Field Summary
static ProtocolDescription PROTOCOL_DESCRIPTION
           
 
Constructor Summary
ChatServerDefaultProtocolFactory()
           
 
Method Summary
 Message createMessage(int id, java.lang.String name)
          Creates Message by id.
 java.lang.String getMessageName(int id)
          Returns message name by its id.
 ProtocolDescription getProtocolDescription()
          Returns protocol description in format <Category>.<Name>
 java.lang.String getProtocolVersion()
          Returns protocol version.
 boolean verifyMessage(ProtocolFactory.MessageVerificationReason reason, Message message)
          Returns true if mesage is verified otherwise false.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.AbstractProtocolFactory
createMessage, getMessageClass, getProtocolData, getReferenceAttributeName, setProtocolData, unknownProtocolMessage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROTOCOL_DESCRIPTION

public static final ProtocolDescription PROTOCOL_DESCRIPTION
Constructor Detail

ChatServerDefaultProtocolFactory

public ChatServerDefaultProtocolFactory()
Method Detail

getProtocolDescription

public ProtocolDescription getProtocolDescription()
Description copied from interface: ProtocolFactory
Returns protocol description in format <Category>.<Name>

Specified by:
getProtocolDescription in interface ProtocolDescriptionSupport
Specified by:
getProtocolDescription in interface ProtocolFactory
Returns:
protocol category and name

getProtocolVersion

public java.lang.String getProtocolVersion()
Description copied from interface: ProtocolFactory
Returns protocol version.

Specified by:
getProtocolVersion in interface ProtocolFactory
Returns:
protocol version

getMessageName

public java.lang.String getMessageName(int id)
Description copied from interface: ProtocolFactory
Returns message name by its id.

Specified by:
getMessageName in interface ProtocolFactory
Parameters:
id - message id
Returns:
message name

createMessage

public Message createMessage(int id,
                             java.lang.String name)
Description copied from interface: ProtocolFactory
Creates Message by id.
NOTE: Classes that implement this interface are usually created automatically by generator. Do not implement this interface unless you know what you're doing.

Specified by:
createMessage in interface ProtocolFactory
Parameters:
id - id of the message
Returns:
Message subclass for the specified id.

verifyMessage

public boolean verifyMessage(ProtocolFactory.MessageVerificationReason reason,
                             Message message)
Description copied from interface: ProtocolFactory.MessageVerificationSupport
Returns true if mesage is verified otherwise false.

Specified by:
verifyMessage in interface ProtocolFactory.MessageVerificationSupport
Parameters:
reason - Reason of verification.
message - Message to be verified.
Returns:
Boolean result of verification.

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.