com.genesyslab.platform.json.jackson2
Class PSDKCommonModule
java.lang.Object
com.fasterxml.jackson.databind.Module
com.fasterxml.jackson.databind.module.SimpleModule
com.genesyslab.platform.json.jackson2.PSDKCommonModule
- All Implemented Interfaces:
- com.fasterxml.jackson.core.Versioned, java.io.Serializable
- Direct Known Subclasses:
- BasicChatModule, CallbackModule, ConfServerModule, ContactServerModule, CustomServerModule, EmailModule, EspEmailModule, ExternalServiceModule, FlexChatModule, InteractionServerModule, LocalControlAgentModule, MessageServerModule, OpenMediaAttributesModule, OutboundDesktopModule, OutboundServerModule, PreviewInteractionModule, PSDKModule, RoutingServerModule, SolutionControlServerModule, StatServerModule, TServerModule
public abstract class PSDKCommonModule
- extends com.fasterxml.jackson.databind.module.SimpleModule
The base class for all provided Platform SDK Jackson modules.
It defines common aspects of PSDK messages and structures
serialization and deserialization to/from JSON.
- See Also:
- Serialized Form
Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.Module |
com.fasterxml.jackson.databind.Module.SetupContext |
Fields inherited from class com.fasterxml.jackson.databind.module.SimpleModule |
_abstractTypes, _deserializerModifier, _deserializers, _keyDeserializers, _keySerializers, _mixins, _name, _namingStrategy, _serializerModifier, _serializers, _subtypes, _valueInstantiators, _version |
Constructor Summary |
PSDKCommonModule(java.lang.String protocol,
java.lang.String category,
com.fasterxml.jackson.core.Version version)
|
PSDKCommonModule(java.lang.String protocol,
java.lang.String category,
com.fasterxml.jackson.core.Version version,
boolean enabledMessageNameSerialization)
|
Method Summary |
com.genesyslab.platform.commons.protocol.runtime.ProtocolUnknownMessage |
createUnknownMessage(int messageId)
Create protocol unknown message by id. |
java.lang.Class<?> |
getMarkerClass()
Gets protocol messages marker class that can be used to deserialize a message. |
java.lang.Class<? extends Message> |
getMessageClass(java.lang.String name)
Gets protocol message class by name. |
protected static boolean |
isProtocolAvailable(java.lang.String category,
java.lang.String protocol)
|
void |
setupModule(com.fasterxml.jackson.databind.Module.SetupContext context)
|
Methods inherited from class com.fasterxml.jackson.databind.module.SimpleModule |
addAbstractTypeMapping, addDeserializer, addKeyDeserializer, addKeySerializer, addSerializer, addSerializer, addValueInstantiator, getModuleName, registerSubtypes, registerSubtypes, setAbstractTypes, setDeserializerModifier, setDeserializers, setKeyDeserializers, setKeySerializers, setMixInAnnotation, setNamingStrategy, setSerializerModifier, setSerializers, setValueInstantiators, version |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
enabledMessageNameSerialization
protected final boolean enabledMessageNameSerialization
PSDKCommonModule
public PSDKCommonModule(java.lang.String protocol,
java.lang.String category,
com.fasterxml.jackson.core.Version version)
PSDKCommonModule
public PSDKCommonModule(java.lang.String protocol,
java.lang.String category,
com.fasterxml.jackson.core.Version version,
boolean enabledMessageNameSerialization)
setupModule
public void setupModule(com.fasterxml.jackson.databind.Module.SetupContext context)
- Overrides:
setupModule
in class com.fasterxml.jackson.databind.module.SimpleModule
isProtocolAvailable
protected static boolean isProtocolAvailable(java.lang.String category,
java.lang.String protocol)
getMarkerClass
public java.lang.Class<?> getMarkerClass()
- Gets protocol messages marker class that can be used to deserialize a message.
- Returns:
- protocol messages marker class or null if the module's protocol doesn't have it.
getMessageClass
public java.lang.Class<? extends Message> getMessageClass(java.lang.String name)
- Gets protocol message class by name.
- Returns:
- protocol message class or null if the module's protocol doesn't know it.
createUnknownMessage
public com.genesyslab.platform.commons.protocol.runtime.ProtocolUnknownMessage createUnknownMessage(int messageId)
- Create protocol unknown message by id.
- Returns:
- protocol unknown message for a specified message id.
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.