MetaDataSupport
public class ConfServerModule extends PSDKCommonModule
Example:
// create jackson's JSONizator ObjectMapper mapper = new ObjectMapper(); // register our new PSDK module mapper.registerModule( new ConfServerModule() ); // create PSDK message RequestRegisterClient request = RequestRegisterClient.create(); // request.set ... // serializeAsString message String json = mapper.writeValueAsString(request); // deserialize message RequestRegisterClient msg = mapper.readValue(json, RequestRegisterClient.class);NOTE: the module changes ObjectMapper features when it is registering as shown in commented lines:
ObjectMapper mapper = new ObjectMapper(); mapper.register( new ConfServerModule() ); // mapper.setSerializationInclusion(Include.NON_NULL); // mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false); // mapper.setDateFormat(new ISO8601DateFormatWithMilliseconds());so if you have own vision how it should be configured then configure it after the module will be registered.
enabledMessageNameSerialization
Constructor | Description |
---|---|
ConfServerModule() |
Creates ConfServerModule instance using the latest metadata that PSDK contains.
|
ConfServerModule(boolean enableMessageNameSerialization) |
Creates ConfServerModule instance using a specified metadata version.
|
ConfServerModule(CfgMetadata metadata) |
Creates ConfServerModule instance using a specified metadata version.
|
Modifier and Type | Method | Description |
---|---|---|
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.
|
CfgMetadata |
getMetadata() |
Gets current metadata that must be used to deserialize config server protocol messages to/from JSON .
|
static void |
init(PSDKCommonModule module) |
For internal use only
|
static boolean |
isAvailable() |
Checks if the appropriate protocol jar file is available according to the classpath.
|
static void |
setup(com.fasterxml.jackson.databind.Module.SetupContext context) |
Do not call it directly.
|
void |
setupModule(com.fasterxml.jackson.databind.Module.SetupContext context) |
Do not call it directly.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
isProtocolAvailable
_checkNotNull, addAbstractTypeMapping, addDeserializer, addKeyDeserializer, addKeySerializer, addSerializer, addSerializer, addValueInstantiator, getModuleName, getTypeId, registerSubtypes, registerSubtypes, registerSubtypes, setAbstractTypes, setDeserializerModifier, setDeserializers, setKeyDeserializers, setKeySerializers, setMixInAnnotation, setNamingStrategy, setSerializerModifier, setSerializers, setValueInstantiators, version
public ConfServerModule()
public ConfServerModule(boolean enableMessageNameSerialization)
Example. How to get a config server's metadata.
ConfServerProtocol c = new ConfServerProtocol(endpoint); c.open(); CfgMetaData metadata = ((ConfServerContext)c.connectionContext().serverContext()).getMetadata(); ConfServerModule module = new ConfServerModule(metadata); ObjectMapper mapper = new ObjectMapper(); mapper.registerModule(module);
enableMessageNameSerialization
- flag enables message name serialization
(it is disabled by default).public ConfServerModule(CfgMetadata metadata)
Example. How to get a config server's metadata.
ConfServerProtocol c = new ConfServerProtocol(endpoint); c.open(); CfgMetaData metadata = ((ConfServerContext)c.connectionContext().serverContext()).getMetadata(); ConfServerModule module = new ConfServerModule(metadata); ObjectMapper mapper = new ObjectMapper(); mapper.registerModule(module);
metadata
- defines a version which will be used to deserialize ConfServer protocol messages from JSON.
If it's null then the latest metadata, that PSDK contains, will be used.public void setupModule(com.fasterxml.jackson.databind.Module.SetupContext context)
setupModule
in class PSDKCommonModule
public static void init(PSDKCommonModule module)
public static void setup(com.fasterxml.jackson.databind.Module.SetupContext context)
public static boolean isAvailable()
public java.lang.Class<?> getMarkerClass()
getMarkerClass
in class PSDKCommonModule
public java.lang.Class<? extends Message> getMessageClass(java.lang.String name)
getMessageClass
in class PSDKCommonModule
public ProtocolUnknownMessage createUnknownMessage(int messageId)
createUnknownMessage
in class PSDKCommonModule
public final CfgMetadata getMetadata()
MetaDataSupport
getMetadata
in interface MetaDataSupport
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.