Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.runtime.codec
Class XmlComplexTypeListCodec

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.runtime.codec.NoDataCodec
      extended by com.genesyslab.platform.webmedia.protocol.runtime.codec.XmlComplexTypeListCodec
All Implemented Interfaces:
com.genesyslab.platform.commons.connection.impl.xml.XmlStructureHandler, ConfigurationSupport, com.genesyslab.platform.commons.protocol.runtime.codec.CustomPackager, com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec
Direct Known Subclasses:
BasicChatEventListCodec, EventInfoListCodec, SearchResultCodec

public abstract class XmlComplexTypeListCodec
extends com.genesyslab.platform.commons.protocol.runtime.codec.NoDataCodec
implements com.genesyslab.platform.commons.connection.impl.xml.XmlStructureHandler, com.genesyslab.platform.commons.protocol.runtime.codec.CustomPackager, ConfigurationSupport


Constructor Summary
XmlComplexTypeListCodec()
           
 
Method Summary
protected  void append(java.lang.Object state, java.lang.String propertyName, com.genesyslab.platform.commons.protocol.runtime.CompoundValue complex)
           
 void appendLogValue(java.lang.StringBuffer buf, java.lang.Object customTypeObject, boolean truncate, boolean hide)
           
 void configure(ConnectionConfiguration config)
           
protected abstract  com.genesyslab.platform.commons.protocol.runtime.CompoundValue createCompoundValue(java.lang.Object state, java.lang.String attributeId)
           
protected  java.lang.String createElement(com.genesyslab.platform.commons.protocol.runtime.DataSupport data, com.genesyslab.platform.commons.connection.impl.xml.XmlMessage xmlMessage, com.genesyslab.platform.commons.protocol.runtime.AttributeDescription info)
           
protected abstract  java.util.List createList(java.lang.Object state, java.lang.String attributeId)
           
 java.lang.Object decodeFromXml(javax.xml.transform.Source attributeElement, com.genesyslab.platform.commons.protocol.runtime.AttributeDescription attributeDescription)
           
 java.lang.Object encodeForConnection(java.lang.Object customTypeObject, java.lang.String id, MessageTransport transport, java.lang.Object transportState)
           
 void encodeToXml(java.lang.Object customTypeObject, javax.xml.transform.Result attributeElement)
           
 ConnectionConfiguration getConfiguration()
           
protected  java.util.List getList(java.lang.Object state, java.lang.String propertyName)
           
 boolean needsProcessing(java.lang.Object state, java.lang.String attributeId, org.w3c.dom.Element complexElement)
           
 void onAttribute(java.lang.String id, java.lang.Object value)
           
 java.lang.Object onComplexAttribute(java.lang.Object state, java.lang.String attributeId, org.w3c.dom.Element complexElement)
           
 java.lang.Object onComplexEnd(java.lang.Object state, java.lang.String attributeId)
           
 void onMessageEnd()
           
 void onMessageStart(Message message)
           
 void setMessage(Message message)
           
 void setProtocolData(java.lang.Object protocolData)
           
protected abstract  java.lang.String translateAttributeId(java.lang.String attributeId)
           
 
Methods inherited from class com.genesyslab.platform.commons.protocol.runtime.codec.NoDataCodec
getNS
 
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.runtime.codec.CustomTypeCodec
getLogType, getNS
 

Constructor Detail

XmlComplexTypeListCodec

public XmlComplexTypeListCodec()
Method Detail

setProtocolData

public void setProtocolData(java.lang.Object protocolData)
Specified by:
setProtocolData in interface com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec
Overrides:
setProtocolData in class com.genesyslab.platform.commons.protocol.runtime.codec.NoDataCodec

setMessage

public void setMessage(Message message)
Specified by:
setMessage in interface com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec
Overrides:
setMessage in class com.genesyslab.platform.commons.protocol.runtime.codec.NoDataCodec

encodeForConnection

public java.lang.Object encodeForConnection(java.lang.Object customTypeObject,
                                            java.lang.String id,
                                            MessageTransport transport,
                                            java.lang.Object transportState)
                                     throws PlatformException
Specified by:
encodeForConnection in interface com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec
Throws:
PlatformException

createElement

protected java.lang.String createElement(com.genesyslab.platform.commons.protocol.runtime.DataSupport data,
                                         com.genesyslab.platform.commons.connection.impl.xml.XmlMessage xmlMessage,
                                         com.genesyslab.platform.commons.protocol.runtime.AttributeDescription info)

decodeFromXml

public java.lang.Object decodeFromXml(javax.xml.transform.Source attributeElement,
                                      com.genesyslab.platform.commons.protocol.runtime.AttributeDescription attributeDescription)
                               throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Specified by:
decodeFromXml in interface com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec
Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

encodeToXml

public void encodeToXml(java.lang.Object customTypeObject,
                        javax.xml.transform.Result attributeElement)
                 throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Specified by:
encodeToXml in interface com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec
Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

appendLogValue

public void appendLogValue(java.lang.StringBuffer buf,
                           java.lang.Object customTypeObject,
                           boolean truncate,
                           boolean hide)
                    throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Specified by:
appendLogValue in interface com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec
Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

onComplexAttribute

public java.lang.Object onComplexAttribute(java.lang.Object state,
                                           java.lang.String attributeId,
                                           org.w3c.dom.Element complexElement)
                                    throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Specified by:
onComplexAttribute in interface com.genesyslab.platform.commons.connection.impl.xml.XmlStructureHandler
Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

needsProcessing

public boolean needsProcessing(java.lang.Object state,
                               java.lang.String attributeId,
                               org.w3c.dom.Element complexElement)
Specified by:
needsProcessing in interface com.genesyslab.platform.commons.connection.impl.xml.XmlStructureHandler

onComplexEnd

public java.lang.Object onComplexEnd(java.lang.Object state,
                                     java.lang.String attributeId)
Specified by:
onComplexEnd in interface com.genesyslab.platform.commons.connection.impl.xml.XmlStructureHandler

onAttribute

public void onAttribute(java.lang.String id,
                        java.lang.Object value)
                 throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Specified by:
onAttribute in interface com.genesyslab.platform.commons.protocol.runtime.codec.CustomPackager
Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

onMessageEnd

public void onMessageEnd()
                  throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Specified by:
onMessageEnd in interface com.genesyslab.platform.commons.protocol.runtime.codec.CustomPackager
Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

onMessageStart

public void onMessageStart(Message message)
Specified by:
onMessageStart in interface com.genesyslab.platform.commons.protocol.runtime.codec.CustomPackager

createCompoundValue

protected abstract com.genesyslab.platform.commons.protocol.runtime.CompoundValue createCompoundValue(java.lang.Object state,
                                                                                                      java.lang.String attributeId)
                                                                                               throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

translateAttributeId

protected abstract java.lang.String translateAttributeId(java.lang.String attributeId)

createList

protected abstract java.util.List createList(java.lang.Object state,
                                             java.lang.String attributeId)

append

protected void append(java.lang.Object state,
                      java.lang.String propertyName,
                      com.genesyslab.platform.commons.protocol.runtime.CompoundValue complex)

getList

protected java.util.List getList(java.lang.Object state,
                                 java.lang.String propertyName)

getConfiguration

public ConnectionConfiguration getConfiguration()
Specified by:
getConfiguration in interface ConfigurationSupport

configure

public void configure(ConnectionConfiguration config)
Specified by:
configure in interface ConfigurationSupport

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.