Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.runtime.codec
Class ConfObjectPack

java.lang.Object
  extended by com.genesyslab.platform.configuration.protocol.runtime.codec.ConfObjectPack
All Implemented Interfaces:
com.genesyslab.platform.commons.protocol.runtime.codec.CustomPackager, com.genesyslab.platform.commons.protocol.runtime.codec.CustomTypeCodec
Direct Known Subclasses:
ConfObjectPackV6, ConfObjectPackV7

public abstract class ConfObjectPack
extends java.lang.Object
implements com.genesyslab.platform.commons.protocol.runtime.codec.CustomPackager

Base class for configuration objects packagers.


Nested Class Summary
static interface ConfObjectPack.CfgMetadataStorage
           
 
Field Summary
protected static java.lang.String ACCOUNT_ID_ATTR_NAME
           
protected static java.lang.String ACCOUNT_ID_ATTR_SID
           
protected static java.lang.String APP_ID_ATTR_NAME
           
protected static java.lang.String APP_ID_ATTR_SID
           
protected static java.lang.String BRIEF
           
protected static java.lang.String CFG_DELTA
           
protected static java.lang.String CONF_ACL
           
protected static java.lang.String CONF_BRIEF_OBJECT_ATTR_NAME
           
protected static java.lang.String CONF_ID
           
protected static java.lang.String CONF_ID_ATTR_NAME
           
protected static java.lang.String CONF_ID_ATTR_SID
           
protected static java.lang.String CONF_OBJ_ATTR_NAME
           
protected static java.lang.String CONF_OBJ_ATTR_SID
           
protected static java.lang.String CONF_OBJECT_ATTR_NAME
           
protected static java.lang.String CONF_OBJECT_DELTA_ATTR_NAME
           
protected static java.lang.String CONF_OBJECTS_ATTR_NAME
           
protected static java.lang.String CONF_SCHEMA
           
protected  java.lang.String confObjectsData
           
protected  java.lang.Integer confObjectsType
           
protected static int DELTA_INDEX
           
protected  Message message
           
protected  CfgMetadata metadata
           
protected static java.lang.String OBJ_TYPE_ATTR_NAME
           
protected static java.lang.String OBJ_TYPE_ATTR_SID
           
protected static java.lang.String PERMISSIONS_ATTR_SID
           
protected static java.lang.String PERMISSIONS_DATA_ATTR_NAME
           
protected static java.lang.String SCHEMA_DATA_ATTR_NAME
           
protected static java.lang.String SCHEMA_INFO_ATTR_SID
           
protected  ConfSerializer serializer
           
 
Constructor Summary
ConfObjectPack()
           
 
Method Summary
 void appendLogValue(java.lang.StringBuffer buf, java.lang.Object customTypeObject, boolean truncate, boolean hideAllowed)
           
 java.lang.Object decodeFromXml(javax.xml.transform.Source attributeElement, com.genesyslab.platform.commons.protocol.runtime.AttributeDescription attributeDescription)
           
 void encodeToXml(java.lang.Object customTypeObject, javax.xml.transform.Result attributeElement)
           
protected  void ensureOutgoingObjectTypeAttr(java.lang.Object customTypeObject, java.lang.String id, MessageTransport transport, java.lang.Object transportState)
          Method is used with serialization of user provided data for sending it to server.
protected  CfgDescriptionClass getClassDescription()
          Method is used for deserialization of data from server.
protected  CfgDescriptionClass getClassDescription(CfgDescriptionClass objType)
          Virtual method is used for substitution of main object class with delta or brief representation where it is required.
protected  CfgDescriptionClass getClassDescription(java.lang.Integer typeId)
          Method is used for serialization and deserialization of data to/from server.
 java.lang.String getLogType()
           
 java.lang.String getNS()
           
 void onAttribute(java.lang.String id, java.lang.Object value)
           
 void onMessageEnd()
           
 void onMessageStart(Message message)
           
 void setMessage(Message message)
           
 void setProtocolData(java.lang.Object protocolData)
           
protected  void setSerializer(ConfSerializer serializer)
           
 
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
encodeForConnection
 

Field Detail

CONF_OBJ_ATTR_SID

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

CONF_OBJ_ATTR_NAME

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

OBJ_TYPE_ATTR_SID

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

OBJ_TYPE_ATTR_NAME

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

CONF_ID_ATTR_SID

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

CONF_ID_ATTR_NAME

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

APP_ID_ATTR_SID

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

APP_ID_ATTR_NAME

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

ACCOUNT_ID_ATTR_SID

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

ACCOUNT_ID_ATTR_NAME

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

PERMISSIONS_ATTR_SID

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

PERMISSIONS_DATA_ATTR_NAME

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

SCHEMA_INFO_ATTR_SID

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

SCHEMA_DATA_ATTR_NAME

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

CONF_OBJECT_ATTR_NAME

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

CONF_OBJECTS_ATTR_NAME

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

CONF_OBJECT_DELTA_ATTR_NAME

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

CONF_BRIEF_OBJECT_ATTR_NAME

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

DELTA_INDEX

protected static final int DELTA_INDEX
See Also:
Constant Field Values

CFG_DELTA

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

BRIEF

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

CONF_ID

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

CONF_ACL

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

CONF_SCHEMA

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

message

protected Message message

confObjectsType

protected java.lang.Integer confObjectsType

confObjectsData

protected java.lang.String confObjectsData

serializer

protected ConfSerializer serializer

metadata

protected CfgMetadata metadata
Constructor Detail

ConfObjectPack

public ConfObjectPack()
Method Detail

setProtocolData

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

setSerializer

protected void setSerializer(ConfSerializer serializer)

setMessage

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

onMessageStart

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

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

getClassDescription

protected CfgDescriptionClass getClassDescription()
                                           throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Method is used for deserialization of data from server.

Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

getClassDescription

protected CfgDescriptionClass getClassDescription(java.lang.Integer typeId)
                                           throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Method is used for serialization and deserialization of data to/from server.

Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

getClassDescription

protected CfgDescriptionClass getClassDescription(CfgDescriptionClass objType)
                                           throws com.genesyslab.platform.commons.protocol.runtime.codec.CodecException
Virtual method is used for substitution of main object class with delta or brief representation where it is required.

Throws:
com.genesyslab.platform.commons.protocol.runtime.codec.CodecException

ensureOutgoingObjectTypeAttr

protected void ensureOutgoingObjectTypeAttr(java.lang.Object customTypeObject,
                                            java.lang.String id,
                                            MessageTransport transport,
                                            java.lang.Object transportState)
                                     throws PlatformException
Method is used with serialization of user provided data for sending it to server.

Throws:
PlatformException

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 hideAllowed)
                    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

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

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.