com.sap.netweaver.bc.serialize

Class ISerializer.DeserializationParameters

java.lang.Object
  com.sap.netweaver.bc.serialize.ISerializer.DeserializationParameters

Enclosing interface:

ISerializer

public static final class ISerializer.DeserializationParameters
extends Object

Constructor Summary

ISerializer.DeserializationParameters(IExternalFileReader reader, RID rid, IResourceContext context, ILogger logger, RIDRequestList ridrequestlist, boolean anonymize, String anonymizedUserId, ISerializer.ImportMode mode, String batchID)
provides all the data needed for this container instance.

Method Summary

Result	deserialize(RID rid, ISerializer serializer) Deprecated. use deserialize(RIDRequest) instead
Result	deserialize(RIDRequest request) see deserialize(RID, ISerializer) and deserialize(RID, RID, ISerializer)
Result	deserialize(RID rid, RID newName, ISerializer serializer) Deprecated.
String	getAnonymizedUserId()
String	getBatchID()
IResourceContext	getContext()
ILogger	getLogger()
ISerializer.ImportMode	getMode()
RID	getRid()
boolean	isAnonymized()
InputStream	retrieveRequest(String name, ISerializer serializer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ISerializer.DeserializationParameters

public ISerializer.DeserializationParameters(IExternalFileReader reader,
                                             RID rid,
                                             IResourceContext context,
                                             ILogger logger,
                                             RIDRequestList ridrequestlist,
                                             boolean anonymize,
                                             String anonymizedUserId,
                                             ISerializer.ImportMode mode,
                                             String batchID)

provides all the data needed for this container instance. There is no way to modify these references at a later time. None of the parameters must be null

Parameters:

reader - allows requesting to read data stored outside the caller's xml

rid - the rid of the resource to be imported

context - the resource context to use. This should be a service user's context

logger - allows to add data into the deserialization log

ridrequestlist - stores rids that need to be deserialized as well

anonymize - flag to define anonymization behavior

anonymizedUserId - ID of the user to use, if it is an anonymized deserialization

mode - defines behavior in case of content conflicts

batchID - If several resources are deserialized in one process, they should all be deserialized using the same batchID.

Method Detail

isAnonymized

public boolean isAnonymized()

getAnonymizedUserId

public String getAnonymizedUserId()

Returns:

the ID to use for all user-related data that is deserialized. This data is coming from the serialized data. It might differ from the data that will be added to serialized data created in this system. Might be null.

getRid

public RID getRid()

getContext

public IResourceContext getContext()

getLogger

public ILogger getLogger()

getMode

public ISerializer.ImportMode getMode()

getBatchID

public String getBatchID()

deserialize

public Result deserialize(RID rid,
                          RID newName,
                          ISerializer serializer)

Deprecated.

requests the deserialization of another IResource. Depending on the implementation of this interface, this call might be done directly or it will be carried out after the deserialization of the current resource has finished. The serializer must have requested the serialization of that resource.

Parameters:

rid - the absolute rid of the resource to deserialize. Must not be null

newName - the new absolute rid of the resource. Must not be null

serializer - the serializer calling, must not be null

Returns:

a new Result instance

deserialize

public Result deserialize(RID rid,
                          ISerializer serializer)

Deprecated. use deserialize(RIDRequest) instead

requests the deserialization of another IResource. Depending on the implementation of this interface, this call might be done directly or it will be carried out after the deserialization of the current resource has finished. The serializer must have requested the serialization of that resource.

Parameters:

rid - the absolute rid of the resource to deserialize. Must not be null

Returns:

a new Result instance

deserialize

public Result deserialize(RIDRequest request)

see deserialize(RID, ISerializer) and deserialize(RID, RID, ISerializer)

Parameters:

request - - must not be null

Returns:

deserialized request as Result object.

retrieveRequest

public InputStream retrieveRequest(String name,
                                   ISerializer serializer)
                            throws SerializationException

Parameters:

name - the name of the external file to retrieve the content from. Must be the same name that has been returned to the caller when it requested that external file with the method getRequest or addRequest of the interface IExternalFileRequester

serializer -

Returns:

retrieved request based on the given name and serializer object.

Throws:

SerializationException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM