lumis.portal.serviceinterfaceinstance.serialization

Interface IServiceInterfaceInstanceSerializationManager

All Superinterfaces:

IConfigPersister

All Known Implementing Classes:

ServiceInterfaceInstanceSerializationManager

public interface IServiceInterfaceInstanceSerializationManager
extends IConfigPersister

Manager Interface for Service Interface Instance serialization

Since:

4.0.7

Version:

$Revision: 21231 $ $Date: 2018-04-24 22:34:27 +0000 (Tue, 24 Apr 2018) $

Method Summary

Modifier and Type	Method and Description
void	deserialize(DeserializationContext deserializationContext, ServiceInterfaceInstanceSerializableConfig serviceInterfaceInstanceSerializableConfig) Deserialize a service interface instance.
void	deserialize(DeserializationContext deserializationContext, ServiceInterfaceInstanceSerializableConfig serviceInterfaceInstanceSerializableConfig, IDirectory directory, String interfaceInstanceInputPath, String customPropertiesInputPath) Deserializes a service interface instance from specific output path.
SerializationMessageConfigNode	getSerializationMessageConfigNode(BaseSerializationContext baseSerializationContext, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig) Get a SerializationMessageConfigNode object containing fully recursive information about a service interface instance.
SerializationMessageConfigNode	getSerializationMessageConfigNode(BaseSerializationContext baseSerializationContext, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, EnumSet<SerializationMessageConfigNode.RecursionStopPoints> recursionStopPoints) Get a SerializationMessageConfigNode object containing partially recursive information about a service interface instance.
ServiceInterfaceInstanceSerializableConfig	serialize(SerializationContext serializationContext, String serviceInterfaceInstanceId) Serialize a service interface instance.
ServiceInterfaceInstanceSerializableConfig	serialize(SerializationContext serializationContext, String serviceInterfaceInstanceId, IDirectory directory, String interfaceInstanceOutputPath, String customPropertiesOutputPath) Serializes a service interface instance to specific output path.
void	setupSerializationContext(BaseSerializationContext serializationContext) Set up a serialization context, defining settings such as class aliases, field aliases, transient fields, omitted collections etc.

Methods inherited from interface lumis.portal.serialization.operation.IConfigPersister

persistConfig

Method Detail

deserialize

void deserialize(DeserializationContext deserializationContext,
                 ServiceInterfaceInstanceSerializableConfig serviceInterfaceInstanceSerializableConfig)
          throws PortalException

Deserialize a service interface instance.

Parameters:

deserializationContext -

serviceInterfaceInstanceSerializableConfig -

Throws:

PortalException

deserialize

void deserialize(DeserializationContext deserializationContext,
                 ServiceInterfaceInstanceSerializableConfig serviceInterfaceInstanceSerializableConfig,
                 IDirectory directory,
                 String interfaceInstanceInputPath,
                 String customPropertiesInputPath)
          throws PortalException

Deserializes a service interface instance from specific output path. This is usually used with orphan interface instances that must be deserialized from custom locations.

Parameters:

deserializationContext - the deserialization context.

serviceInterfaceInstanceId - the service interface instance identifier.

directory - the directory the paths are relative to.

interfaceInstanceInputPath - the path where the service interface instance will be deserialized from, relative to directory.

customPropertiesInputPath - the path where the service interface instance's custom properties (if any) will be deserialized from, relative to directory.

Throws:

PortalException

Since:

10.4.0

serialize

ServiceInterfaceInstanceSerializableConfig serialize(SerializationContext serializationContext,
                                                     String serviceInterfaceInstanceId)
                                              throws PortalException

Serialize a service interface instance.

Parameters:

serializationContext -

serviceInterfaceInstanceId -

Returns:

Throws:

PortalException

serialize

ServiceInterfaceInstanceSerializableConfig serialize(SerializationContext serializationContext,
                                                     String serviceInterfaceInstanceId,
                                                     IDirectory directory,
                                                     String interfaceInstanceOutputPath,
                                                     String customPropertiesOutputPath)
                                              throws PortalException

Serializes a service interface instance to specific output path. This is usually used with orphan interface instances that must be serialized to custom locations. To deserialize the service interface instance, use #deser

Parameters:

serializationContext - the serialization context.

serviceInterfaceInstanceId - the service interface instance identifier.

directory - the directory the paths are relative to.

interfaceInstanceOutputPath - the path where the service interface instance will be serialized to, relative to directory.

customPropertiesOutputPath - the path where the service interface instance's custom properties (if any) will be serialized to, relative to directory.

Returns:

the serializable object of the service interface instance.

Throws:

PortalException

Since:

10.4.0

setupSerializationContext

void setupSerializationContext(BaseSerializationContext serializationContext)

Set up a serialization context, defining settings such as class aliases, field aliases, transient fields, omitted collections etc.

Parameters:

serializationContext -

getSerializationMessageConfigNode

SerializationMessageConfigNode getSerializationMessageConfigNode(BaseSerializationContext baseSerializationContext,
                                                                 ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig)
                                                          throws PortalException

Get a SerializationMessageConfigNode object containing fully recursive information about a service interface instance.

Parameters:

baseSerializationContext -

serviceInterfaceInstanceConfig -

Returns:

Throws:

PortalException

getSerializationMessageConfigNode

SerializationMessageConfigNode getSerializationMessageConfigNode(BaseSerializationContext baseSerializationContext,
                                                                 ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                                                                 EnumSet<SerializationMessageConfigNode.RecursionStopPoints> recursionStopPoints)
                                                          throws PortalException

Get a SerializationMessageConfigNode object containing partially recursive information about a service interface instance.

Parameters:

baseSerializationContext -

serviceInterfaceInstanceConfig -

recursionStopPoints -

Returns:

Throws:

PortalException