Platform SDK Java 8.5 API Reference

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

java.lang.Object
  extended by com.genesyslab.platform.webmedia.protocol.runtime.codec.XmlKeyValueCodec
All Implemented Interfaces:
com.genesyslab.platform.commons.connection.impl.EncodingSupport, com.genesyslab.platform.commons.connection.impl.xml.XmlStructureHandler, ConfigurationSupport, com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec
Direct Known Subclasses:
MailPropertiesCodec

public class XmlKeyValueCodec
extends java.lang.Object
implements com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec, com.genesyslab.platform.commons.connection.impl.xml.XmlStructureHandler, ConfigurationSupport, com.genesyslab.platform.commons.connection.impl.EncodingSupport


Field Summary
protected static java.lang.String VALUE_TYPE_BINARY
           
protected static java.lang.String VALUE_TYPE_INT
           
protected static java.lang.String VALUE_TYPE_KVLIST
           
protected static java.lang.String VALUE_TYPE_UTF
           
 
Fields inherited from interface com.genesyslab.platform.commons.connection.impl.EncodingSupport
DEFAULT_CHARSET, DEFAULT_ENCODING, UTF8_CHARSET, UTF8_ENCODING
 
Constructor Summary
XmlKeyValueCodec()
           
 
Method Summary
 void appendLogValue(java.lang.StringBuffer buf, java.lang.Object customTypeObject, boolean truncate, boolean hide)
           
 void configure(ConnectionConfiguration config)
           
 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)
           
protected  java.lang.Object getComplexAttributeValue()
           
 ConnectionConfiguration getConfiguration()
           
protected  java.lang.String getKeyText(int depth)
           
 KeyValueCollection getList()
           
 java.lang.String getLogType()
           
protected  java.lang.String getNodeName(int depth, java.lang.String key, java.lang.Object value)
           
 java.lang.String getNS()
           
protected  java.lang.String getTypeText(int depth)
           
 boolean needsProcessing(java.lang.Object state, java.lang.String attributeId, org.w3c.dom.Element complexElement)
           
 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)
           
protected  void setAdditionalAttributes(MessageTransport transport, java.lang.Object transportState, java.lang.String key, int depth)
           
 void setMessage(Message message)
           
 void setProtocolData(java.lang.Object protocolData)
           
 void setStringAttributesEncoding(java.lang.String stringAttributesEncoding)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VALUE_TYPE_INT

protected static final java.lang.String VALUE_TYPE_INT
See Also:
Constant Field Values

VALUE_TYPE_UTF

protected static final java.lang.String VALUE_TYPE_UTF
See Also:
Constant Field Values

VALUE_TYPE_BINARY

protected static final java.lang.String VALUE_TYPE_BINARY
See Also:
Constant Field Values

VALUE_TYPE_KVLIST

protected static final java.lang.String VALUE_TYPE_KVLIST
See Also:
Constant Field Values
Constructor Detail

XmlKeyValueCodec

public XmlKeyValueCodec()
Method Detail

setStringAttributesEncoding

public void setStringAttributesEncoding(java.lang.String stringAttributesEncoding)
Specified by:
setStringAttributesEncoding in interface com.genesyslab.platform.commons.connection.impl.EncodingSupport

getConfiguration

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

configure

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

setProtocolData

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

setMessage

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

getKeyText

protected java.lang.String getKeyText(int depth)

getTypeText

protected java.lang.String getTypeText(int depth)

getNodeName

protected java.lang.String getNodeName(int depth,
                                       java.lang.String key,
                                       java.lang.Object value)

setAdditionalAttributes

protected void setAdditionalAttributes(MessageTransport transport,
                                       java.lang.Object transportState,
                                       java.lang.String key,
                                       int depth)
                                throws PlatformException
Throws:
PlatformException

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

getNS

public java.lang.String getNS()
Specified by:
getNS in interface com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec

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

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

getLogType

public java.lang.String getLogType()
Specified by:
getLogType in interface com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec

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

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

onComplexAttribute

public java.lang.Object onComplexAttribute(java.lang.Object state,
                                           java.lang.String attributeId,
                                           org.w3c.dom.Element complexElement)
Specified by:
onComplexAttribute 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

getComplexAttributeValue

protected java.lang.Object getComplexAttributeValue()

getList

public KeyValueCollection getList()

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.