Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.espemail
Class EspEmailProtocolFactory

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

public class EspEmailProtocolFactory
extends AbstractProtocolFactory

EspEmail protocol specific messages factory.
It is internally used by the EspEmail protocol for messages transportation.

It also may be used for user XML serializer creation:

 XmlMessageSerializer serializer = new XmlMessageSerializer(new EspEmailProtocolFactory());

 // save message to file:
 serializer.serialize(msg, new StreamResult(new FileWriter(filename)));

 // restore message from file:
 msg = serializer.deserialize(new StreamSource(new FileReader(filename)));
 

See Also:
XmlMessageSerializer

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
EspEmailProtocolFactory()
           
 
Method Summary
 Message createMessage(int id, java.lang.String name)
          Creates Message by id.
 java.lang.Class<? extends Message> getMessageClass(java.lang.String messageName)
           
 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.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.AbstractProtocolFactory
createMessage, 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

EspEmailProtocolFactory

public EspEmailProtocolFactory()
Method Detail

getProtocolDescription

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

Returns:
protocol category and name

getProtocolVersion

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

Returns:
protocol version

getMessageClass

public java.lang.Class<? extends Message> getMessageClass(java.lang.String messageName)
Overrides:
getMessageClass in class AbstractProtocolFactory

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.

Parameters:
id - id of the message
Returns:
Message subclass for the specified id.

getMessageName

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

Parameters:
id - message id
Returns:
message name

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.