Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.protocol
Class AbstractProtocolFactory

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.AbstractProtocolFactory
All Implemented Interfaces:
ProtocolDescriptionSupport, ProtocolFactory
Direct Known Subclasses:
BasicChatProtocolFactory, CallbackProtocolFactory, ChatServerDefaultProtocolFactory, ConfServerAbstractProtocolFactory, ContactServerProtocolFactory, CustomServerProtocolFactory, EmailProtocolFactory, EspEmailProtocolFactory, ExternalServiceProtocolFactory, FlexChatProtocolFactory, InteractionServerProtocolFactory, LocalControlAgentHeartbeatProtocolFactory, LocalControlAgentProtocolFactory, MessageServerProtocolFactory, OutboundServerProtocolFactory, RoutingServerProtocolFactory, SolutionControlServerProtocolFactory, StatServerProtocolFactory, TServerProtocolFactory

public abstract class AbstractProtocolFactory
extends java.lang.Object
implements ProtocolFactory, ProtocolDescriptionSupport


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.genesyslab.platform.commons.protocol.ProtocolFactory
ProtocolFactory.MessageVerificationReason, ProtocolFactory.MessageVerificationSupport
 
Constructor Summary
AbstractProtocolFactory()
           
 
Method Summary
 Message createMessage(int id)
          Creates protocol Message by id.
 java.lang.Class<? extends Message> getMessageClass(java.lang.String messageName)
           
 java.lang.Object getProtocolData()
          Gets some specific data related to given protocol (for internal use only).
 java.lang.String getReferenceAttributeName()
          Gets protocol's reference attribute name.
 void setProtocolData(java.lang.Object value)
          Sets some specific data related to given protocol (for internal use only).
 Message unknownProtocolMessage(int messageId)
          Creates unknown message with a specified message id.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.ProtocolFactory
createMessage, getMessageName, getProtocolDescription, getProtocolVersion
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.ProtocolDescriptionSupport
getProtocolDescription
 

Constructor Detail

AbstractProtocolFactory

public AbstractProtocolFactory()
Method Detail

getProtocolData

public java.lang.Object getProtocolData()
Gets some specific data related to given protocol (for internal use only).

Specified by:
getProtocolData in interface ProtocolFactory
Returns:
protocol data

setProtocolData

public void setProtocolData(java.lang.Object value)
Sets some specific data related to given protocol (for internal use only).

Specified by:
setProtocolData in interface ProtocolFactory
Parameters:
value - protocol data

createMessage

public Message createMessage(int id)
Creates protocol Message by id.

Specified by:
createMessage in interface ProtocolFactory
Parameters:
id - id of the message
Returns:
Message subclass for the specified id
Throws:
java.lang.IllegalArgumentException - if message with such id can't be created

getMessageClass

public java.lang.Class<? extends Message> getMessageClass(java.lang.String messageName)

unknownProtocolMessage

public Message unknownProtocolMessage(int messageId)
Creates unknown message with a specified message id.

Parameters:
messageId -
Returns:
unknown message with a specified message id

getReferenceAttributeName

public java.lang.String getReferenceAttributeName()
Gets protocol's reference attribute name.

Returns:
reference attribute name or null.

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.